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

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

Global Flags

Global flags that can be added to any command.

-c, --config

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

-h, --help

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

activate command

nextmv activate [flags]

Note: Tokens auto-renew, and there is no longer an activation required to extend a token

If you receive an error message containing "Your token expired and couldn't be updated" it is advised to run the activate command. In case of any questions or issues, please contact support.

app command

The nextmv app command set is used to manage and run custom decision applications.

You can push new binaries to Nextmv Cloud and run them remotely with Nextmv CLI or using the Nextmv Cloud REST API.

nextmv app [command]

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

nextmv app [command]

Available app subcommands

app create subcommand

nextmv app create [flags]

The create subcommand creates a new application. An application represents a problem you are solving and contains things like executable binaries, versions, and instances to manage and run your application. (See Apps core concepts for more)

These are the available flags for the create subcommand:

app delete subcommand

nextmv app delete [flags]

The delete subcommand deletes an application. When you delete an application all of the versions and instances are also deleted.

app get subcommand

nextmv app get [flags]

The get subcommand gets the information related to an application.

app input subcommand

nextmv app input [flags]

The input subcommand gets the input for a given application run.

app list subcommand

nextmv app list [flags]

The list subcommand lists all of the applications for your account.

app metadata subcommand

nextmv app metadata [flags]

The metadata subcommand gets the metadata results for the application run specified. Results contain the output of the run, and metadata related to the execution.

app promote subcommand

nextmv app promote [flags]

The promote subcommand creates a new version of an application from the last pushed binary, and assigns that version to the default instance. If you specify an instance ID, then the newly created version will be assigned to this instance and then this instance will be set as the app’s default instance (replacing the default instance if there was one prior). If the instance ID you specify does not exist, a new instance will be created using the specified ID (the name will be auto-generated), the newly created version assigned to the instance, and this newly created instance set as the app’s default instance.

Since the CLI is oriented towards the developer, remote runs made through the CLI that don't specify an instance will run the last pushed binary. (The default instance can be specified with the --default flag.)

Calls made to the Nextmv Cloud API endpoints that don’t specify an instance will run the binary specified in the default instance. (The last pushed binary can be specified in the API call with the reserved instance name devint which designates the latest binary.)

app push subcommand

nextmv app push [flags]

The push subcommand updates the latest binary in the cloud with your local application build. You must run this from the directory containing your application project.

app result subcommand

nextmv app result [flags]

The result subcommand gets the results for the application specified. Results contain the output of the run, and metadata related to the execution. If the run failed or is still in progress, then only metadata will be present in the results.

app run subcommand

nextmv app run [flags]

The run subcommand starts a run of an application.

app update subcommand

nextmv app update [flags]

The update subcommand allows updating the mutable information on the specified application. The mutable information is limited to the name, description, and ID of the default instance. If the name, description, or default instance ID tag is undefined the corresponding value will not be updated.

app version subcommand

The version subsuite for the nextmv app command set is used to directly and explicitly manage application versions. The default workflow for the nexmtmv app command set handles most of the functionality of this subsuite implicitly.

nextmv help app version

Available commands for version subsuite

version create

nextmv app version create [flags]

The version create subcommand creates a new application version with the underlying binary defined by the current active development instance (i.e. the latest binary pushed to the app)

version delete

nextmv app version delete [flags]

The version delete subcommand deletes a specified version from your application. Note that the version cannot be deleted if there are any instances running it.

version get

nextmv app version get [flags]

The version get subcommand gets the information related to an application version.

version list

nextmv app version list [flags]

The version list subcommand lists all of the versions for an application.

version update

nextmv app version update [flags]

The version update subcommand allows updating the mutable information on the specified version of your application. The mutable information is limited to the name and description of the version. If either the name or description tag are undefined, the corresponding value will not be updated.

app instance subcommand

The instance subsuite for the nextmv app command set is used to directly and explicitly manage application instances. The default workflow for the nexmtmv app command set handles limited functionality from this subsuite implicitly.

nextmv help app instance

Available commands for instance subsuite

instance create

nextmv app instance create [flags]

The instance create subcommand creates a new application instance with the underlying version specified by user input.

instance delete

nextmv app instance delete [flags]

The instance delete subcommand deletes a specified instance from your application.

instance get

nextmv app instance get [flags]

The instance get subcommand gets the information related to an application instance.

instance list

nextmv app version list [flags]

The instance list subcommand lists all of the instances for an application.

instance update

nextmv app instance update [flags]

The instance update subcommand allows updating the information on the specified instance of your application. The instance's name, description, and the ID of the underlying version it uses can be modified. If any of these values are not defined via flags, they will not be modified

completion command

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

configure command

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

experiment command

nextmv experiment [command]

Experiments are used to test the performance of your models by running and comparing the results of various models, or a single model with multiple inputs.. From the CLI, you can create input sets and start new experiments. Experiments are run remotely on Nextmv Cloud and accessible via the Nextmv console.

