The official development and management CLI tool for Enonic XP.
Enonic offers an API-first content platform featuring structured content, powerful search, tree structures, preview and visual page composing. The platform uses a flexible schema system to support content type and components, combined with rich JavaScript and GraphQL APIs. Use your favorite front-end framework or build directly on the platform using the Enonic JS framework.
Install Enonic CLI with the following command:
npm install @enonic/cli -g- Get the list of available commands:
$ enonic- Create and start a new empty sandbox (local instance of Enonic XP) called
mysandboxusing the latest stable release of Enonic XP:
$ enonic sandbox create mysandbox --skip-template -f- Create and start a new sandbox called
mysandboxwith the bare minimum of pre-installed applications using the latest stable release of Enonic XP:
$ enonic sandbox create mysandbox -t essentials -f- Create a new project called
myprojectand link it to themysandboxinstance:
$ enonic create com.example.myproject -s mysandboxCOMMANDS:
app [command] [options] Install, stop and start applications
auditlog [command] [options] Manage audit log repository
cms [command] [options] CMS commands
create <project name> [options] Create a new Enonic project
dev Start current project in dev mode
dump [command] [options] Dump and load complete repositories
export [options] Export data from a given repository
import [options] Import data from a named export
latest Check for latest version of Enonic CLI
repo [command] [options] Tune and manage repositories
snapshot [command] [options] Create and restore snapshots
system [command] [options] System commands
upgrade Upgrade to the latest version
uninstall Uninstall Enonic CLI
vacuum [options] Removes old version history and segments from content storage
help, h Shows a list of all commands or help for a specific command
CLOUD COMMANDS:
cloud [command] [options] Manage Enonic cloud
PROJECT COMMANDS:
project [command] [options] Manage Enonic projects
sandbox [command] [options] Manage Enonic instances
GLOBAL OPTIONS:
--help, -h Show help
--version, -v Print the version
For complete guide to Enonic CLI please check out this page.
Build your first Enonic project by following this hands-on introduction.
Need a quick advice? Ask us on Slack or Discuss.
Prefer Docker? Check out Enonic XP in the Docker Hub.
Test Enonic XP in a forever-free Cloud instance? Sign up for a Cloud Free Plan.
$ enonic upgrade$ enonic uninstall