Skip to main content

How to Use NDCLI

The following explains the basic steps for using NDCLI.

  • Developing a Command Line Extension
  • Deploying a Command Line Extension
  • Registering a License
  • Executing a Command Line Extension
  • Releasing a License

Developing a Command Line Extension​

First, develop a command line extension to execute custom functions in NDCLI. For details, see the following page.

Deploying a Command Line Extension​

Deploy a command line extension in the NDCLI execution environment. For details, see the following page.

License Registration​

Running command line extensions with NDCLI requires a Next Design license. If the license has not been registered using the desktop version of Next Design, register it using NDCLI. You can register either a user license or a floating license.

License registration is performed using built-in commands. For details on commands, see the following page.

Running Command Line Extensions​

Execute commands and subcommands implemented in command line extensions from NDCLI.

NDCLI command syntax consists of a command and its arguments, a subcommand and its arguments, or options. 

ndcli <command> [<params>] [<--option> [params]]
ndcli <command> <subcommand> [<params>] [<--option> [params]]
ndcli <--option>

Example: 

> ndcli license activate --key <KEY> --email <EMAIL>
> ndcli my-cli-extension IFExport --project someproject.nproj --output-folder ./interfaces
> ndcli --help
> ndcli --version
  • Command
    Specify a standard NDCLI built-in command or a command implemented in a command line extension. Commands can have subcommands. Subcommands can also have further subcommands.

For example, ndcli my-cli-extension IFExport executes the IFExport subcommand of the my-cli-extension command.

In this manual, subcommands are collectively referred to as commands.

  • Arguments (parameters)
    You can pass arguments to commands and options.

For example, if you execute ndcli my-cli-extension verify <modelid>, <modelid> will be passed to the my-cli-extension verify command.

  • Options
    You can specify options for commands.

For example, if you execute ndcli license add --key <KEY> --email <EMAIL>, the --key option and its argument <KEY>, and the --email option and its argument <EMAIL> will be passed to the license add command.

tip
  • Execute ndcli --help to display available options and commands.
  • Available commands depend on the ndcli version and installed command line extensions.
PS> ndcli --help
Usage:
ndcli [options] [command]

Options:
- version Display version information

Commands:
license The command that manages the license.

Deactivating the License​

If you want to use a license registered via NDCLI in another environment, deactivate the license from NDCLI after running the command line extension.

License deactivation is performed using built-in commands. For command details, see the following page.

caution
  • Do not deactivate the license if you registered the license via the desktop version of Next Design in the NDCLI environment. NDCLI and the desktop version of Next Design share the same license, so unlocking the license in NDCLI will also unlock the license in the desktop version of Next Design.
Last updated on