Datatrail CLI Reference

This page provides documentation for the Datatrail CLI.

datatrail

Datatrail Command Line Interface.

Usage:

datatrail [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

datatrail clear

Clear a dataset.

Usage:

datatrail clear [OPTIONS] SCOPE DATASET

Options:

Name	Type	Description	Default
--directory, -d	directory	Root directory to use. Default: None, will use the value set in the config.	None
--clear-parents	boolean	Clear all empty parent directories of dataset.	False
-v, --verbose	integer range (0 and above)	Verbosity: v=INFO, vv=DEBUG.	0
-q, --quiet	boolean	Set log level to ERROR.	False
--force, -f	boolean	Will not prompt for confirmation.	False
--help	boolean	Show this message and exit.	False

datatrail config

Datatrail CLI Configuration.

For initialising and modifying the Datatrail CLI configuration file.

Usage:

datatrail config [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

datatrail config get

Get a configuration value.

Usage:

datatrail config get [OPTIONS] KEY

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

datatrail config init

Initialise configuration.

This will create a configuration file in the home directory under .datatrail. Datatrail MUST be initialised before is can be used.

Usage:

datatrail config init [OPTIONS]

Options:

Name	Type	Description	Default
--site, -s	choice (chime | canfar | kko | gbo | hco | local)	Site to initialise Datatrail CLI for.	_required
--help	boolean	Show this message and exit.	False

datatrail config list

List all configuration values.

Usage:

datatrail config list [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

datatrail config set

Set a configuration value.

Usage:

datatrail config set [OPTIONS] KEY VALUE

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

datatrail list

List scopes & datasets

Usage:

datatrail list [OPTIONS] [SCOPE] [DATASETS]

Options:

Name	Type	Description	Default
-v, --verbose	integer range (0 and above)	Verbosity: v=INFO, vv=DEBUG.	0
-q, --quiet	boolean	Only errors shown in logs.	False
--write	boolean	Write the events to file.	False
--help	boolean	Show this message and exit.	False

datatrail ps

Details of a dataset.

Usage:

datatrail ps [OPTIONS] SCOPE DATASET

Options:

Name	Type	Description	Default
-s, --show-files	boolean	Show file names.	False
-v, --verbose	integer range (0 and above)	Verbosity: v=INFO, vv=DEBUG.	0
-q, --quiet	boolean	Set log level to ERROR.	False
--help	boolean	Show this message and exit.	False

datatrail pull

Download a dataset.

Usage:

datatrail pull [OPTIONS] SCOPE DATASET

Options:

Name	Type	Description	Default
--directory, -d	directory	Directory to pull data to.	None
--cores, -c	integer range (between 1 and 4)	Number of parallel fetch processes to use.	1
-v, --verbose	integer range (0 and above)	Verbosity: v=INFO, vv=DEBUG.	0
-q, --quiet	boolean	Set log level to ERROR.	False
--force, -f	boolean	Do not prompt for confirmation.	False
--help	boolean	Show this message and exit.	False

datatrail scout

Scout a dataset.

Usage:

datatrail scout [OPTIONS] [SCOPES]... DATASET

Options:

Name	Type	Description	Default
-v, --verbose	integer range (0 and above)	Verbosity: v=INFO, vv=DEBUG.	0
-q, --quiet	boolean	Set log level to ERROR.	False
--help	boolean	Show this message and exit.	False

datatrail version

Show versions.

Usage:

datatrail version [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False