Migrating to the new Nextmv CLI

Guide for migrating from the old CLI to the new Nextmv CLI.

The Nextmv CLI has evolved to better serve our users with enhanced functionality, improved installation options, and a more modern interface. This new CLI is based on the major version (v1) release of our nextmv Python SDK, which introduces significant improvements alongside necessary breaking changes.

The new CLI maintains similar functionality to the old version while improving the command structure and user experience. Most commands have direct equivalents, though some have been reorganized for better clarity.

While we understand that migrating isn't easy, we believe the benefits far outweigh the challenges. We will continue to support the old CLI on a case-by-case basis but it will not receive updates or new features moving forward. We will sunset the old CLI entirely in the future.

Please don't hesitate to contact us if you need help.

Why we made this change

  • Major version release: This CLI is built on our Python SDK v1, a major version release that brings significant new functionality including shadow testing, switchback experiments, and complete CRUD operations (create, read, update, delete) for all platform resources.
  • Feature parity & enhanced functionality: The new CLI builds upon our Python SDK, offering all the capabilities of the previous version plus additional features and improved performance. New capabilities include enhanced experiment management and user-friendly prompting.
  • Multiple installation options: By distributing through PyPI, we've made it easier for enterprise customers with strict security policies to install and manage the CLI using their preferred Python package manager.
  • Modern user experience: The new CLI features an enhanced interface with better help documentation, improved error messages, and a more intuitive command structure.
  • Better maintenance: Consolidating our CLI with the Python SDK allows for faster feature development and more consistent behavior across our tools.

Migration guide

You should consider the new CLI as a different tool from the old one. This means that it introduces breaking changes in several places. We recommend that you review the new commands and update any scripts or workflows that depend on the old CLI accordingly.

This migration guide is grouped into sections, based on the feature being migrated. Each section contains a table mapping old commands to their new equivalents and where applicable, a table with the new functionality added in this latest CLI. The last sections are dedicated to entirely new features that did not exist in the old CLI.

The best way to migrate is to get the help for a command, read the description, and see the available options. You can do this by running nextmv <COMMAND> -h.

Root commands

Old commandNew commandNotes
nextmv completionnextmv --install-completion/--show-completionChanged to use options instead of subcommands.
nextmv configurenextmv configuration createAdded the delete and list subcommands to configuration as well.
nextmv helpnextmv --help/-hThe core help command is changed to only use the options.
nextmv release-notesN/ASee the release notes in the nextmv-py GitHub repo directly.
nextmv updateN/AUse your package manager to update the CLI.
nextmv versionnextmv version or nextmv --versionNo changes.

Account management

Old commandNew commandNotes
nextmv account createnextmv cloud account createAccount management moved under cloud.
nextmv account deletenextmv cloud account deleteAccount management moved under cloud.
nextmv account getnextmv cloud account getAccount management moved under cloud.
nextmv account queuenextmv cloud run listQueue functionality moved to cloud runs. Use --status to filter on a particular run status, e.g. queued.
nextmv account updatenextmv cloud account updateAccount management moved under cloud.
nextmv account ssonextmv cloud ssoSSO management moved under cloud.

SSO account management

Old commandNew commandNotes
nextmv account sso configurenextmv cloud sso configureSSO account management from app to cloud sso.
nextmv account sso deletenextmv cloud sso deleteSSO account management from app to cloud sso.
nextmv account sso disablenextmv cloud sso disableSSO account management from app to cloud sso.
nextmv account sso enablenextmv cloud sso enableSSO account management from app to cloud sso.
nextmv account sso getnextmv cloud sso getSSO account management from app to cloud sso.

Application management

Old commandNew commandNotes
nextmv app createnextmv cloud app createApplication management moved under cloud.
nextmv app deletenextmv cloud app deleteApplication management moved under cloud.
nextmv app getnextmv cloud app getApplication management moved under cloud.
nextmv app listnextmv cloud app listApplication management moved under cloud.
nextmv app promotenextmv cloud app push"Promotion" happens after pushing. The nextmv cloud app push command will prompt users or allow them to use options.
nextmv app pushnextmv cloud app pushApplication management moved under cloud.
nextmv app updatenextmv cloud app updateApplication management moved under cloud.

