Setting up the development environment

Contents

Installing the CLI and creating a development sandbox.

Install CLI

The Enonic Command Line Interface is an essential tool for developers working with Enonic.

If you have npm on your device, run this command:

npm install -g @enonic/cli

To verify that the CLI has been installed, run enonic -v. This should output the version of your installed CLI.

To see all available options, simply run enonic.

To upgrade, use enonic latest. If there are new versions you will see instructions on how to upgrade.

Create a sandbox

A sandbox is a local development instance of the platform - Enonic XP. Create a sandbox called mysandbox by running this command in your terminal:

enonic sandbox create mysandbox -t essentials -f
-f flag will force using the most recent release of Enonic XP.

Start the sandbox with this command:

enonic sandbox start mysandbox --dev
Dev mode optimizes the development process.
Booting the sandbox in the terminal

Sandbox Admin

Let’s have a look at the Sandbox' web interface - aka XP admin. Open http://localhost:8080 in your browser (or just click the link).

You should now see the XP boot page:

The XP boot page
Figure 1. XP Boot page

The boot page provides an overview of the sandbox, including installed application, as well as the standard configuration files.

Click Log In as Guest to open the XP admin dashboard. You should now see something like this:

The XP admin dashboard
Figure 2. The XP admin dashboard

You are now on the admin dashboard. The right hand menu (aka XP menu) enables navigation between admin tools. Admin tools may be injected as extensions via applications.

If things don’t look exactly the same, don’t worry. In every new version of XP the background picture gets updated. Also, admin dashboard is automatically localized - based on your browsers preferred language.

Coming up

You’re now familiar with the CLI and sandboxes. In the next chapter you’ll get create an Enonic application.


Contents

Contents