CLI

Nextmv CLI is a command line interface that you can use to interact with Nextmv.

nextmv [command]

To display more information about a command, use the help command or one of the help global flags: --help, -h.

nextmv help

Available commands and their corresponding subcommands. You can navigate to each section to learn more about the specific command.

Global flags that can be added to any command.

This flag instructs the command to use the config file that is passed to it instead of the standard configuration file created with nextmv configure (though note that the existing configuration file is not modified in any way). Here is an example using the sdk run command:

nextmv sdk run main.go -c ~/.nextmv/another-config.yaml

This flag displays the help menu.

nextmv -h

You can also display the help for the specified command or subcommand. Here is an example using the version command:

nextmv version -h

nextmv activate [flags]

The activate command is used to re-activate the token for extension of the local free trial. Re-activation will only succeed for eligible users. In case of any questions or issues, please contact support.

nextmv app [command]

The app command manages and interacts with applications that you push and run in Nextmv Cloud. This feature is currently in public beta. Please contact support to request access.

nextmv completion [command]

The completion command generates the autocompletion script for the Nextmv CLI for the specified shell.

Here is an example on displaying the completion for zsh:

nextmv help completion zsh

nextmv configure [flags]

The configure command adds or modifies your Nextmv API key for use with the Nextmv CLI. Running this command will create a config.yaml file (or modify it if already present) in the directory where your nextmv binary is located. Note that the base API endpoint will be set automatically with the default value when you pass your API key with the --api-key flag. This command is typically run once.

These are the available flags for the configure command:

Here is an example where the configure command is used to update the Nextmv API key with an environment variable.

nextmv configure -a $API_KEY

nextmv help [command] [flags]

The help command displays the main help menu.

--------------------------------------------------------------------------------
This software is provided by Nextmv.

© 2019-2023 nextmv.io inc. All rights reserved.

    (\/)     (\/)     (\/)     (\/)     (\/)     (\/)     (\/)     (\/)     (\/)
    (^^)     (^^)     (^^)     (^^)     (^^)     (^^)     (^^)     (^^)     (^^)
   o( O)    o( O)    o( O)    o( O)    o( O)    o( O)    o( O)    o( O)    o( O)
--------------------------------------------------------------------------------

Usage:
  nextmv [command]

Available Commands:
  activate    Activate nextmv CLI.
  app         Commands to manage and interact with your applications.
  completion  Generate the autocompletion script for the specified shell
  configure   Configure the Nextmv CLI.
  experiment  Commands to run and manage experiments (beta).
  go          Provides passthrough access to the packaged Go toolchain.
  help        Help about any command
  private     Manage and interact with the Nextmv private cloud environment.
  sdk         Install dev tools, initialize optimization templates and run models locally.
  update      Updates the CLI tool.
  version     Prints the Nextmv CLI version.

Flags:
  -c, --config string   Full path to config file.
  -h, --help            Help for nextmv.

Use "nextmv [command] --help" for more information about a command.

You can use help to display the help menu for any specified command or subcommand.

Here is an example where the help command is used to display the help for the sdk run command:

nextmv help sdk run

nextmv go [go command] [arguments] [flags]

The go command provides a passthrough to the Nextmv-managed Go toolchain.

nextmv private [command]

The private command manages and interacts with the Nextmv private cloud environment.

These are the available subcommands of the private command:

nextmv private bootstrap [flags]

The private bootstrap command bootstraps a new default admin configuration. A service url should be provided.

nextmv private configure [flags]

The private configure command configures a private cloud environment.

These are the available flags for the private configure command:

nextmv private get-release [version] [flags]

The private get-release command gets an installable release for a private deployment.

These are the available flags for the private get-release command:

nextmv private keys [command]

The private keys command manages the private cloud keys.

These are the available subcommands of the private keys command:

private keys create command

nextmv private keys create [flags]

The private keys create command creates a new key for admin and non-admin (applications).

These are the available flags for the private keys create command:

private keys deactivate command

nextmv private keys deactivate [flags]

The private keys deactivate command deactivates an enabled API key.

These are the available flags for the private keys deactivate command:

private keys list command

nextmv private keys list [flags]

The private keys list command lists API keys info.

These are the available flags for the private keys list command:

private keys reactivate command

nextmv private keys reactivate [flags]

The private keys reactivate command reactivates a disabled API key.

These are the available flags for the private keys reactivate command:

nextmv private list-releases [flags]

The private list-releases command lists releases for private cloud.

nextmv sdk [command]

The sdk command suite contains commands for downloading and using Nextmv plugins for local development.

These are the available subcommands for the sdk command:

nextmv sdk init [flags]

The init subcommand initializes a new Nextmv template. A template is a ready-to-run application that solves a decision automation problem.

For a more in depth understanding of how to use each of these templates, visit the SDK reference page.

These are the available flags for the init subcommand:

Here is an example where the init subcommand is used to generate the knapsack template.

nextmv sdk init -t knapsack

After initializing the template, you can use the tree command to check the contents of the knapsack dir:

tree knapsack

nextmv sdk install [version] [flags]

The install subcommand downloads the latest version of the SDK shared object files (or the version specified, if given) and the Nextmv-managed Go executable for your architecture.

These are the available flags for the install subcommand:

Here is an example where the install subcommand is used to check that all the necessary files and the Nextmv-managed Go executable are already installed:

nextmv sdk install

nextmv sdk run package [flags]

The run subcommand allows you to compile and run custom code consuming the Nextmv SDK.

These are the available flags for the run subcommand:

Here is an example where the sdk init and sdk run commands are used to run the routing template. The input is read from the input.json file and the output is saved to an output.json file.

nextmv sdk init -t routing
nextmv sdk run routing/main.go -- \
    -runner.input.path routing/input.json \
    -runner.output.path routing/output.json \
    -limits.duration 5s \

nextmv update [version] [flags]

The update command updates the Nextmv CLI. If the version is not specified, it will update to the latest one.

nextmv version [flags]

The version command prints the Nextmv CLI version.

All applications are configurable through the following options.

• Runner options change how the runner outputs solutions. For instance, -runner.output.solutions default of last will only output the final improving solution in a decision automation model.
• Solver options change how many states are allowed in a diagram, how many states it pulls from the search queue, termination criteria, and randomization.

Options can be configured as CLI flags or environment variables. To set an environment variable, convert its corresponding CLI flag to uppercase, replacing each period (.) with an underscore (_) and removing the leading dash (-). For example:

-limits.solutions is equivalent to LIMITS_SOLUTIONS.

If both an environment variable and its corresponding CLI flag are defined, the CLI flag will overwrite the environment variable.

Solver options are automatically marshaled into model output in the options section of the JSON.