✨ New commands added for application management.

✨ New commandNotes
nextmv cloud app existsTells you if an application with the given ID exists.
nextmv cloud data uploadUpload data for Nextmv Cloud app components.
nextmv cloud upload createCreate temporary upload URLs for Nextmv Cloud applications.

Instance management

Old commandNew commandNotes
nextmv app instance createnextmv cloud instance createInstance management moved from app to cloud instance.
nextmv app instance deletenextmv cloud instance deleteInstance management moved from app to cloud instance.
nextmv app instance getnextmv cloud instance getInstance management moved from app to cloud instance.
nextmv app instance listnextmv cloud instance listInstance management moved from app to cloud instance.
nextmv app instance updatenextmv cloud instance updateInstance management moved from app to cloud instance.

✨ New commands added for instance management.

✨ New commandNotes
nextmv cloud instance existsTells you if an instance with the given ID exists.

Version management

Old commandNew commandNotes
nextmv app version createnextmv cloud app version createVersion management moved from app to cloud version.
nextmv app version deletenextmv cloud app version deleteVersion management moved from app to cloud version.
nextmv app version getnextmv cloud app version getVersion management moved from app to cloud version.
nextmv app version listnextmv cloud app version listVersion management moved from app to cloud version.
nextmv app version updatenextmv cloud app version updateVersion management moved from app to cloud version.

✨ New commands added for version management.

✨ New commandNotes
nextmv cloud version existsTells you if an version with the given ID exists.

Run management

Old commandNew commandNotes
nextmv app cancelnextmv cloud run cancelRun management moved from app to cloud run.
nextmv app inputnextmv cloud run inputRun management moved from app to cloud run.
nextmv app logsnextmv cloud run logsRun management moved from app to cloud run.
nextmv app metadatanextmv cloud run metadataRun management moved from app to cloud run.
nextmv app outputnextmv cloud run getThe output (result) of the run can be fetched from getting the run directly.
nextmv app resultnextmv cloud run getThe result of the run can be fetched from getting the run directly.
nextmv app runnextmv cloud run createRun management moved from app to cloud run.
nextmv app statusnextmv cloud run metadataYou can get the status from the metadata.
nextmv app tailnextmv cloud run logs --tailConsolidated logs fetching and tailing in a single command.

✨ New commands added for run management.

✨ New commandNotes
nextmv cloud run listLists all the runs in an app.
nextmv cloud run trackTrack an external run in an app.

Community Commands

Old commandNew commandNotes
nextmv community clonenextmv community cloneNo changes.
nextmv community listnextmv community listNo changes.

Acceptance test management

Old commandNew commandNotes
nextmv experiment acceptance deletenextmv cloud acceptance deleteAcceptance test management moved from experiment to cloud acceptance.
nextmv experiment acceptance initnextmv cloud acceptance createYou don't initialize and start separately anymore. Use create to create and run an acceptance test.
nextmv experiment acceptance startnextmv cloud acceptance startAcceptance test management moved from experiment to cloud acceptance.

✨ New commands added for acceptance test management.

✨ New commandNotes
nextmv cloud acceptance getGet details and the result of an acceptance test.
nextmv cloud acceptance listList all acceptance tests for an application.
nextmv cloud acceptance updateUpdate an acceptance test.

Batch experiment management

Old commandNew commandNotes
nextmv experiment batch deletenextmv cloud batch deleteBatch experiment management moved from experiment to cloud batch.
nextmv experiment batch resultnextmv cloud batch getBatch experiment management moved from experiment to cloud batch.
nextmv experiment batch startnextmv cloud batch createBatch experiment management moved from experiment to cloud batch.

✨ New commands added for batch experiment management.

✨ New commandNotes
nextmv cloud batch listList all batch experiments for an application.
nextmv cloud batch metadataGet the metadata of a batch experiment.
nextmv cloud batch updateUpdate a batch experiment.

