CLI Documentation
adviser
Adviser CLI
Synopsis
Command line interface for the Adviser platform
Options
aisuggest
Suggest infrastructure based on workdir analysis
Synopsis
Analyze the workdir and suggest appropriate infrastructure for running tasks. You can specify a preferred cloud provider using the --cloud flag (aws, azure, gcp).
Options
billing
Commands related to billing
Synopsis
Commands for managing payment methods and billing information
Options
billing create
Create a payment method
Synopsis
Add a new payment method to your account
Options
cli
CLI-related commands
Synopsis
Commands related to the CLI itself, such as version, platform info, and updating
Options
cli docs
Generate documentation for all commands in Markdown format
Synopsis
Generate comprehensive documentation for all commands and subcommands in Markdown format
Options
cli info
Adviser compiled for/running on.
Synopsis
Info including platform (eg Mac/ARM64, Windows/AMD64) the binary was compiled for and is running on, version, and other info we deem useful.
Options
cli update
Update the CLI to the latest version
Synopsis
Downloads and installs the latest version of the Adviser CLI
Options
cluster
Commands related to clusters
Synopsis
Commands for creating, listing, and deleting clusters
Options
cluster create
Create a cluster
Synopsis
Create a new cluster on the specified Cloud, Region, with optional workdir and setup commands to help configure the cluster
Options
cluster delete
Delete a cluster
Synopsis
Delete a cluster by ID
Options
cluster list
List clusters
Synopsis
List all clusters, optionally including deleted/used ones
Options
completion
Generate the autocompletion script for the specified shell
Synopsis
Generate the autocompletion script for adviser for the specified shell. See each sub-command's help for details on how to use the generated script.
Options
completion bash
Generate the autocompletion script for bash
Synopsis
Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package. If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
To load completions for every new session, execute once:
Linux:
macOS:
You will need to start a new shell for this setup to take effect.
Options
completion fish
Generate the autocompletion script for fish
Synopsis
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
To load completions for every new session, execute once:
You will need to start a new shell for this setup to take effect.
Options
completion powershell
Generate the autocompletion script for powershell
Synopsis
Generate the autocompletion script for powershell.
To load completions in your current shell session:
To load completions for every new session, add the output of the above command to your powershell profile.
Options
completion zsh
Generate the autocompletion script for zsh
Synopsis
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
To load completions in your current shell session:
To load completions for every new session, execute once:
Linux:
adviser completion zsh > "${fpath[1]macOS:
You will need to start a new shell for this setup to take effect.
Options
invite
Invite users to your organization
Synopsis
Invite new users to join your organization on the Adviser platform
Options
job
Commands related to jobs
Synopsis
Commands for listing and downloading jobs
Options
job download
Download job results
Synopsis
Download results from a completed job
Options
job list
List jobs
Synopsis
List all jobs
Options
login
Log in to Adviser
Synopsis
Log in to the Adviser platform with your credentials
Options
run
Run a job
Synopsis
Run a job on an available cluster
Options
signup
Sign up for an Adviser account
Synopsis
Create a new user account on the Adviser platform
Options
CLI Documentation
adviser
Adviser CLI
Synopsis
Command line interface for the Adviser platform
Options
aisuggest
Suggest infrastructure based on workdir analysis
Synopsis
Analyze the workdir and suggest appropriate infrastructure for running tasks. You can specify a preferred cloud provider using the --cloud flag (aws, azure, gcp).
Options
billing
Commands related to billing
Synopsis
Commands for managing payment methods and billing information
Options
billing create
Create a payment method
Synopsis
Add a new payment method to your account
Options
cli
CLI-related commands
Synopsis
Commands related to the CLI itself, such as version, platform info, and updating
Options
cli docs
Generate documentation for all commands in Markdown format
Synopsis
Generate comprehensive documentation for all commands and subcommands in Markdown format
Options
cli info
Adviser compiled for/running on.
Synopsis
Info including platform (eg Mac/ARM64, Windows/AMD64) the binary was compiled for and is running on, version, and other info we deem useful.
Options
cli update
Update the CLI to the latest version
Synopsis
Downloads and installs the latest version of the Adviser CLI
Options
cluster
Commands related to clusters
Synopsis
Commands for creating, listing, and deleting clusters
Options
cluster create
Create a cluster
Synopsis
Create a new cluster on the specified Cloud, Region, with optional workdir and setup commands to help configure the cluster
Options
cluster delete
Delete a cluster
Synopsis
Delete a cluster by ID
Options
cluster list
List clusters
Synopsis
List all clusters, optionally including deleted/used ones
Options
completion
Generate the autocompletion script for the specified shell
Synopsis
Generate the autocompletion script for adviser for the specified shell. See each sub-command's help for details on how to use the generated script.
Options
completion bash
Generate the autocompletion script for bash
Synopsis
Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package. If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
To load completions for every new session, execute once:
Linux:
macOS:
You will need to start a new shell for this setup to take effect.
Options
completion fish
Generate the autocompletion script for fish
Synopsis
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
To load completions for every new session, execute once:
You will need to start a new shell for this setup to take effect.
Options
completion powershell
Generate the autocompletion script for powershell
Synopsis
Generate the autocompletion script for powershell.
To load completions in your current shell session:
To load completions for every new session, add the output of the above command to your powershell profile.
Options
completion zsh
Generate the autocompletion script for zsh
Synopsis
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
To load completions in your current shell session:
To load completions for every new session, execute once:
Linux:
adviser completion zsh > "${fpath[1]macOS:
You will need to start a new shell for this setup to take effect.
Options
invite
Invite users to your organization
Synopsis
Invite new users to join your organization on the Adviser platform
Options
job
Commands related to jobs
Synopsis
Commands for listing and downloading jobs
Options
job download
Download job results
Synopsis
Download results from a completed job
Options
job list
List jobs
Synopsis
List all jobs
Options
login
Log in to Adviser
Synopsis
Log in to the Adviser platform with your credentials
Options
run
Run a job
Synopsis
Run a job on an available cluster
Options
signup
Sign up for an Adviser account
Synopsis
Create a new user account on the Adviser platform
Options
