CLI

Installing and using the DBNL Command Line Interface (CLI)

Distributional is now Talaria Scientific. The DBNL product described in these docs has been sunset; this documentation is preserved for reference. Read the announcement.

The dbnl CLI is installed as part of the SDK and allows for interacting with the dbnl platform from the command line.

To install the SDK, run:

pip install dbnl

dbnl

The dbnl CLI.

dbnl [OPTIONS] COMMAND [ARGS]...

• Options

  • --version - Show the version and exit.

config

Manage dbnl SDK configuration.

dbnl config [OPTIONS] COMMAND [ARGS]...

clear

Delete the configuration file.

dbnl config clear [OPTIONS]

set

Set configuration values (KEY=VALUE …).

Accepted keys: api_token API token for authentication api_url Base URL of the dbnl API app_url Base URL of the dbnl app

dbnl config set [OPTIONS] PAIRS...

• Arguments

  • PAIRS - Required argument(s)

show

Display the current configuration.

dbnl config show [OPTIONS]

unset

Remove configuration keys (KEY …).

Accepted keys: api_token API token for authentication api_url Base URL of the dbnl API app_url Base URL of the dbnl app

dbnl config unset [OPTIONS] KEYS...

• Arguments

  • KEYS - Required argument(s)

validate

Validate configuration against the API.

dbnl config validate [OPTIONS]

info

Info about SDK and API.

dbnl info [OPTIONS]

sandbox

Subcommand to interact with the sandbox.

dbnl sandbox [OPTIONS] COMMAND [ARGS]...

delete

Delete sandbox data.

dbnl sandbox delete [OPTIONS]

• Options

  • -f, --force - Force delete

exec

Exec a command on the sandbox.

dbnl sandbox exec [OPTIONS] [COMMAND]...

• Arguments

  • COMMAND - Optional argument(s)

logs

Tail the logs for the sandbox or a specific service.

dbnl sandbox logs [OPTIONS]

• Options

  • --service <service> - Tail service logs.

• Options: sandbox | api | scheduler | ui | worker

start

Start the sandbox.

dbnl sandbox start [OPTIONS]

• Options

  • -u, --registry-username <registry_username> - Registry username

  • -p, --registry-password <registry_password> - Registry password

  • --registry <registry> - Registry

  • --version <version> - Sandbox version

    • Default: '0.32'

  • --base-url <base_url> - Sandbox base url

    • Default: 'http://localhost:8080'

  • -q, --quiet - Suppress pull progress output

status

Get sandbox status.

dbnl sandbox status [OPTIONS]

stop

Stop the sandbox.

dbnl sandbox stop [OPTIONS]