Managed inputs handling

Old commandNew commandNotes
nextmv experiment input createnextmv cloud managed-input createManaged inputs handling moved from experiment to cloud managed-input.
nextmv experiment input getnextmv cloud managed-input getManaged inputs handling moved from experiment to cloud managed-input.
nextmv experiment input listnextmv cloud managed-input listManaged inputs handling moved from experiment to cloud managed-input.
nextmv experiment input updatenextmv cloud managed-input updateManaged inputs handling moved from experiment to cloud managed-input.

✨ New commands added for managed inputs handling.

✨ New commandNotes
nextmv cloud managed-input deleteDelete a managed input.

Input set management

Old commandNew commandNotes
nextmv experiment input-set createnextmv cloud input-set createInput set management moved from experiment to cloud input-set.
nextmv experiment input-set getnextmv cloud input-set getInput set management moved from experiment to cloud input-set.
nextmv experiment input-set listnextmv cloud input-set listInput set management moved from experiment to cloud input-set.
nextmv experiment input-set updatenextmv cloud input-set updateInput set management moved from experiment to cloud input-set.

✨ New commands added for input set management.

✨ New commandNotes
nextmv cloud input-set deleteDelete an input set.

Shadow test management

Old commandNew commandNotes
nextmv experiment shadow createnextmv cloud shadow createShadow test management moved from experiment to cloud shadow.
nextmv experiment shadow listnextmv cloud shadow listShadow test management moved from experiment to cloud shadow.
nextmv experiment shadow resultnextmv cloud shadow getShadow test management moved from experiment to cloud shadow.
nextmv experiment shadow runsnextmv cloud shadow getRuns and result are both returned in the nextmv cloud shadow get command.
nextmv experiment shadow startnextmv cloud shadow startShadow test management moved from experiment to cloud shadow.
nextmv experiment shadow stopnextmv cloud shadow stopShadow test management moved from experiment to cloud shadow.

✨ New commands added for shadow test management.

✨ New commandNotes
nextmv cloud shadow deleteDelete a shadow test.
nextmv cloud shadow metadataGet metadata of a shadow test.
nextmv cloud shadow updateUpdate a shadow test.

Ensemble runs management

✨ This feature is new to the CLI.

✨ New commandNotes
nextmv cloud ensemble createCreate an ensemble definition.
nextmv cloud ensemble deleteDelete an ensemble definition.
nextmv cloud ensemble getGet details of an ensemble definition.
nextmv cloud ensemble listList all ensemble definitions for an application.
nextmv cloud ensemble updateUpdate an ensemble definition.

Scenario test management

✨ This feature is new to the CLI.

✨ New commandNotes
nextmv cloud scenario createCreate a scenario test.
nextmv cloud scenario deleteDelete a scenario test.
nextmv cloud scenario getGet details of a scenario test.
nextmv cloud scenario listList all scenario tests for an application.
nextmv cloud scenario metadataGet metadata of a scenario test.
nextmv cloud scenario updateUpdate a scenario test.

Secrets management

✨ This feature is new to the CLI.

✨ New commandNotes
nextmv cloud secrets createCreate a secrets collection.
nextmv cloud secrets deleteDelete a secrets collection.
nextmv cloud secrets getGet details of a secrets collection.
nextmv cloud secrets listList all secrets collections for an application.
nextmv cloud secrets updateUpdate a secrets collection.

Switchback test management

✨ This feature is new to the CLI.

✨ New commandNotes
nextmv cloud switchback createCreate a switchback test.
nextmv cloud switchback deleteDelete a switchback test.
nextmv cloud switchback getGet details of a switchback test.
nextmv cloud switchback listList all switchback tests for an application.
nextmv cloud switchback metadataGet metadata of a switchback test.
nextmv cloud switchback startStart a switchback test.
nextmv cloud switchback stopStop a switchback test.
nextmv cloud switchback updateUpdate a switchback test.

Page last updated

Go to on-page nav menu