Tools for the Nuxeo Platform

Discover Nuxeo CLI by Example

This page is scheduled for review and update. Check back soon for updated content!

Discover how to bootstrap Nuxeo components or a new project using Nuxeo CLI.

Bootstrapping a New Project

Assume that you just created a new folder called my-project.

Bootstrap a Packaged New Project with an Operation and a Service

$ nuxeo bootstrap multi-module operation service package
  • Operation: Requires a core module
  • Service: Requires a core module
  • Package: Requires a package module

Modules: Multiple modules required -> target project will be multi-module.

Folders result:

my-project
├── my-project-core
└── my-project-package

Bootstrap a Packaged New Project with an Operation, a Listener and a Polymer Application

$ nuxeo bootstrap multi-module operation listener polymer package
  • Operation: Requires a core module
  • Listener: Requires a core module
  • Polymer: Requires a web module
  • Package: Requires a package module

Modules: Multiple modules required -> target project will be multi-module.

Folders result:

my-project
├── my-project-core
├── my-project-package
└── my-project-web

Bootstrap a New Project with Only an Operation

$ nuxeo bootstrap operation

Modules: Only one module is required -> target project will be simple-module.

Folders result:

my-project

Bootstrap a New Multi-Module Project with Only an Operation

$ nuxeo bootstrap operation multi-module

Modules: Only one module is required, but multi-module is forced -> target project will be multi-module

Folders result:

my-project
└── my-project-core

Then, you'll be able to add it a package.

$ nuxeo bootstrap package

Folders result:

my-project
├── my-project-core
└── my-project-package

Bootstrapping in an Existing Project

To prevent unpredictable behaviors always execute the FIRST bootstrap command from the root folder of your project.

Add an Operation in a Submodule Called my-project-service

Wrong command:

$ nuxeo bootstrap operation

Folders results:

my-project
├── my-project-core // Core module created
└── my-project-service

When you target an existing folder that does not match the default pattern <parent-folder>-core, you can override it using the --type option:

$ nuxeo bootstrap --type="service" operation

Folders results:

my-project
└── my-project-service

Add a New Nuxeo-Based Module in an Existing Multiple Modules Project

Assuming our base hierarchy is:

my-project
├── my-project-client
├── my-project-common
├── my-project-constant

If you do something like:

$ nuxeo bootstrap single-module

Folders results:

my-project
├── my-project-client
├── my-project-common
├── my-project-constant
└── my-project-core // Core module created

But in fact we target to have a my-project-server module:

$ nuxeo bootstrap --type="server" single-module

Folders results:

my-project
├── my-project-client
├── my-project-common
├── my-project-constant
└── my-project-server

12 days ago manonlumeau Final review
History: Created by manonlumeau

We'd love to hear your thoughts!

All fields required