Nuxeo CLI is a command-line interface for helping developers around Nuxeo ecosystem. It provides project bootstrapping, bundles hot reload,...
Nuxeo CLI includes several commands for working with your Nuxeo Project
Install via NPM:
npm install -g nuxeo-cli
nuxeo executable should be available; ensure you can run:
nuxeo <command> [options] [args]
-h, --help Print Nuxeo CLI version [boolean]-v, --version Show version [boolean]-n Quiet - Hide welcome message [boolean]
nuxeo sync [--src "<src_folder>"] [--dest "<dest_folder"]
One-way Synchronization files (
src folder to
dest folder), then watch any changes occured in a child from the
source folder to repercute it to the
If you start this command inside a nuxeo-cli bootstrap project that has been registered for hotreload (
nuxeo hotreload configure), the destination path is computed to the registered distribution.
--dest Destination Folder [string] [default:"/Users/foo/nuxeo-server-tomcat-9.3-SNAPSHOT/nxserver/nuxeo.war"]
If you start command inside a Studio Project clone, the source path is computed to
--src Source Folder [default: "./studio/resources/nuxeo.war"]
You can watch several source folders:
nuxeo sync --src "<src1_folder>" --src "<src2_folder>" --src "<src3_folder>" --dest "<dest_folder"
You can fine tune which files are tracked, by overriding the
nuxeo sync --pattern "*.js"
Options:-h, --help Show help [boolean]-v, --version Show version [boolean]-n Quiet - Hide welcome message [boolean]--src Source Folder [default: "/tmp/watcher/src"]--dest Destination Folder [string] [default: "/tmp/watcher/dest"]--pattern Glob matching pattern for synchronizable files[default: "*.+(js|html|jpg|gif|svg|png|json|jsp)"]
generator-nuxeo module to gets latest changes without updating
nuxeo bootstrap [<generator>..] [options]
nuxeo hotreload [hotreload|configure] [options]
nuxeo studio [link|unlink] [options]
Link or Unlink your project to your Studio project to package it easily and be able to test ev erything together.
Lots of Nuxeo CLI logic is held in generator-nuxeo project. You must link both projects to be able to have live modifications.
npm install -g nuxeo/nuxeo-cli#master
Nuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.