CLI

The NateUI CLI creates a starter from a template and extends it with NateUI source code. It handles the setup needed to add a page to your project while leaving the copied code in your application for you to customize.

Run the CLI through your package manager:

You do not need to install it globally. When changing an existing project, run the command from the project root, where its package.json is located.

Template commands use the access associated with your NateUI account. If you have not signed in, the CLI will ask you to sign in with the email used for your purchase.

Create a template starter

Use init-template to create a starter project:

Choose the flag for your template:

The project folder must be new or empty. The resulting starter contains the shared application foundation; you can add any demo pages you want separately.

Follow Installation for the complete setup, including signing in, installing packages and starting the app.

Find and add a page

First, list the pages available from a template:

Each result has an ID such as crm/contacts. The first part identifies the source template, and the second identifies the page.

Turn those two parts into flags when adding the page:

Run this command from your starter’s root folder. The CLI copies the page and its supporting source, then registers the supplied route and navigation entry in the current project.

If the page needs additional packages, the CLI prints the install command for you to run.

See Add demo pages for removing or replacing a page and handling existing files.

Add pages from another template

The template used to create your starter does not limit which pages you can add. The current project is the destination, while the template flag tells the CLI where the page comes from.

If your account includes access to multiple templates, you can list and add pages from any of them. For example, you can add the CRM Contacts page to a starter created from another template:

The CLI adds the page to the project in your current folder; it does not create a separate application. Your account must include access to the source template.

Add components and Blocks

Use add-page when you want a complete template screen. When you only need an individual component or Block, use the CLI’s add command instead:

Components and Blocks are also copied into your project as editable source code. See the Components CLI guide for finding items, adding multiple items and handling existing files.