Nuxeo CLI is a command-line interface for helping developers around Nuxeo ecosystem. It provides project bootstrapping, bundles hot reload,...
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.

Build Status npm version npm downloads Dependency Status devDependency Status


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

  • bootstrap: Bootstrap Nuxeo project, bundles or several components
  • hotreload: Trigger hot reload on your development server
  • update: Keep Nuxeo CLI up to date


Install via NPM:

npm install -g nuxeo-cli

Then 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 dest folder.

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:

If you start command inside a Studio Project clone, the source path is computed to nuxeo.war folder.

  --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 pattern option:

nuxeo sync --pattern "*.js"


  -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)"]


nuxeo update

Update internal generator-nuxeo module to gets latest changes without updating nuxeo-cli.


nuxeo bootstrap [<generator>..] [options]

See: Generator Nuxeo Bootstrap

Bootstrap Script

Script project bootstrap by passing questions' answers as command options.

nuxeo-bootstrap [<generator>..] [options]
  --dry-run, -n  Don't actually create the file(s), just list parameters,
                 default values and errors.                     [default: false]
  --help         Show help                                             [boolean]

Dry-run an operation creation to check parameters names and default values:

nuxeo-bootstrap operation -n

Create a single-module plus an operation:

nuxeo-bootstrap single-module operation --package com.sample --operation_name SampleOperation --operation_label="My Sample Operation"


nuxeo hotreload [hotreload|configure] [options]

See: Generator Nuxeo Hotreload


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.

nuxeo studio import

Import in your project a constant file containing your Studio features in order to reuse them easily in your code.

nuxeo studio export

Export your project's contributions to the Studio registries in order to reuse them in Studio.


Proxy configuration rely on the common Unix environment variable HTTP_PROXY or http_proxy. Value format: [username:password@][:1334]

HTTP_PROXY=john:doe@fake.proxy:1337 nuxeo b multi-module

Tester/Developer Environment

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


Release tag and dependencies lock are plugged to the version NPM's command.

When you bump the version

preversion task

  • node_modules folder and package-lock.json file are deleted.
  • generator-nuxeo dependency installed using the latest release.
  • Install all the others dependencies.
  • add package-lock.json file to the next commit.

postversion task

  • run npm publish
  • remove package-lock.json for the next commit.
  • bump module version without a new tag.
  • install generator-nuxeo#master.
  • add a post-release commit.
  • push everything.


# bump major version
npm version major

# bump patch
npm version patch


Apache License, Version 2.0

About Nuxeo

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