Skip to main content

Verse CLI

The Verse CLI helps with design-time development and deployment tasks. It's primarily used to manage Migrations, but also provides a way to query the database and output the model as JSON.

Verify your installation by running:

npx verse

The output of the command will return the following help message:


  ██╗   ██╗ ███████╗ ██████╗  ███████╗ ███████╗
  ██║   ██║ ██╔════╝ ██╔══██╗ ██╔════╝ ██╔════╝
  ██║   ██║ █████╗   ██████╔╝ ███████╗ █████╗  
  ╚██╗ ██╔╝ ██╔══╝   ██╔══██╗ ╚════██║ ██╔══╝  
   ╚████╔╝  ███████╗ ██║  ██║ ███████║ ███████╗
    ╚═══╝   ╚══════╝ ╚═╝  ╚═╝ ╚══════╝ ╚══════╝

Usage: verse <command> [options]

Commands:
  verse migrations    Commands for managing migrations for the target database.
  verse query <expr>  Executes a verse query expression and outputs the results.
  verse model         Outputs a JSON representation of the model.

Options:
  -h, --help  Show help  [boolean]