Command Line Interface¶
drift-cli¶
CLI client for PANDA | Drift Platform
Usage:
drift-cli [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version |
boolean | Show the version and exit. | False |
--config, -c |
Path | Path to config file. Default ${HOME}/drift-cli/config.toml | None |
--parallel, -p |
integer | Number of parallel tasks to use, defaults to 10 | None |
--debug, -d |
boolean | Enable debug logging | False |
--help |
boolean | Show this message and exit. | False |
drift-cli alias¶
Commands to manage aliases
Usage:
drift-cli alias [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
drift-cli alias add¶
Add a new alias with NAME
Usage:
drift-cli alias add [OPTIONS] NAME
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--address, -A |
text | Address of Drift instance, can be IP or hostname | None |
--password, -p |
text | Password for Drift instance | None |
--bucket, -b |
text | Bucket to use, defaults to 'data' | None |
--help |
boolean | Show this message and exit. | False |
drift-cli alias ls¶
Print list of aliases
Usage:
drift-cli alias ls [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
drift-cli alias rm¶
Remove alias with NAME
Usage:
drift-cli alias rm [OPTIONS] NAME
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
drift-cli alias show¶
Show alias configuration
Usage:
drift-cli alias show [OPTIONS] NAME
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
drift-cli export¶
Export data from a bucket somewhere else
Usage:
drift-cli export [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
drift-cli export raw¶
Export data from SRC bucket to DST folder
SRC should be in the format of ALIAS/BUCKET_NAME. DST should be a path to a folder.
As result, the folder will contain a folder for each entry in the bucket. Each entry folder will contain a file for each record in the entry with the timestamp as the name.
Usage:
drift-cli export raw [OPTIONS] SRC DEST
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--stop |
text | Export records with timestamps older than this time point in ISO format e.g 2023-01-01T00:00:00.000Z | None |
--start |
text | Export records with timestamps newer than this time point in ISO format e.g. 2023-01-01T00:00:00.000Z | None |
--topics |
text | Export only these topics, separated by comma. You can use * as a wildcard | `` |
--csv |
boolean | Export data as CSV instead of raw data (only for timeseries) | False |
--jpeg |
boolean | Export data as JPEG instead of raw data (only for images) | False |
--with-metadata / --no-with-metadata |
boolean | Export metadata along with the data (doesn't work with --csv) | False |
--help |
boolean | Show this message and exit. | False |