> For the complete documentation index, see [llms.txt](https://docs.dbnl.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dbnl.com/reference/cli.md).

# CLI

{% hint style="info" %}
**Distributional is now** [**Talaria Scientific**](https://talariasci.com)**.** The DBNL product described in these docs has been sunset; this documentation is preserved for reference. Read [the announcement](https://distributional.com/blog/distributional-is-now-talaria).
{% endhint %}

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:

```shell
pip install dbnl
```

## `dbnl`

The dbnl CLI.

```shell
dbnl [OPTIONS] COMMAND [ARGS]...
```

* **Options**
  * **`--version`** - Show the version and exit.

### `config`

Manage dbnl SDK configuration.

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

#### `clear`

Delete the configuration file.

```shell
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<br>

```shell
dbnl config set [OPTIONS] PAIRS...
```

* **Arguments**
  * **`PAIRS`** - Required argument(s)

#### `show`

Display the current configuration.

```shell
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<br>

```shell
dbnl config unset [OPTIONS] KEYS...
```

* **Arguments**
  * **`KEYS`** - Required argument(s)

#### `validate`

Validate configuration against the API.

```shell
dbnl config validate [OPTIONS]
```

### `info`

Info about SDK and API.

```shell
dbnl info [OPTIONS]
```

### `sandbox`

Subcommand to interact with the sandbox.

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

#### `delete`

Delete sandbox data.

```shell
dbnl sandbox delete [OPTIONS]
```

* **Options**
  * **`-f, --force`** - Force delete

#### `exec`

Exec a command on the sandbox.

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

* **Arguments**
  * **`COMMAND`** - Optional argument(s)

#### `logs`

Tail the logs for the sandbox or a specific service.

```shell
dbnl sandbox logs [OPTIONS]
```

* **Options**
  * **`--service <service>`** - Tail service logs.
* **Options:** sandbox | api | scheduler | ui | worker

#### `start`

Start the sandbox.

```shell
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.

```shell
dbnl sandbox status [OPTIONS]
```

#### `stop`

Stop the sandbox.

```shell
dbnl sandbox stop [OPTIONS]
```