> ## Documentation Index
> Fetch the complete documentation index at: https://runcrate.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Reference

> Complete command reference for the Runcrate CLI.

export const RuncrateStyles = () => {
  if (typeof document !== 'undefined' && !document.getElementById('runcrate-overrides')) {
    const s = document.createElement('style');
    s.id = 'runcrate-overrides';
    s.textContent = `
      /* Match Runcrate's rounding scale (--radius: 0.75rem) */
      .rounded-sm { border-radius: 0.5rem !important; }   /* 8px */
      .rounded-md { border-radius: 0.625rem !important; } /* 10px */
      .rounded-lg { border-radius: 0.75rem !important; }  /* 12px */
      .rounded-l-sm { border-top-left-radius: 0.5rem !important; border-bottom-left-radius: 0.5rem !important; }
      .rounded-r-sm { border-top-right-radius: 0.5rem !important; border-bottom-right-radius: 0.5rem !important; }
      .rounded-l-md { border-top-left-radius: 0.625rem !important; border-bottom-left-radius: 0.625rem !important; }
      .rounded-r-md { border-top-right-radius: 0.625rem !important; border-bottom-right-radius: 0.625rem !important; }
      .rounded-l-lg { border-top-left-radius: 0.75rem !important; border-bottom-left-radius: 0.75rem !important; }
      .rounded-r-lg { border-top-right-radius: 0.75rem !important; border-bottom-right-radius: 0.75rem !important; }

      /* Cards: never pure white in light mode */
      .card { background-color: #fcfcfc !important; border-radius: 0.75rem !important; }
      html.dark .card { background-color: #141414 !important; }

      /* Docs hero box */
      .rc-hero { background-color: #fcfcfc; border: 1px solid #e0e0e0; }
      html.dark .rc-hero { background-color: #141414; border-color: #242424; }
      html.dark .rc-hero h1 { color: #f5f5f5; }

      /* Runcrate scrollbar — thin, transparent track, hide-until-hover thumb */
      ::-webkit-scrollbar { width: 6px; height: 6px; background-color: transparent; }
      ::-webkit-scrollbar-track { background-color: transparent; }
      ::-webkit-scrollbar-thumb { background-color: rgba(155, 155, 155, 0.5); border-radius: 10px; transition: opacity 0.3s ease; opacity: 0; }
      ::-webkit-scrollbar-thumb:hover { background-color: rgba(155, 155, 155, 0.7); }
      *:hover::-webkit-scrollbar-thumb,
      *:focus::-webkit-scrollbar-thumb,
      *:active::-webkit-scrollbar-thumb { opacity: 1; }
      * { scrollbar-width: thin; scrollbar-color: rgba(155, 155, 155, 0.5) transparent; }
    `;
    document.head.appendChild(s);
  }
  return null;
};

<RuncrateStyles />

| Command                                         | Description                                 |
| ----------------------------------------------- | ------------------------------------------- |
| `runcrate login`                                | Authenticate via browser                    |
| `runcrate logout`                               | Clear credentials                           |
| **Instances**                                   |                                             |
| `runcrate ps`                                   | List instances (alias for `instances list`) |
| `runcrate instances list [-q]`                  | List instances (`-q` for IDs only)          |
| `runcrate instances types [--gpu X]`            | Browse GPUs and pricing                     |
| `runcrate instances create --name X --gpu A100` | Deploy instance                             |
| `runcrate instances info <name-or-id>`          | Instance details (IP, GPU, cost)            |
| `runcrate instances status <name-or-id>`        | Live status check                           |
| `runcrate instances delete <name-or-id>`        | Terminate instance                          |
| **Access**                                      |                                             |
| `runcrate ssh <instance>`                       | Interactive shell (keyless)                 |
| `runcrate ssh <instance> -- <cmd>`              | Run command and exit                        |
| `runcrate cp ./local instance:/remote`          | Upload file                                 |
| `runcrate cp instance:/remote ./local`          | Download file                               |
| **Volumes**                                     |                                             |
| `runcrate volumes list`                         | List volumes                                |
| `runcrate volumes create --name X --size 100`   | Create volume (GB)                          |
| `runcrate volumes resize <id> --size 200`       | Resize volume                               |
| `runcrate volumes delete <id>`                  | Delete volume                               |
| `runcrate volumes regions`                      | Available regions                           |
| **SSH Keys**                                    |                                             |
| `runcrate ssh-keys list`                        | List SSH keys                               |
| `runcrate ssh-keys add --name X --file <path>`  | Add SSH key                                 |
| `runcrate ssh-keys delete <id>`                 | Delete SSH key                              |
| **Billing**                                     |                                             |
| `runcrate billing balance`                      | Current credit balance                      |
| `runcrate billing usage`                        | Spending breakdown                          |
| **Workspaces & Environments**                   |                                             |
| `runcrate workspaces`                           | List workspaces                             |
| `runcrate workspaces switch`                    | Switch active workspace                     |
| `runcrate envs`                                 | List environments                           |
| `runcrate envs switch <name>`                   | Switch environment                          |
| `runcrate envs create <name>`                   | Create environment                          |
| `runcrate envs delete <name>`                   | Delete environment                          |
| **Other**                                       |                                             |
| `runcrate templates`                            | List OS templates                           |
| `runcrate config show`                          | Show CLI configuration                      |
| `runcrate version`                              | Show version                                |
| `runcrate update`                               | Self-update                                 |

***

## SSH Keys

Manage SSH keys for non-keyless access to instances.

### List keys

```bash theme={"theme":"github-dark"}
runcrate ssh-keys list
```

### Add a key

```bash theme={"theme":"github-dark"}
runcrate ssh-keys add --name work-laptop --file ~/.ssh/id_ed25519.pub
```

### Delete a key

```bash theme={"theme":"github-dark"}
runcrate ssh-keys delete <id>
```

***

## Billing

### Check balance

```bash theme={"theme":"github-dark"}
runcrate billing balance    # Current credit balance
```

### View usage

```bash theme={"theme":"github-dark"}
runcrate billing usage      # Spending breakdown
```

***

## Workspaces & Environments

### List and switch workspaces

```bash theme={"theme":"github-dark"}
runcrate workspaces              # List all workspaces
runcrate workspaces switch       # Switch active workspace
```

### Manage environments

```bash theme={"theme":"github-dark"}
runcrate envs                    # List environments in current workspace
runcrate envs switch staging     # Switch to a different environment
runcrate envs create staging     # Create a new environment
runcrate envs delete staging     # Delete an environment
```

***

## Other Commands

### Templates

```bash theme={"theme":"github-dark"}
runcrate templates               # List OS templates for instances
```

### Configuration

```bash theme={"theme":"github-dark"}
runcrate config show             # Show current CLI configuration
```

### Self-update

```bash theme={"theme":"github-dark"}
runcrate update                  # Update to the latest version
```

***

## Tips

* Most list commands support `--json` for machine-readable output.
* Common aliases work: `ls`, `rm`, `-q`.
* Run `runcrate <command> --help` for detailed usage on any command.
