fiftyone.core.cli.PluginsDownloadCommand

class documentation

class PluginsDownloadCommand(Command): (source)

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/<user>/<repo>
a GitHub ref like https://github.com/<user>/<repo>/tree/<branch> or https://github.com/<user>/<repo>/commit/<commit>
a GitHub ref string like <user>/<repo>[/<ref>]

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.

Examples:

# Download plugins from a GitHub repository URL
fiftyone plugins download <github-repo-url>

# Download plugins by specifying the GitHub repository details
fiftyone plugins download <user>/<repo>[/<ref>]

# Download specific plugins from a URL
fiftyone plugins download <url> --plugin-names <name1> <name2> <name3>

Static Method	`execute`	Executes the command on the given args.
Static Method	`setup`	Setup the command-line arguments for the command.

@staticmethod
def execute(parser, args): (source) ¶

overrides fiftyone.core.cli.Command.execute

Executes the command on the given args.

Parameters
parser	the `argparse.ArgumentParser` instance for the command
args	an `argparse.Namespace` instance containing the arguments for the command

@staticmethod
def setup(parser): (source) ¶

overrides fiftyone.core.cli.Command.setup

Setup the command-line arguments for the command.

Parameters
parser	an `argparse.ArgumentParser` instance