Release notes
Contents
CLI v4.0.0
Features
-
Compatibility with Enonic XP 8 for
dump create,dump load,snapshot createandsnapshot restore. These commands now use the new task-based APIs introduced in XP 8 and track progress via the returnedtaskId. -
New
--compatflag for the four commands above, taking a version value in the formXorX.Y(e.g.7or7.16). Use it to opt back into the legacy XP 7 API format when talking to an XP 7 server. -
Docker image support for sandboxes.
sandbox createandsandbox upgradeaccept a new--image(-i) flag (e.g.enonic/xp:latest-sdk) to back a sandbox with a Docker image instead of a downloaded XP distribution. Whendockeris available on$PATH, the interactive create wizard offers Docker as an alternative source.
Improvements
-
snapshot restoreselection list now shows the snapshot timestamp next to each name. -
project createshows clearer guidance for the custom repository prompt (now includes amycompany/myrepohint). -
dump loadandsnapshot restorenow print a clear instruction to restart all running XP instances after the operation completes. -
project createhandles cloning from an empty remote Git repository gracefully instead of erroring out.
Bug fixes
-
Fix
dump upgradeappending a second.zipextension when the dump name selected from the list already ended in.zip. -
Fix
enonic project sandboxlinking issue where named sandboxes were not found because the lookup was not filtered byMinDistroVersion. -
Fix incorrect prompt message shown by the
snapshot deletecommand.
CLI v3.3.0
Features
-
Support mTLS.
CLI v3.2.0
Features
-
Support service account keys in operations that require authentication.
Improvements
-
Execute
SnapshotsVacuumTaskwhen runningvacuumcommand
CLI v3.1.3
Bug fixes
-
Fix location of the Brew tap formula
CLI v3.1.2
Bug fixes
-
Fix SHA256 mismatch for the Brew tap
CLI v3.1.1
Bug fixes
-
Don’t create an empty config file when selecting "Clean/Empty" template for a new sandbox
CLI v3.1
Improvements
-
Support
--skip-startoption forsandbox create,project createandproject deploycommands
CLI v3.0
Features
-
sandbox startstarts sandbox in dev mode by default -
project testcommand to executegradle testtask for a project -
sandbox copycommand for copying an existing sandbox -
thresholdoption for thevacuumcommand for specifying age of data to be removed -
cleanoption for thesnapshot restorecommand to delete indices before restoring
Improvements
-
Suggest starting a new sandbox after it’s created
-
Support short
-sflag for specifying a sandbox for project commands -
sandbox upgradecommand will no longer ask which sandbox to upgrade when executed from inside a project’s folder -
project sandboxcommand now outputs current project’s sandbox
Bug fixes
-
Removed unsupported options for
upgradeanduninstallcommands
Upgrade notes
-
In CLI 4.x,
dump create,dump load,snapshot createandsnapshot restoretarget the Enonic XP 8 task-based APIs by default. When running these commands against an XP 7 server, pass--compat 7(or any value starting with7, e.g.--compat 7.16) to fall back to the legacy XP 7 request/response format. -
vacuumno longer runsSnapshotsVacuumTask(the task was removed in XP 8). Usesnapshot deleteto clean up snapshots instead. -
In CLI 3.x, the
sandbox startcommand will start the sandbox in dev mode by default. If you want to start the sandbox in prod mode, provide the--prodoption. -
All the commands that may potentially create a new sandbox (f.ex.
sandbox createorproject create) will now suggest starting the new sandbox after it’s created. If such a command is used in combination with-f(--force) option, the sandbox will be started without prompt. This may potentially affect some scripts if the command is followed by another command which now won’t be reached because script execution will be taken over by the running sandbox.