CLI

Installing and using the DBNL Command Line Interface (CLI)

The DBNL CLI is installed as part of the Python SDK and allows for interacting with the platform from the command line. It is primarily for logging into out out of a DBNL Deployment or administering a local Sandbox Deployment.

Installation

To install the latest CLI alongside the Python SDK, run:

pip install --upgrade dbnl

CLI Usage:

$ dbnl --help
Usage: dbnl [OPTIONS] COMMAND [ARGS]...

  The dbnl CLI.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  info     Info about SDK and API.
  login    Login to dbnl.
  logout   Logout of dbnl.
  sandbox  Subcommand to interact with the sandbox.

Login Usage

It is also possible to login using the UI or the Python SDK.

$ dbnl login --help
Usage: dbnl login [OPTIONS] API_TOKEN

  Login to dbnl.

Options:
  --api-url TEXT       API url
  --app-url TEXT       App url
  --namespace-id TEXT  Namespace id
  --help               Show this message and exit.

Sandbox Usage

For more details see the Sandbox Deployment docs.

dbnl sandbox --help
Usage: dbnl sandbox [OPTIONS] COMMAND [ARGS]...

  Subcommand to interact with the sandbox.

Options:
  --help  Show this message and exit.

Commands:
  delete  Delete sandbox data.
  exec    Exec a command on the sandbox.
  logs    Tail the sandbox logs.
  start   Start the sandbox.
  status  Get sandbox status.
  stop    Stop the sandbox.