IDEAS CLI Reference¶
Command-line reference for ideas-python 1.2.0.
cli¶
A command-line interface to the IDEAS platform.
Usage:
cli [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
--debug Show debug info, for troubleshooting purposes.
--error-log-filepath FILE Where to log error messages, for support. If not
set, log will be placed in a temporary file
-e, --env TEXT Which environment to use. Use `environments` to
list supported environments
-c, --config FILE Read options from the specified configuration
file [default: (dynamic)]
-p, --profile PROFILE Which profile to use
--help Show this message and exit.
cli configure¶
Configure the CLI, including authentication and tenant selection.
Usage:
cli configure [OPTIONS]
Options:
-n, --non-interactive Open configuration in preferred editor
-p, --profile PROFILE Which configuration profile to edit
--help Show this message and exit.
cli containers¶
Commands for management of containers for tool execution.
Usage:
cli containers [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
cli containers download¶
Publish a local container to IDEAS container registry
Usage:
cli containers download [OPTIONS] NAME
Options:
--help Show this message and exit.
cli containers list¶
List all containers in IDEAS registry
Usage:
cli containers list [OPTIONS]
Options:
--filter KEY-VALUE OPTION Optional and repeatable filters. For example,
`--filter key=project-key --filter status=1`
--search SEARCH OPTION Will search for partial matches across some
fields for the supplied string.
--help Show this message and exit.
cli containers publish¶
Publish a local container to IDEAS container registry
Usage:
cli containers publish [OPTIONS] NAME
Options:
-t, --tenant-id TENANT-ID The tenant ID to use, use `ideas tenants` to view
a list
--description TEXT Short description of the image
--label TEXT Label of the image to assign on IDEAS. Must be
unique for the image namespace. If not specified,
defaults to the docker image id.
--namespace TEXT Namespace of the image to publish to in the IDEAS
registry. If not specified, defaults to the
namespace of the local image name.
--tag LIST OPTION Optional repeatable tags to assign to the image
in IDEAS
--readme FILE Long readme of contents and functionality of
image in markdown format.
--help Show this message and exit.
cli download¶
Download a file to local computer
Usage:
cli download [OPTIONS]
Options:
-t, --tenant-id TENANT-ID The tenant ID to use, use `ideas tenants` to
view a list
--file-id TEXT [required]
-f, --download-progress-filepath TEXT
-d, --download-dir DIRECTORY If specified, download the file to this
directory. Otherwise, downloads files to
current directory.
--no-verify Skips checksum verification
--help Show this message and exit.
cli environments¶
Display supported environments.
Usage:
cli environments [OPTIONS]
Options:
--help Show this message and exit.
cli files¶
Return a list of files.
Usage:
cli files [OPTIONS]
Options:
-t, --tenant-id TENANT-ID The tenant ID to use, use `ideas tenants` to view
a list
--filter KEY-VALUE OPTION Optional and repeatable filters. For example,
`--filter id=<UUID> --filter status=2`
--search SEARCH OPTION Will search for partial matches across some
fields for the supplied string.
--help Show this message and exit.
cli log¶
Open IDEAS log file
Usage:
cli log [OPTIONS]
Options:
-n, --non-interactive Runs command in non interactive mode (no prompts)
--help Show this message and exit.
cli projects¶
Return a list of all available projects.
Usage:
cli projects [OPTIONS]
Options:
--filter KEY-VALUE OPTION Optional and repeatable filters. For example,
`--filter key=project-key --filter status=1`
--search SEARCH OPTION Will search for partial matches across some
fields for the supplied string.
--show-all By default, we filter on available projects only;
this flag will return all projects instead
--help Show this message and exit.
cli tenants¶
Return a list of all tenants.
Usage:
cli tenants [OPTIONS]
Options:
--filter KEY-VALUE OPTION Optional and repeatable filters. For example,
`--filter id=1 --filter key=inscopix`
--search SEARCH OPTION Will search for partial matches across some
fields for the supplied string.
--help Show this message and exit.
cli tools¶
Commands for local tool execution.
Usage:
cli tools [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
cli tools bundle¶
Generate code bundle for uploading to IDEAS.
Usage:
cli tools bundle [OPTIONS]
Options:
-t, --tenant-id TENANT-ID The tenant ID to use, use `ideas tenants` to view
a list
-d, --code-dir DIRECTORY Directory that contains the code to bundle.
Defaults to current working directory
--skip-container-check Cleans previous output folders generated for tool
--skip-validation Ignores tool spec validation, for sharing a
bundle with a malformed tool spec with support
-o, --output-file FILE
-e, --exclude LIST OPTION Files or directories within code folder to
exclude from including in code bundle. Only
relative file patterns are supported
--no-default-excludes Skip default exclude patterns and don't respect
.gitignore patterns when choosing what to bundle.
Usually used in conjunction with --excludes-file
--excludes-file FILE File that contains patterns to ignore when
bundling files. Respects .gitignore pattern
formats.
-t, --tool LIST OPTION Specify which tools you want to bundle,
specifically. If omitted, all tools in the
specified code directory are bundled.
--help Show this message and exit.
cli tools configure¶
Configure tool for local execution.
Usage:
cli tools configure [OPTIONS] KEY
Options:
--file FILE The file containing the entry point of analysis
code to run for the tool. For python execution,
this is the python module containing the entry
point function to execute.
--function TEXT The entry point function within the specified
file to run for the tool.
--container CONTAINERIMAGE The container to run the local code within.
-d, --code-dir DIRECTORY The local code directory to run within, by
default the current directory.
-n, --non-interactive Runs command in non interactive mode (no
prompts)
--help Show this message and exit.
cli tools download¶
Download a bundle from a given tool version on IDEAS.
Usage:
cli tools download [OPTIONS] TOOL_VERSION_ID
Options:
-o, --output-file FILE
--help Show this message and exit.
cli tools extract¶
Extract code and metadata from a given bundle
Usage:
cli tools extract [OPTIONS] CBUNDLE
Options:
-o, --output-tar FILE Where to dump the code bundle tar file. If not
specified, only the metadata will be extracted.
--help Show this message and exit.
cli tools run¶
Run tool locally
Usage:
cli tools run [OPTIONS] KEY
Options:
--inputs FILE
-c, --clean Cleans previous output folders generated for tool
--code-dir DIRECTORY The local code directory to run within, by default
the current directory.
-n, --non-interactive Runs command in non interactive mode (no prompts)
-g, --gpus TEXT Enable gpu access to docker container. Value can
either be `all` indicating to use all gpus, or a
number indicating the amount of gpus required.
Uses nvidia gpu docker runtime.
--input KEY-VALUE OPTION Optionally override input parameters for the tool,
e.g., --input downsample_factor=2. Options
specified here take precedence over inputs file
values.
--help Show this message and exit.
cli upload¶
Upload a file to a specified project.
Usage:
cli upload [OPTIONS] [FILES]...
Options:
--project-id TEXT [required]
-t, --tenant-id TENANT-ID The tenant ID to use, use `ideas tenants` to
view a list
-f, --upload-progress-filepath TEXT
--metadata KEY-VALUE OPTION Optional and repeatable metadata. For
example, `--metadata
ideas.idas.filepath=/path/to/my/file.isxd`
--resume-file-id TEXT Will attempt to resume the upload using the
given file ID
-n, --upload-threads INTEGER RANGE
How many parallel threads to upload with.
Increases memory usage and upload
performance. Defaults to 5 x number of CPU
cores. [1<=x<=32]
--help Show this message and exit.