Enonic AI Agents Skills Enonic CLI

Critical Rules

1. Always use -f (force) flag. Every enonic command that accepts -f must include it. This prevents interactive prompts that block automation. The only exception is enonic cloud login (browser-based OAuth).

2. Local vs remote commands:

   • Local commands run against files on disk — no auth needed: project *, sandbox *, create, dev, latest, upgrade, uninstall.
   • Remote commands talk to a running XP instance via management API — auth required: snapshot *, dump *, export, import, app *, repo *, cms *, auditlog *, vacuum.
   • system info uses the info port (2609) — no auth.
   • project install is a local build + remote install hybrid — auth required.

3. Management port is 4848, not 8080. The CLI talks to the management API on port 4848. Port 8080 is the web/content API. Never use 8080 for CLI remote operations.

4. .enonic file — project create writes a .enonic file in the project root linking it to a sandbox. Commands like project deploy and dev use this automatically.

5. Command aliases:

   • enonic create = simplified enonic project create
   • enonic dev = enonic project dev
   • sandbox ls = sandbox list
   • dump ls = dump list
   • snapshot ls = snapshot list
   • repo ls = repo list

Command Syntax

enonic <group> <action> [positional-args] [flags]

Groups: project, sandbox, snapshot, dump, app, repo, cms, system, auditlog, cloud. Standalone: create, dev, export, import, vacuum, latest, upgrade, uninstall.

Auth Flags (Remote Commands)

Priority: flags → environment variables → no auth. See references/auth-and-env.md for details.

Environment Variables

Project Commands

All run from the project root directory.

enonic create [name] is a shorthand for project create with sensible defaults. enonic dev starts hot-reload mode (sandbox detached, watches source files, exit with Ctrl-C).

Sandbox Commands

Only one sandbox can run at a time. Default start mode is development.

Data Commands

Export / Import

enonic export -t <name> --path <repo:branch:path> -f
enonic import -t <name> --path <repo:branch:path> -f

Path format: repo:branch:path — e.g. cms-repo:draft:/content/my-site

Snapshots

All snapshot commands require auth.

Dumps

All dump commands require auth. Dumps are stored in $XP_HOME/data/dump/.

Warning: dump load replaces all existing repositories. Always create a backup first.

Server Commands

App

Repository

CMS

Typically used after content migration. Path format is branch:path (no repo prefix).

System

Audit Log

Vacuum

enonic vacuum [-b] [-t <ISO-8601-duration>] -f

Purges node versions older than threshold (default P21D = 21 days). -b also removes unused binary blobs. Incompatible with snapshots older than the threshold.

Cloud Commands

Cloud login is the only interactive command. It opens a browser for OAuth. Cannot be automated.

CLI Maintenance

File Locations

Common Patterns

# Create project with specific starter and sandbox
enonic project create my-app -r starter-vanilla -s my-sandbox -f

# Build and install to remote server
ENONIC_CLI_REMOTE_URL="server:4848" enonic project install -a su:password -f

# Export content tree
enonic export -t site-backup --path cms-repo:draft:/content/my-site -a su:password -f

# Full backup with dump
enonic dump create -d nightly --skip-versions -a su:password -f

# Reindex repository after schema changes
enonic repo reindex -r cms-repo -b draft,master -i -a su:password -f

# Vacuum + audit log cleanup (maintenance)
enonic vacuum -b -t P30D -a su:password -f
enonic auditlog cleanup --age P90D -a su:password -f

Reference Files

Converted and distributed by TomeVault — claim your Tome and manage your conversions.