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

# FluffDock

FluffDock is a small shell-helper layer for Docker-based FluffBuzz installs.

It gives you short commands like `fluffdock-start`, `fluffdock-dashboard`, and `fluffdock-fix-token` instead of longer `docker compose ...` invocations.

If you have not set up Docker yet, start with [Docker](/install/docker).

## Install

Use the canonical helper path:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
mkdir -p ~/.fluffdock && curl -sL https://raw.githubusercontent.com/fluffbuzz/fluffbuzz/main/scripts/fluffdock/fluffdock-helpers.sh -o ~/.fluffdock/fluffdock-helpers.sh
echo 'source ~/.fluffdock/fluffdock-helpers.sh' >> ~/.zshrc && source ~/.zshrc
```

If you previously installed FluffDock from `scripts/shell-helpers/fluffdock-helpers.sh`, reinstall from the new `scripts/fluffdock/fluffdock-helpers.sh` path. The old raw GitHub path was removed.

## What you get

### Basic operations

| Command             | Description            |
| ------------------- | ---------------------- |
| `fluffdock-start`   | Start the gateway      |
| `fluffdock-stop`    | Stop the gateway       |
| `fluffdock-restart` | Restart the gateway    |
| `fluffdock-status`  | Check container status |
| `fluffdock-logs`    | Follow gateway logs    |

### Container access

| Command                    | Description                                   |
| -------------------------- | --------------------------------------------- |
| `fluffdock-shell`          | Open a shell inside the gateway container     |
| `fluffdock-cli <command>`  | Run FluffBuzz CLI commands in Docker          |
| `fluffdock-exec <command>` | Execute an arbitrary command in the container |

### Web UI and pairing

| Command                  | Description                  |
| ------------------------ | ---------------------------- |
| `fluffdock-dashboard`    | Open the Control UI URL      |
| `fluffdock-devices`      | List pending device pairings |
| `fluffdock-approve <id>` | Approve a pairing request    |

### Setup and maintenance

| Command               | Description                                      |
| --------------------- | ------------------------------------------------ |
| `fluffdock-fix-token` | Configure the gateway token inside the container |
| `fluffdock-update`    | Pull, rebuild, and restart                       |
| `fluffdock-rebuild`   | Rebuild the Docker image only                    |
| `fluffdock-clean`     | Remove containers and volumes                    |

### Utilities

| Command                 | Description                             |
| ----------------------- | --------------------------------------- |
| `fluffdock-health`      | Run a gateway health check              |
| `fluffdock-token`       | Print the gateway token                 |
| `fluffdock-cd`          | Jump to the FluffBuzz project directory |
| `fluffdock-config`      | Open `~/.fluffbuzz`                     |
| `fluffdock-show-config` | Print config files with redacted values |
| `fluffdock-workspace`   | Open the workspace directory            |

## First-time flow

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
fluffdock-start
fluffdock-fix-token
fluffdock-dashboard
```

If the browser says pairing is required:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
fluffdock-devices
fluffdock-approve <request-id>
```

## Config and secrets

FluffDock works with the same Docker config split described in [Docker](/install/docker):

* `<project>/.env` for Docker-specific values like image name, ports, and the gateway token
* `~/.fluffbuzz/.env` for env-backed provider keys and bot tokens
* `~/.fluffbuzz/agents/<agentId>/agent/auth-profiles.json` for stored provider OAuth/API-key auth
* `~/.fluffbuzz/fluffbuzz.json` for behavior config

Use `fluffdock-show-config` when you want to inspect the `.env` files and `fluffbuzz.json` quickly. It redacts `.env` values in its printed output.

## Related pages

* [Docker](/install/docker)
* [Docker VM Runtime](/install/docker-vm-runtime)
* [Updating](/install/updating)
