CLI#
fx#
Framex CLI 1.0.3
usage: fx [-h] [--version] {get,bring,about,list,show,describe} ...
- -h, --help#
show this help message and exit
- --version, -v#
Show version
fx about#
usage: fx about [-h] datasets [datasets ...]
- datasets#
Info about dataset(s)
- -h, --help#
show this help message and exit
fx bring#
usage: fx bring [-h] [--dir DIR] [--format FORMAT] [--overwrite]
datasets [datasets ...]
- datasets#
Dataset name(s), accepts multiple names
- -h, --help#
show this help message and exit
- --dir <dir>, -d <dir>#
Directory to save the dataset to. Defaults to current directory.
- --format <format>, -f <format>#
Format (feather, parquet, csv, json, ipc) to save the dataset in. Defaults to csv.
- --overwrite, -o#
Overwrite an existing dataset with the same name.
fx describe#
usage: fx describe [-h] dataset
- dataset#
Dataset name
- -h, --help#
show this help message and exit
fx get#
usage: fx get [-h] [--dir DIR] [--format FORMAT] [--overwrite] [--cache]
datasets [datasets ...]
- datasets#
Dataset name(s), accepts multiple names
- -h, --help#
show this help message and exit
- --dir <dir>, -d <dir>#
Directory to save the dataset to. Defaults to current directory.
- --format <format>, -f <format>#
Format (feather, parquet, csv, json, ipc) to save the dataset in. Defaults to csv.
- --overwrite, -o#
Whether to overwrite the dataset if it already exists.
- --cache, -c#
Whether to save to the local cache directory.
fx list#
usage: fx list [-h] [--local | --remote | --all] [includes]
- includes#
available datasets names which includes the given string.
- -h, --help#
show this help message and exit
- --local, -l#
List local datasets.
- --remote, -r#
List remote datasets.
- --all, -a#
List all datasets (both local and remote).
fx show#
usage: fx show [-h] dataset
- dataset#
Dataset name
- -h, --help#
show this help message and exit