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

# Features

A quick-start guide and feature overview for the `swarm` CLI.

## Create an account

Go to [https://swarm.stoke.com/](https://swarm.stoke.com/) and sign-in or
sign-up with Google.

## Installation

Install `swarm` to `~/.local/bin/swarm`:

```bash theme={null}
curl -fsSL https://swarm.stoke.com/install | bash
```

Then make sure `~/.local/bin` is in your `PATH`:

```bash theme={null}
export PATH="$HOME/.local/bin:$PATH"
```

## Authenticate the CLI

* `swarm auth login` - should open a browser for you to authorize the CLI.

## Claude Plugin

Enable the swarm plugin in your `.claude/settings.json`. This adds needed
agents, skills, and hooks for Swarm to function properly.

```json theme={null}
{
  "enabledPlugins": {
    "swarm@kad-swarm": true
  },
  "extraKnownMarketplaces": {
    "kad-swarm": {
      "source": {
        "source": "github",
        "repo": "stoke-gh/kad-swarm"
      }
    }
  }
}
```

Note: You can also enable this by going to the `/plugins` section within Claude.
After adding the plugin restart Claude.

## To start a new worktree:

* Run `swarm start` from within a git repository
  * This will prompt you to pick a "flow"
  * Flows are defined in the web interface. They define a sequence of steps
    for claude to take.
  * e.g. [`stoke-gh/code` flows](https://swarm.stoke.com/repos/ps75hrnx01btzjfpaxp1xxsten80k82a)

## Configuration

Within the repo editor you can see the repo's configuration under `config.yaml`.
If you want personal user-specific overrides create a new `config.local.yaml`
file in the web editor.

## Updates

To get future CLI updates run:

* `swarm update`
* `swarm update --check` (just checks, doesn't install)

## Claude Statusline

Add to your `.claude/settings.local.json`:

```json theme={null}
{
  "statusLine": {
    "type": "command",
    "command": "swarm statusline",
    "padding": 0
  }
}
```

Note: use `swarm statusline --examples` to see example outputs.

## Info

* `swarm --version`
* `swarm --help`
* `swarm [command] --help`