Command-line Reference¶
valohai-cli
is a command-line tool to manage your Valohai experiments and installations.
This reference guide gives you an overview of the command available in the client, and you can dive
deeper by with vh --help
or adding the --help
to any of the commands.
More information about the specific commands:
vh¶
- type ctx
click.Context
vh [OPTIONS] COMMAND [ARGS]...
Options
-
--debug
,
--no-debug
¶
Enable debug logging.
-
--output-format
,
--table-format
<output_format>
¶ Set the output format for various data.
- Options
human | csv | tsv | scsv | psv | json
-
--valohai-host
<URL>
¶ Override the Valohai API host (default https://app.valohai.com/)
-
--valohai-token
<SECRET>
¶ Use this Valohai authentication token
-
--project
<project_id>
¶ (Advanced) Override the project ID
-
--project-mode
<local|remote>
¶ (Advanced) When using –project, set the project mode
-
--project-root
<DIR>
¶ (Advanced) When using –project, set the project root directory
Environment variables
-
VALOHAI_DEBUG
Provide a default for
--debug
-
('VALOHAI_TABLE_FORMAT', 'VALOHAI_OUTPUT_FORMAT')
Provide a default for
--output-format
-
VALOHAI_HOST
Provide a default for
--valohai-host
-
VALOHAI_TOKEN
Provide a default for
--valohai-token
-
VALOHAI_PROJECT
Provide a default for
--project
-
VALOHAI_PROJECT_MODE
Provide a default for
--project-mode
-
VALOHAI_PROJECT_ROOT
Provide a default for
--project-root
Commands
-
environments
List all available execution environments.
-
execution
Execution-related commands.
-
init
Interactively initialize a Valohai project.
-
lint
Lint (syntax-check) a valohai.yaml file.
-
login
Log in into Valohai.
-
logout
Remove local authentication token.
-
parcel
-
pipeline
Pipeline-related commands.
-
project
Project-related commands.
-
update-check
-
yaml
YAML-related commands.