Command Line Interface¶

rcli¶

CLI admin tool for ReductStore

Usage:

rcli [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}/.reduct-cli/config.toml	None
`--timeout`, `-t`	integer	Timeout for requests in seconds. Default 5	None
`--parallel`, `-p`	integer	Number of parallel tasks to use, defaults to 10	None
`--help`	boolean	Show this message and exit.	`False`

rcli alias¶

Commands to manage aliases

Usage:

rcli alias [OPTIONS] COMMAND [ARGS]...

Options:

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

rcli alias add¶

Add a new alias with NAME

Usage:

rcli alias add [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--url`, `-L`	text	Server URL must be in format http(s)://example.com[:port]	None
`--token`, `-t`	text	API token	None
`--help`	boolean	Show this message and exit.	`False`

rcli alias ls¶

Print list of aliases

Usage:

rcli alias ls [OPTIONS]

Options:

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

rcli alias rm¶

Remove alias with NAME

Usage:

rcli alias rm [OPTIONS] NAME

Options:

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

rcli alias show¶

Show alias configuration

Usage:

rcli alias show [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--token`, `-t` / `--no-token`	boolean	Show token	`False`
`--help`	boolean	Show this message and exit.	`False`

rcli bucket¶

Commands to manage buckets

Usage:

rcli bucket [OPTIONS] COMMAND [ARGS]...

Options:

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

rcli bucket create¶

Create a new bucket

PATH should contain alias name and bucket name - ALIAS/BUCKET_NAME

Usage:

rcli bucket create [OPTIONS] PATH

Options:

Name	Type	Description	Default
`--quota-type`, `-Q`	text	Quota type. Must be NONE or FIFO	None
`--quota-size`, `-s`	text	Quota size in CI format e.g. 1Mb or 3TB	None
`--block-size`, `-b`	text	Max. bock size in CI format e.g 64MB	None
`--block-records`, `-R`	text	Max. number of records in a block	None
`--help`	boolean	Show this message and exit.	`False`

rcli bucket ls¶

List buckets

Usage:

rcli bucket ls [OPTIONS] ALIAS

Options:

Name	Type	Description	Default
`--full` / `--no-full`	boolean	Print full information	`False`
`--help`	boolean	Show this message and exit.	`False`

rcli bucket rm¶

Remove bucket

PATH should contain alias name and bucket name - ALIAS/BUCKET_NAME

Usage:

rcli bucket rm [OPTIONS] PATH

Options:

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

rcli bucket show¶

Show information about bucket

PATH should contain alias name and bucket name - ALIAS/BUCKET_NAME

Usage:

rcli bucket show [OPTIONS] PATH

Options:

Name	Type	Description	Default
`--full` / `--no-full`	boolean	Print full information	`False`
`--help`	boolean	Show this message and exit.	`False`

rcli bucket update¶

Update a bucket

PATH should contain alias name and bucket name - ALIAS/BUCKET_NAME

Usage:

rcli bucket update [OPTIONS] PATH

Options:

Name	Type	Description	Default
`--quota-type`, `-Q`	text	Quota type. Must be NONE or FIFO	None
`--quota-size`, `-s`	text	Quota size in CI format e.g. 1Mb or 3TB	None
`--block-size`, `-b`	text	Max. bock size in CI format e.g 64MB	None
`--block-records`, `-R`	text	Max. number of records in a block	None
`--help`	boolean	Show this message and exit.	`False`

rcli export¶

Export data from a bucket somewhere else

Usage:

rcli export [OPTIONS] COMMAND [ARGS]...

Options:

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

rcli export bucket¶

Copy data from SRC to DEST bucket

SRC and DST should be in the format of ALIAS/BUCKET_NAME

If the destination bucket doesn't exist, it is created with the settings of the source bucket.

Usage:

rcli export bucket [OPTIONS] SRC DEST

Options:

Name	Type	Description	Default
`--stop`	text	Export records with timestamps older than this time point in ISO format or Unix timestamp in microseconds	None
`--start`	text	Export records with timestamps newer than this time point in ISO format or Unix timestamp in microseconds	None
`--entries`	text	Export only these entries, separated by comma	``
`--include`	text	Export only these records which have these labels with given values, separated by comma. Example: --include label1=values1,label2=value2	``
`--exclude`	text	Export only these records which DON NOT have these labels with given values, separated by comma. Example: --exclude label1=values1,label2=value2	``
`--help`	boolean	Show this message and exit.	`False`

rcli export folder¶

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:

rcli export folder [OPTIONS] SRC DEST

Options:

Name	Type	Description	Default
`--stop`	text	Export records with timestamps older than this time point in ISO format or Unix timestamp in microseconds	None
`--start`	text	Export records with timestamps newer than this time point in ISO format or Unix timestamp in microseconds	None
`--entries`	text	Export only these entries, separated by comma	``
`--include`	text	Export only these records which have these labels with given values, separated by comma. Example: --include label1=values1,label2=value2	``
`--exclude`	text	Export only these records which DON NOT have these labels with given values, separated by comma. Example: --exclude label1=values1,label2=value2	``
`--ext`	text	Extension for exported files, if not specified, will be guessed from content type	None
`--with-metadata` / `--no-with-metadata`	boolean	Export metadata along with the data	`False`
`--help`	boolean	Show this message and exit.	`False`

rcli mirror¶

Copy data from ALIAS_SRC/BUCKET to ALIAS_DST/BUCKET DEPRECATED: Use export bucket instead

Usage:

rcli mirror [OPTIONS] SRC DEST

Options:

Name	Type	Description	Default
`--stop`	text	Export records with timestamps older than this time point in ISO format or Unix timestamp in microseconds	None
`--start`	text	Export records with timestamps newer than this time point in ISO format or Unix timestamp in microseconds	None
`--entries`	text	Export only these entries, separated by comma	``
`--help`	boolean	Show this message and exit.	`False`

rcli server¶

Commands to manage server

Usage:

rcli server [OPTIONS] COMMAND [ARGS]...

Options:

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

rcli server status¶

Connect to server with alias and print its status

Usage:

rcli server status [OPTIONS] ALIAS

Options:

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

rcli token¶

Commands to manage API tokens

Usage:

rcli token [OPTIONS] COMMAND [ARGS]...

Options:

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

rcli token create¶

Create token

Usage:

rcli token create [OPTIONS] ALIAS NAME

Options:

Name	Type	Description	Default
`--full-access`	boolean	Full access (admin)	`False`
`--read`	text	Read access to list of buckets. Example: 'bucket-1,bucket-2'	``
`--write`	text	Write access to list of buckets. Example: 'bucket-1,bucket-2'	``
`--help`	boolean	Show this message and exit.	`False`

rcli token ls¶

Print list of tokens

Usage:

rcli token ls [OPTIONS] ALIAS

Options:

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

rcli token rm¶

Remove token

Usage:

rcli token rm [OPTIONS] ALIAS NAME

Options:

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

rcli token show¶

Show token

Usage:

rcli token show [OPTIONS] ALIAS NAME

Options:

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