# FiftyOne Command-Line Interface (CLI) Installing FiftyOne automatically installs `fiftyone`, a command-line interface (CLI) for interacting with FiftyOne. This utility provides access to many useful features, including creating and inspecting datasets, visualizing datasets in the App, exporting datasets and converting dataset formats, and downloading datasets from the FiftyOne Dataset Zoo. ## Quickstart To see the available top-level commands, type: ```text fiftyone --help ``` You can learn more about any available subcommand via: ```text fiftyone --help ``` For example, to see your current FiftyOne config, you can execute `fiftyone config`. ### Tab completion To enable tab completion in `bash`, add the following line to your `~/.bashrc`: ```shell eval "$(register-python-argcomplete fiftyone)" ``` To enable tab completion in `zsh`, add these lines to your `~/.zshrc`: ```shell autoload bashcompinit bashcompinit eval "$(register-python-argcomplete fiftyone)" ``` To enable tab completion in `tcsh`, add these lines to your `~/.tcshrc`: ```shell eval `register-python-argcomplete --shell tcsh fiftyone` ``` ## FiftyOne CLI The FiftyOne command-line interface. ```text fiftyone [-h] [-v] [--all-help] {quickstart,annotation,brain,evaluation,app,config,constants,convert,datasets,migrate,operators,skills,delegated,plugins,utils,zoo,labs} ... ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit -v, --version show version info --all-help show help recursively and exit available commands: {quickstart,annotation,brain,evaluation,app,config,constants,convert,datasets,migrate,operators,skills,delegated,plugins,utils,zoo,labs} quickstart Launch a FiftyOne quickstart. annotation Tools for working with the FiftyOne annotation API. brain Tools for working with the FiftyOne Brain. evaluation Tools for working with the FiftyOne evaluation API. app Tools for working with the FiftyOne App. config Tools for working with your FiftyOne config. constants Print constants from `fiftyone.constants`. convert Convert datasets on disk between supported formats. datasets Tools for working with FiftyOne datasets. migrate Tools for migrating the FiftyOne database. operators Tools for working with FiftyOne operators and panels. skills Tools for working with FiftyOne skills. delegated Tools for working with FiftyOne delegated operations. plugins Tools for working with FiftyOne plugins. utils FiftyOne utilities. zoo Tools for working with the FiftyOne Zoo. labs Tools for working with FiftyOne Labs. ``` ## FiftyOne quickstart
Available in: Open SourceEnterprise
Introduced in FiftyOne 0.5.2 · FiftyOne Enterprise 1.0
Launch a FiftyOne quickstart. ```text fiftyone quickstart [-h] [-v] [-p PORT] [-A ADDRESS] [-r] [-a] [-w WAIT] ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit -v, --video launch the quickstart with a video dataset -p PORT, --port PORT the port number to use -A ADDRESS, --address ADDRESS the address (server name) to use -r, --remote whether to launch a remote App session -w WAIT, --wait WAIT the number of seconds to wait for a new App connection before returning if all connections are lost. If negative, the process will wait forever, regardless of connections ``` **Examples** ```shell # Launch the quickstart fiftyone quickstart ``` ```shell # Launch the quickstart with a video dataset fiftyone quickstart --video ``` ```shell # Launch the quickstart as a remote session fiftyone quickstart --remote ``` ## FiftyOne config Tools for working with your FiftyOne config. ```text fiftyone config [-h] [-l] [FIELD] ``` **Arguments** ```text positional arguments: FIELD a config field to print optional arguments: -h, --help show this help message and exit -l, --locate print the location of your config on disk ``` **Examples** ```shell # Print your entire config fiftyone config ``` ```shell # Print a specific config field fiftyone config ``` ```shell # Print the location of your config on disk (if one exists) fiftyone config --locate ``` ## Print constants Print constants from `fiftyone.constants`. ```text fiftyone constants [-h] [CONSTANT] ``` **Arguments** ```text positional arguments: CONSTANT the constant to print optional arguments: -h, --help show this help message and exit ``` **Examples** ```shell # Print all constants fiftyone constants ``` ```shell # Print a specific constant fiftyone constants ``` ## Convert dataset formats Convert datasets on disk between supported formats. ```text fiftyone convert [-h] --input-type INPUT_TYPE --output-type OUTPUT_TYPE [--input-dir INPUT_DIR] [--input-kwargs KEY=VAL [KEY=VAL ...]] [--output-dir OUTPUT_DIR] [--output-kwargs KEY=VAL [KEY=VAL ...]] [-o] ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit --input-dir INPUT_DIR the directory containing the dataset --input-kwargs KEY=VAL [KEY=VAL ...] additional keyword arguments for `fiftyone.utils.data.convert_dataset(..., input_kwargs=)` --output-dir OUTPUT_DIR the directory to which to write the output dataset --output-kwargs KEY=VAL [KEY=VAL ...] additional keyword arguments for `fiftyone.utils.data.convert_dataset(..., output_kwargs=)` -o, --overwrite whether to overwrite an existing output directory required arguments: --input-type INPUT_TYPE the fiftyone.types.Dataset type of the input dataset --output-type OUTPUT_TYPE the fiftyone.types.Dataset type to output ``` **Examples** ```shell # Convert an image classification directory tree to TFRecords format fiftyone convert \ --input-dir /path/to/image-classification-directory-tree \ --input-type fiftyone.types.ImageClassificationDirectoryTree \ --output-dir /path/for/tf-image-classification-dataset \ --output-type fiftyone.types.TFImageClassificationDataset ``` ```shell # Convert a COCO detection dataset to CVAT image format fiftyone convert \ --input-dir /path/to/coco-detection-dataset \ --input-type fiftyone.types.COCODetectionDataset \ --output-dir /path/for/cvat-image-dataset \ --output-type fiftyone.types.CVATImageDataset ``` ```shell # Perform a customized conversion via optional kwargs fiftyone convert \ --input-dir /path/to/coco-detection-dataset \ --input-type fiftyone.types.COCODetectionDataset \ --input-kwargs max_samples=100 shuffle=True \ --output-dir /path/for/cvat-image-dataset \ --output-type fiftyone.types.TFObjectDetectionDataset \ --output-kwargs force_rgb=True \ --overwrite ``` ## FiftyOne datasets Tools for working with FiftyOne datasets. ```text fiftyone datasets [-h] [--all-help] {list,info,create,head,tail,stream,export,delete} ... ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit --all-help show help recursively and exit available commands: {list,info,create,head,tail,stream,export,delete} list List FiftyOne datasets. info Print information about FiftyOne datasets. stats Print stats about FiftyOne datasets on disk. create Tools for creating FiftyOne datasets. head Prints the first few samples in a FiftyOne dataset. tail Prints the last few samples in a FiftyOne dataset. stream Streams the samples in a FiftyOne dataset. export Export FiftyOne datasets to disk in supported formats. draw Writes annotated versions of samples in FiftyOne datasets to disk. rename Rename FiftyOne datasets. delete Delete FiftyOne datasets. ``` ### List datasets List FiftyOne datasets. ```text fiftyone datasets list [-h] [-p PATT] [-t TAG [TAG ...]] ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit -p PATT, --glob-patt PATT an optional glob pattern of dataset names to include -t TAG [TAG ...], --tags TAG [TAG ...] only show datasets with the given tag(s) ``` **Examples** ```shell # List available datasets fiftyone datasets list ``` ```shell # List datasets matching a given pattern fiftyone datasets list --glob-patt 'quickstart-*' ``` ```shell # List datasets with the given tag(s) fiftyone datasets list --tags automotive healthcare ``` ### Print dataset information Print information about FiftyOne datasets. ```text fiftyone datasets info [-h] [-p PATT] [-t TAG [TAG ...]] [-s FIELD] [-r] [NAME] ``` **Arguments** ```text positional arguments: NAME the name of a dataset optional arguments: -h, --help show this help message and exit -p PATT, --glob-patt PATT an optional glob pattern of dataset names to include -t TAG [TAG ...], --tags TAG [TAG ...] only show datasets with the given tag(s) -s FIELD, --sort-by FIELD a field to sort the dataset rows by -r, --reverse whether to print the results in reverse order ``` **Examples** ```shell # Print basic information about multiple datasets fiftyone datasets info fiftyone datasets info --glob-patt 'quickstart-*' fiftyone datasets info --tags automotive healthcare fiftyone datasets info --sort-by created_at fiftyone datasets info --sort-by name --reverse ``` ```shell # Print information about a specific dataset fiftyone datasets info ``` ### Print dataset stats
Available in: Open SourceEnterprise
Introduced in FiftyOne 0.7.4 · FiftyOne Enterprise 1.0
Print stats about FiftyOne datasets on disk. ```text fiftyone datasets stats [-h] [-m] [-c] NAME ``` **Arguments** ```text positional arguments: NAME the name of the dataset optional arguments: -h, --help show this help message and exit -m, --include-media whether to include stats about the size of the raw media in the dataset -c, --compressed whether to return the sizes of collections in their compressed form on disk ``` **Examples** ```shell # Print stats about the given dataset on disk fiftyone datasets stats ``` ### Create datasets Tools for creating FiftyOne datasets. ```text fiftyone datasets create [-h] [-n NAME] [-d DATASET_DIR] [-j JSON_PATH] [-t TYPE] [-k KEY=VAL [KEY=VAL ...]] ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit -n NAME, --name NAME a name for the dataset -d DATASET_DIR, --dataset-dir DATASET_DIR the directory containing the dataset -j JSON_PATH, --json-path JSON_PATH the path to a samples JSON file to load -t TYPE, --type TYPE the fiftyone.types.Dataset type of the dataset -k KEY=VAL [KEY=VAL ...], --kwargs KEY=VAL [KEY=VAL ...] additional type-specific keyword arguments for `fiftyone.core.dataset.Dataset.from_dir()` ``` **Examples** ```shell # Create a dataset from the given data on disk fiftyone datasets create \ --name --dataset-dir --type ``` ```shell # Create a dataset from a random subset of the data on disk fiftyone datasets create \ --name --dataset-dir --type \ --kwargs max_samples=50 shuffle=True ``` ```shell # Create a dataset from the given samples JSON file fiftyone datasets create --json-path ``` ### Print dataset head Prints the first few samples in a FiftyOne dataset. ```text fiftyone datasets head [-h] [-n NUM_SAMPLES] NAME ``` **Arguments** ```text positional arguments: NAME the name of the dataset optional arguments: -h, --help show this help message and exit -n NUM_SAMPLES, --num-samples NUM_SAMPLES the number of samples to print ``` **Examples** ```shell # Prints the first few samples in a dataset fiftyone datasets head ``` ```shell # Prints the given number of samples from the head of a dataset fiftyone datasets head --num-samples ``` ### Print dataset tail Prints the last few samples in a FiftyOne dataset. ```text fiftyone datasets tail [-h] [-n NUM_SAMPLES] NAME ``` **Arguments** ```text positional arguments: NAME the name of the dataset optional arguments: -h, --help show this help message and exit -n NUM_SAMPLES, --num-samples NUM_SAMPLES the number of samples to print ``` **Examples** ```shell # Print the last few samples in a dataset fiftyone datasets tail ``` ```shell # Print the given number of samples from the tail of a dataset fiftyone datasets tail --num-samples ``` ### Stream samples to the terminal Stream samples in a FiftyOne dataset to the terminal. ```text fiftyone datasets stream [-h] NAME ``` **Arguments** ```text positional arguments: NAME the name of the dataset optional arguments: -h, --help show this help message and exit ``` **Examples** ```shell # Stream the samples of the dataset to the terminal fiftyone datasets stream ``` ### Export datasets Export FiftyOne datasets to disk in supported formats. ```text fiftyone datasets export [-h] [-d EXPORT_DIR] [-j JSON_PATH] [-f LABEL_FIELD] [-t TYPE] [--filters KEY=VAL [KEY=VAL ...]] [-k KEY=VAL [KEY=VAL ...]] NAME ``` **Arguments** ```text positional arguments: NAME the name of the dataset to export optional arguments: -h, --help show this help message and exit -d EXPORT_DIR, --export-dir EXPORT_DIR the directory in which to export the dataset -j JSON_PATH, --json-path JSON_PATH the path to export the dataset in JSON format -f LABEL_FIELD, --label-field LABEL_FIELD the name of the label field to export -t TYPE, --type TYPE the fiftyone.types.Dataset type in which to export --filters KEY=VAL [KEY=VAL ...] specific sample tags or class labels to export. To use sample tags, pass tags as `tags=train,val` and to use label filters, pass label field and values as in ground_truth=car,person,dog -k KEY=VAL [KEY=VAL ...], --kwargs KEY=VAL [KEY=VAL ...] additional type-specific keyword arguments for `fiftyone.core.collections.SampleCollection.export()` ``` **Examples** ```shell # Export the dataset to disk in the specified format fiftyone datasets export \ --export-dir --type --label-field ``` ```shell # Export the dataset to disk in JSON format fiftyone datasets export --json-path ``` ```shell # Only export cats and dogs from the validation split fiftyone datasets export \\ --filters tags=validation ground_truth=cat,dog \\ --export-dir --type --label-field ground_truth ``` ```shell # Perform a customized export of a dataset fiftyone datasets export \ --type \ --kwargs labels_path=/path/for/labels.json ``` ### Drawing labels on samples Renders annotated versions of samples in FiftyOne datasets to disk. ```text fiftyone datasets draw [-h] [-d OUTPUT_DIR] [-f LABEL_FIELDS] NAME ``` **Arguments** ```text positional arguments: NAME the name of the dataset optional arguments: -h, --help show this help message and exit -d OUTPUT_DIR, --output-dir OUTPUT_DIR the directory to write the annotated media -f LABEL_FIELDS, --label-fields LABEL_FIELDS a comma-separated list of label fields to export ``` **Examples** ```shell # Write annotated versions of the media in the dataset with the # specified label field(s) overlaid to disk fiftyone datasets draw \ --output-dir --label-fields ,, ``` ### Rename datasets Rename FiftyOne datasets. ```text fiftyone datasets rename [-h] NAME NEW_NAME ``` **Arguments** ```text positional arguments: NAME the name of the dataset NEW_NAME a new name for the dataset optional arguments: -h, --help show this help message and exit ``` **Examples** ```shell # Rename the dataset fiftyone datasets rename ``` ### Delete datasets Delete FiftyOne datasets. ```text fiftyone datasets delete [-h] [-g GLOB_PATT] [--non-persistent] [NAME [NAME ...]] ``` **Arguments** ```text positional arguments: NAME the dataset name(s) to delete optional arguments: -h, --help show this help message and exit -g GLOB_PATT, --glob-patt GLOB_PATT a glob pattern of datasets to delete --non-persistent delete all non-persistent datasets ``` **Examples** ```shell # Delete the datasets with the given name(s) fiftyone datasets delete ... ``` ```shell # Delete the datasets whose names match the given glob pattern fiftyone datasets delete --glob-patt ``` ```shell # Delete all non-persistent datasets fiftyone datasets delete --non-persistent ``` ## FiftyOne migrations Tools for migrating the FiftyOne database. See [this page](../user_guide/config.md#database-migrations) for more information about migrating FiftyOne deployments. ```text fiftyone migrate [-h] [-i] [-a] [-v VERSION] [-n DATASET_NAME [DATASET_NAME ...]] [--error-level LEVEL] [--verbose] ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit -i, --info whether to print info about the current revisions -a, --all whether to migrate the database and all datasets -v VERSION, --version VERSION the revision to migrate to -n DATASET_NAME [DATASET_NAME ...], --dataset-name DATASET_NAME [DATASET_NAME ...] the name of a specific dataset to migrate --error-level LEVEL the error level (0=error, 1=warn, 2=ignore) to use when migrating individual datasets --verbose whether to log incremental migrations that are performed ``` **Examples** ```shell # Print information about the current revisions of all datasets fiftyone migrate --info ``` ```shell # Migrate the database and all datasets to the current client version fiftyone migrate --all ``` ```shell # Migrate to a specific revision fiftyone migrate --all --version ``` ```shell # Migrate a specific dataset fiftyone migrate ... --dataset-name ``` ```shell # Update the database version without migrating any existing datasets fiftyone migrate ``` ## FiftyOne operators Tools for working with FiftyOne operators and panels. ```text fiftyone operators [-h] [--all-help] {list,info} ... ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit --all-help show help recursively and exit available commands: {list,info} list List operators and panels that are installed locally. info Prints information about operators and panels that are installed locally. ``` ### List operators List operators and panels that are installed locally. ```text fiftyone operators list [-h] [-g PATT] [-e] [-d] [-b] [-c] [-o] [-p] [-n] [-u] ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit -g PATT, --glob-patt PATT only show operators whose URI matches the glob pattern -e, --enabled only show enabled operators and panels -d, --disabled only show disabled operators and panels -b, --builtins-only only show builtin operators and panels -c, --no-builtins only show non-builtin operators and panels -o, --operators-only only show operators -p, --panels-only only show panels -n, --names-only only show names -u, --include-unlisted include unlisted operators ``` **Examples** ```shell # List all available operators and panels fiftyone operators list ``` ```shell # List operators and panels whose URI matches the given glob pattern fiftyone operators list --glob-patt '*/compute_*' ``` ```shell # List enabled operators and panels fiftyone operators list --enabled ``` ```shell # List disabled operators and panels fiftyone operators list --disabled ``` ```shell # List non-builtin operators and panels fiftyone operators list --no-builtins ``` ```shell # List panels fiftyone operators list --panels-only ``` ### Operator info Prints information about operators and panels that are installed locally. ```text fiftyone operators info [-h] URI ``` **Arguments** ```text positional arguments: URI the operator or panel URI optional arguments: -h, --help show this help message and exit ``` **Examples** ```shell # Prints information about an operator or panel fiftyone operators info ``` ## FiftyOne skills Tools for working with FiftyOne skills. ```text fiftyone skills [-h] [--all-help] {list} ... ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit --all-help show help recursively and exit available commands: {list} list List skills provided by installed plugins. ``` ### List skills List skills provided by installed plugins. ```text fiftyone skills list [-h] [-p PLUGIN [PLUGIN ...]] [-c CATEGORY [CATEGORY ...]] [-e] [-d] [-n] ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit -p PLUGIN [PLUGIN ...], --plugin PLUGIN [PLUGIN ...] only show skills from this plugin(s) -c CATEGORY [CATEGORY ...], --category CATEGORY [CATEGORY ...] only show skills in this category(s) -e, --enabled only show skills from enabled plugins -d, --disabled only show skills from disabled plugins -n, --names-only only show names ``` **Examples** ```shell # List all available skills fiftyone skills list ``` ```shell # List skills from a specific plugin fiftyone skills list --plugin @voxel51/my-plugin ``` ```shell # List skills in a specific category fiftyone skills list --category data-ingestion ``` ```shell # List enabled skills fiftyone skills list --enabled ``` ```shell # List skill names only fiftyone skills list --names-only ``` ## FiftyOne delegated operations Tools for working with FiftyOne delegated operations. ```text fiftyone delegated [-h] [--all-help] {launch,list,info,output,fail,delete,cleanup} ... ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit --all-help show help recursively and exit available commands: {launch,list,info,output,fail,delete,cleanup} launch Launches a service for running delegated operations. list List delegated operations. info Prints information about a delegated operation. output Prints the output for a delegated operation. fail Manually mark delegated as failed. delete Delete delegated operations. cleanup Cleanup delegated operations. ``` ### Launch delegated service Launches a service for running delegated operations. ```text fiftyone delegated launch [-h] [-t TYPE] ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit -t TYPE, --type TYPE the type of service to launch. The default is 'local' ``` **Examples** ```shell # Launch a local service fiftyone delegated launch ``` ### List delegated operations List delegated operations. ```text fiftyone delegated list [-h] [-o OPERATOR] [-d DATASET] [-m MATCH] [-s STATE] [--sort-by SORT_BY] [--reverse] [-l LIMIT] ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit -o OPERATOR, --operator OPERATOR only list operations for this operator -d DATASET, --dataset DATASET only list operations for this dataset -m MATCH, --match MATCH only list operations whose operator or label contain this string -s STATE, --state STATE only list operations with this state. Supported values are ('SCHEDULED', 'QUEUED', 'RUNNING', 'COMPLETED', 'FAILED') --sort-by SORT_BY how to sort the operations. Supported values are ('SCHEDULED_AT', 'QUEUED_AT', 'STARTED_AT', 'COMPLETED_AT', 'FAILED_AT', 'OPERATOR', 'LABEL') --reverse whether to sort in reverse order -l LIMIT, --limit LIMIT a maximum number of operations to show ``` **Examples** ```shell # List all delegated operations fiftyone delegated list ``` ```shell # List some specific delegated operations fiftyone delegated list \ --dataset quickstart \ --operator @voxel51/io/export_samples \ --state COMPLETED \ --sort-by COMPLETED_AT \ --limit 10 ``` ### Delegated operation info Prints information about a delegated operation. ```text fiftyone delegated info [-h] ID ``` **Arguments** ```text positional arguments: ID the operation ID optional arguments: -h, --help show this help message and exit ``` **Examples** ```shell # Print information about a delegated operation fiftyone delegated info ``` ### Delegated operation output Prints the output for a delegated operation. ```text fiftyone delegated output [-h] ID ``` **Arguments** ```text positional arguments: ID the operation ID optional arguments: -h, --help show this help message and exit ``` **Examples** ```shell # Print the output for a delegated operation fiftyone delegated output ``` ### Mark delegated operations as failed Manually mark delegated operations as failed. ```text fiftyone delegated fail [-h] [IDS ...] ``` **Arguments** ```text positional arguments: IDS an operation ID or list of operation IDs optional arguments: -h, --help show this help message and exit ``` **Examples** ```shell # Manually mark the specified operation(s) as FAILED fiftyone delegated fail ... ``` ### Delete delegated operations Delete delegated operations. ```text fiftyone delegated delete [-h] [IDS ...] ``` **Arguments** ```text positional arguments: IDS an operation ID or list of operation IDs optional arguments: -h, --help show this help message and exit ``` **Examples** ```shell # Delete the specified operation(s) fiftyone delegated delete ... ``` ### Cleanup delegated operations Cleanup delegated operations. ```text fiftyone delegated cleanup [-h] [-o OPERATOR] [-d DATASET] [-s STATE] [--orphan] [--dry-run] ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit -o OPERATOR, --operator OPERATOR cleanup operations for this operator -d DATASET, --dataset DATASET cleanup operations for this dataset -s STATE, --state STATE delete operations in this state. Supported values are ('QUEUED', 'COMPLETED', 'FAILED') --orphan delete all operations associated with non-existent datasets --dry-run whether to print information rather than actually deleting operations ``` **Examples** ```shell # Delete all failed operations associated with a given dataset fiftyone delegated cleanup --dataset quickstart --state FAILED ``` ```shell # Delete all delegated operations associated with non-existent datasets fiftyone delegated cleanup --orphan ``` ```shell # Print information about operations rather than actually deleting them fiftyone delegated cleanup --orphan --dry-run ``` ## FiftyOne plugins Tools for working with FiftyOne plugins. ```text fiftyone plugins [-h] [--all-help] {list,info,download,requirements,create,enable,disable,delete} ... ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit --all-help show help recursively and exit available commands: {list,info,download,search,requirements,create,enable,disable,delete} list List plugins that are installed locally. info Prints information about plugins that are installed locally. download Download plugins from the web. search Search for available plugins in a GitHub repository. requirements Handles package requirements for plugins. create Creates or initializes a plugin. enable Enables the given plugin(s). disable Disables the given plugin(s). delete Delete plugins from your local machine. ``` ### List plugins List plugins that are installed locally. ```text fiftyone plugins list [-h] [-g PATT] [-t TAGS [TAGS ...]] [-e] [-d] [-b] [-c] [-n] ``` **Arguments** ```text optional arguments: -h, --help show this help message and exit -g PATT, --glob-patt PATT only show plugins whose name matches the glob pattern -t TAGS [TAGS ...], --tags TAGS [TAGS ...] only show plugins with the specified tag(s) -e, --enabled only show enabled plugins -d, --disabled only show disabled plugins -b, --builtins-only only show builtin plugins -c, --no-builtins only show non-builtin plugins -n, --names-only only show names ``` **Examples** ```shell # List all available plugins fiftyone plugins list ``` ```shell # List plugins whose name matches the given glob pattern fiftyone plugins list --glob-patt '@voxel51/*' ``` ```shell # List plugins with the given tag fiftyone plugins list --tags ``` ```shell # List enabled plugins fiftyone plugins list --enabled ``` ```shell # List disabled plugins fiftyone plugins list --disabled ``` ```shell # List non-builtin plugins fiftyone plugins list --no-builtins ``` ### Plugin info List plugins that are installed locally. ```text fiftyone plugins info [-h] NAME_OR_DIR ``` **Arguments** ```text positional arguments: NAME_OR_DIR the plugin name or directory optional arguments: -h, --help show this help message and exit ``` **Examples** ```shell # Prints information about a plugin fiftyone plugins info # Prints information about a plugin in a given directory fiftyone plugins info ``` ### Download plugins Download plugins from the web. When downloading plugins from GitHub, you can provide any of the following formats: - a GitHub repo URL like `https://github.com//` - a GitHub ref like `https://github.com///tree/` or `https://github.com///commit/` - a GitHub ref string like `/[/]` #### NOTE To download from a private GitHub repository that you have access to, provide your GitHub personal access token by setting the `GITHUB_TOKEN` environment variable. ```text fiftyone plugins download [-h] [-n [PLUGIN_NAMES ...]] [-o] URL_OR_GH_REPO ``` **Arguments** ```text positional arguments: URL_OR_GH_REPO A URL or /[/] of a GitHub repository optional arguments: -h, --help show this help message and exit -n [PLUGIN_NAMES ...], --plugin-names [PLUGIN_NAMES ...] a plugin name or list of plugin names to download -o, --overwrite whether to overwrite existing plugins ``` **Examples** ```shell # Download plugins from a GitHub repository URL fiftyone plugins download ``` ```shell # Download plugins by specifying the GitHub repository details fiftyone plugins download /[/] ``` ```shell # Download specific plugins from a URL fiftyone plugins download --plugin-names ``` ### Search plugins Search for available plugins in a GitHub repository. When searching for plugins, you can provide any of the following formats: - a GitHub repo URL like `https://github.com//` - a GitHub ref like `https://github.com///tree/` or `https://github.com///commit/` - a GitHub ref string like `/[/]` #### NOTE To read from a private GitHub repository that you have access to, provide your GitHub personal access token by setting the `GITHUB_TOKEN` environment variable. ```text fiftyone plugins search [-h] [--path PATH] URL_OR_GH_REPO ``` **Arguments** ```text positional arguments: URL_OR_GH_REPO A URL or /[/] of a GitHub repository optional arguments: -h, --help show this help message and exit --path PATH path inside the GitHub repository for plugins search ``` **Examples** ```shell # Search for plugins by specifying a GitHub repository URL fiftyone plugins search ``` ```shell # Search for plugins by specifying the GitHub repository details fiftyone plugins search /[/] ``` ```shell # Search for plugins by specifying a path inside the repository fiftyone plugins search --path path/to/dir fiftyone plugins search /[/] --path path/to/dir ``` ### Plugin requirements Handles package requirements for plugins. ```text fiftyone plugins requirements [-h] [-p] [-i] [-e] [--error-level LEVEL] NAME ``` **Arguments** ```text positional arguments: NAME the plugin name optional arguments: -h, --help show this help message and exit -p, --print print the requirements for the plugin -i, --install install any requirements for the plugin -e, --ensure ensure the requirements for the plugin are satisfied --error-level LEVEL the error level (0=error, 1=warn, 2=ignore) to use when installing or ensuring plugin requirements ``` **Examples** ```shell # Print requirements for a plugin fiftyone plugins requirements --print ``` ```shell # Install any requirements for the plugin fiftyone plugins requirements --install ``` ```shell # Ensures that the requirements for the plugin are satisfied fiftyone plugins requirements --ensure ``` ### Create plugins Creates or initializes a plugin. ```text fiftyone plugins create [-h] [-f [FILES ...]] [-d OUTDIR] [--label LABEL] [--description DESCRIPTION] [--version VERSION] [-o] [--kwargs KEY=VAL [KEY=VAL ...]] [NAME ...] ``` **Arguments** ```text positional arguments: NAME the plugin name(s) optional arguments: -h, --help show this help message and exit -f [FILES ...], --from-files [FILES ...] a directory or list of explicit filepaths to include in the plugin -d OUTDIR, --outdir OUTDIR a directory in which to create the plugin --label LABEL a display name for the plugin --description DESCRIPTION a description for the plugin --version VERSION an optional FiftyOne version requirement for the plugin -o, --overwrite whether to overwrite existing plugins --kwargs KEY=VAL [KEY=VAL ...] additional keyword arguments to include in the plugin definition ``` **Examples** ```text # Initialize a new plugin fiftyone plugins create ``` ```shell # Create a plugin from existing files fiftyone plugins create \ \ --from-files /path/to/dir \ --label