Below is a list of available CLI subcommands

Available Experiment Commands

batch

Batch experiments are used to run a set of inputs against a number of application instances on Nextmv Cloud. The results are aggregated and made available to the user in the Nextmv console.

batch start

nextmv experiment batch start [flags]

batch result

nextmv experiment batch result [flags]

input-set

Input sets are used to define named inputs for a batch experiment that can be reused across experiments.

input-set create

nextmv experiment input-set create [flags]

input-set list

nextmv experiment input-set list [flags]

input-set get

nextmv experiment input-set get [flags]

input-set update

nextmv experiment input-set update [flags]

For more information use the --help flags for each command.

shadow

A shadow test is an experiment that runs in the background and compares the results of a baseline instance against a candidate instance. When the shadow test has started, any run made on the baseline instance will trigger a run on the candidate instance using the same input and options. For more information see the shadow tests reference.

shadow create

nextmv experiment shadow create \
  --app-id "pizza-delivery" \
  --shadow-test-id "pizza-shadow-test" \
  --name "pizza-delivery-region-compare" \
  --baseline-instance-id "pizza-delivery-nyc-production" \
  --candidate-instance-id "pizza-delivery-nyc-candidate" \
  --start-time "2021-09-01T16:00:00Z" \
  --end-time "2023-09-30T00:00:00Z" \
  --maximum-runs 50

shadow list

nextmv experiment shadow list \
  --app-id "pizza-delivery"

shadow result

nextmv experiment shadow result \
  --app-id "pizza-delivery" \
  --shadow-test-id "pizza-shadow-test"

shadow runs

nextmv experiment shadow runs \
  --app-id "pizza-delivery" \
  --shadow-test-id "pizza-shadow-test"

shadow start

nextmv experiment shadow start \
  --app-id "pizza-delivery" \
  --shadow-test-id "pizza-shadow-test"

shadow stop

nextmv experiment shadow stop \
  --app-id "pizza-delivery" \
  --shadow-test-id "pizza-shadow-test" \
  --intent "complete"

For more information use the --help flags for each command.

go command

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

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

Provides passthrough access to the packaged Go toolchain.

Usage:
  nextmv go [go command] [arguments] [flags]

Examples:
  $ nextmv go version

Flags:
  -h, --help   Help for go.

Global Flags:
  -c, --config string   Full path to config file.

help command

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
  marketplace Commands to manage and interact with marketplace.
  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

marketplace command

nextmv marketplace [command]

The marketplace command set is used to manage marketplace commands.

This command set is used to manage marketplace commands.

Usage:
  nextmv marketplace [command]

Available Commands:
  app          Commands to manage marketplace applications.
  subscription Commands to manage marketplace subscriptions.

Flags:
  -h, --help   Help for marketplace.

Global Flags:
  -c, --config string   Full path to config file.

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

Available Marketplace Subcommands

marketplace app subsuite

nextmv marketplace app [command]

Available marketplace app Subcommands

marketplace subscription subsuite

nextmv marketplace subscription [command]

Available marketplace subscription Subcommands

private command

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

These are the available subcommands of the private command:

bootstrap subcommand

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

configure subcommand

The configure subcommand configures a private cloud environment.

These are the available flags for the private configure command:

get-release subcommand

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

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

keys subcommand

The keys subcommand manages the private cloud keys.

These are the available subcommands of the nextmv private keys command:

create subcommand

The create subcommand creates a new key for admin and non-admin (applications).

These are the available flags for the create subcommand:

deactivate subcommand

The deactivate subcommand deactivates an enabled API key.

These are the available flags for the deactivate command:

keys list subcommand

The list subcommand lists API keys info.

These are the available flags for the list subcommand:

reactivate subcommand

The reactivate subcommand reactivates a disabled API key.

These are the available flags for the reactivate subcommand:

list-releases subcommand

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

sdk command

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:

init subcommand

Generate a new Nextmv model from a template.

Available templates:
  mip
  nextroute
  ortools

Usage:
  nextmv sdk init [flags]

Examples:

# Example generating nextroute template (in a nextroute directory)
nextmv sdk init -t nextroute

# Example generating nextroute template in ~/sample/my_app
nextmv sdk init -t nextroute -d ~/sample/my_app


Flags:
  -d, --directory string   The directory in which to generate the template files, default is the name of the template at current directory.
  -h, --help               Help for init.
  -t, --template string    The type of Nextmv model template you wish to generate.

Global Flags:
  -c, --config string   Full path to config file.

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

Available templates

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:

ls -v knapsack

install subcommand

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

run subcommand

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 \

update command

nextmv update [version] [flags]

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

version command

nextmv version [flags]

The version command prints the Nextmv CLI version.

Runner and solver options

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.