# Overview

> Manage GPU instances, Run Jobs and files from your terminal or your scripts.

`featherless-cloud` is the command-line client for Featherless GPU Cloud. It runs on macOS, Linux and Windows.

## Quick start

```bash
# 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
```

## Install

<tabs>
<tabs-item label="Install script">

For macOS and Linux:

```bash
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.

</tabs-item>

<tabs-item label="npm">

On any platform with Node.js:

```bash
npm install --global @featherlessai/gpu-cloud-cli
```

To try a command without installing, use `npx @featherlessai/gpu-cloud-cli <command>`.

</tabs-item>
</tabs>

Check the installation:

```bash
featherless-cloud --version
```

## Sign in

The CLI signs in with an [API key](/get-started/credentials#create-an-api-key).

```bash
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:

```bash
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.

### Profiles

Store several keys, for example one per organization, under named profiles:

```bash
featherless-cloud login --profile research
featherless-cloud instance list --profile research
```

Commands use the `default` profile unless you pass `--profile`.

## Commands

<table>
<thead>
  <tr>
    <th>
      Command
    </th>
    
    <th>
      What it does
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <a href="/cli/instance">
        <code>
          instance
        </code>
      </a>
    </td>
    
    <td>
      Create, list, start, stop, connect to and delete instances.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/cli/exec">
        <code>
          exec
        </code>
      </a>
    </td>
    
    <td>
      Run a command as a Run Job and stream its output.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/cli/runjob">
        <code>
          runjob
        </code>
      </a>
    </td>
    
    <td>
      List, follow, cancel and delete Run Jobs.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/cli/volume">
        <code>
          volume
        </code>
      </a>
    </td>
    
    <td>
      Manage network volumes and the files in them.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/cli/templates">
        <code>
          templates
        </code>
      </a>
    </td>
    
    <td>
      Save, list and change templates.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/cli/ssh-keys">
        <code>
          ssh-keys
        </code>
      </a>
    </td>
    
    <td>
      Manage your SSH public keys.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/cli/registry-keys">
        <code>
          registry-keys
        </code>
      </a>
    </td>
    
    <td>
      Manage registry credentials for private images.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/cli/pricing">
        <code>
          pricing
        </code>
      </a>
    </td>
    
    <td>
      List current prices.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/cli/billing">
        <code>
          billing
        </code>
      </a>
    </td>
    
    <td>
      Show your balance and billing history.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        login
      </code>
      
      , <code>
        logout
      </code>
    </td>
    
    <td>
      Store or remove an API key.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        upgrade
      </code>
    </td>
    
    <td>
      Install the latest version.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        completion
      </code>
    </td>
    
    <td>
      Print a shell completion script.
    </td>
  </tr>
</tbody>
</table>

Run any command with `--help` for its options. Commands accept a resource's name or its ID.

## Global options

<table>
<thead>
  <tr>
    <th>
      Option
    </th>
    
    <th>
      What it does
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        --json
      </code>
    </td>
    
    <td>
      Print JSON, including errors. Use it in scripts and with <code>
        jq
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        --non-interactive
      </code>
    </td>
    
    <td>
      No prompts or spinners.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        -V
      </code>
      
      , <code>
        --version
      </code>
    </td>
    
    <td>
      Print the version.
    </td>
  </tr>
</tbody>
</table>

```bash
featherless-cloud instance list --json | jq -r '.items[].name'
```

Commands that delete something ask for confirmation. Pass `--yes` when the command can't prompt.

## Shell completion

<tabs>
<tabs-item label="zsh">

```bash
mkdir -p ~/.zsh/completions
featherless-cloud completion zsh > ~/.zsh/completions/_featherless-cloud
echo 'fpath=(~/.zsh/completions $fpath)' >> ~/.zshrc
```

</tabs-item>

<tabs-item label="bash">

```bash
echo 'eval "$(featherless-cloud completion bash)"' >> ~/.bashrc
```

</tabs-item>
</tabs>

Open a new shell. Tab then completes commands, options, and the names of your instances, Run Jobs, volumes, templates and folders in `vol://` paths.

## Update

The CLI tells you when a new version is out. `upgrade` updates either kind of install:

```bash
featherless-cloud upgrade
```
