featherless-cloud is the command-line client for Featherless GPU Cloud. It runs on macOS, Linux and Windows.
# Install
curl -fsSL https://console.cloud.featherless.ai/install.sh | sh
# Sign in with an API key
featherless-cloud login
# Deploy an instance and connect to it
featherless-cloud instance create --name dev --template featherless/rocm-pytorch --gpu-count 1
featherless-cloud instance ssh dev
For macOS and Linux:
curl -fsSL https://console.cloud.featherless.ai/install.sh | sh
The script installs the binary to ~/.local/bin after checking its integrity. Set FEATHERLESS_CLOUD_INSTALL_DIR to install elsewhere, or FEATHERLESS_CLOUD_VERSION to pin a version. Add the folder to your PATH if the script asks.
On any platform with Node.js:
npm install --global @featherlessai/gpu-cloud-cli
To try a command without installing, use npx @featherlessai/gpu-cloud-cli <command>.
Check the installation:
featherless-cloud --version
The CLI signs in with an API key.
featherless-cloud login
login opens the console's API keys page in your browser. Create a key there and paste it into the terminal. In scripts and CI, pass the key directly:
featherless-cloud login --key "$FEATHERLESS_API_KEY"
featherless-cloud logout signs you out. Revoke the key in the console too if you no longer need it.
Store several keys, for example one per organization, under named profiles:
featherless-cloud login --profile research
featherless-cloud instance list --profile research
Commands use the default profile unless you pass --profile.
| Command | What it does |
|---|---|
instance | Create, list, start, stop, connect to and delete instances. |
exec | Run a command as a Run Job and stream its output. |
runjob | List, follow, cancel and delete Run Jobs. |
volume | Manage network volumes and the files in them. |
templates | Save, list and change templates. |
ssh-keys | Manage your SSH public keys. |
registry-keys | Manage registry credentials for private images. |
pricing | List current prices. |
billing | Show your balance and billing history. |
login, logout | Store or remove an API key. |
upgrade | Install the latest version. |
completion | Print a shell completion script. |
Run any command with --help for its options. Commands accept a resource's name or its ID.
| Option | What it does |
|---|---|
--json | Print JSON, including errors. Use it in scripts and with jq. |
--non-interactive | No prompts or spinners. |
-V, --version | Print the version. |
featherless-cloud instance list --json | jq -r '.items[].name'
Commands that delete something ask for confirmation. Pass --yes when the command can't prompt.
mkdir -p ~/.zsh/completions
featherless-cloud completion zsh > ~/.zsh/completions/_featherless-cloud
echo 'fpath=(~/.zsh/completions $fpath)' >> ~/.zshrc
echo 'eval "$(featherless-cloud completion bash)"' >> ~/.bashrc
Open a new shell. Tab then completes commands, options, and the names of your instances, Run Jobs, volumes, templates and folders in vol:// paths.
The CLI tells you when a new version is out. upgrade updates either kind of install:
featherless-cloud upgrade