#Quickstart

This page is a one-screen walkthrough that creates a CAFleet fleet, spawns two member panes, and sends a message between them. It starts from a clean machine: install the CLI, configure your coding agent, then run the walkthrough.

#Install

Prerequisites:

Install the CLI with Homebrew, then run the setup:

brew install himkt/tap/cafleet
cafleet setup

Alternatively, download the archive for your platform from GitHub Releases — cafleet-v<version>-<target>.tar.gz for aarch64-apple-darwin, x86_64-unknown-linux-musl, or aarch64-unknown-linux-musl — then extract the single cafleet binary onto your PATH and run the same setup:

tar -xzf cafleet-v<version>-<target>.tar.gz
mv cafleet ~/.local/bin/
cafleet setup

#Configure

CAFleet is designed to run inside a coding agent without per-command permission prompts. Each backend has a different config file and permission system:

The snippets below are the recommended starting points for the two backends that need one.

#Claude Code

{
  "permissions": {
    "allow": [
      "Bash(cafleet *)",
      "Skill(cafleet:cafleet)",
      "Skill(cafleet:cafleet-design-doc)",
      "Skill(cafleet:cafleet-research)"
    ],
    "ask": [
      "Bash(cafleet * member prompt *)"
    ]
  }
}

The Bash(cafleet *) pattern is the single allow-everything entry that the literal --fleet-id <int> / --member-id <int> flag convention enables — one pattern covers every subcommand for every fleet. cafleet member prompt * is moved to the ask list because it keystrokes arbitrary text or shell commands into a member's pane; the operator should confirm each invocation.

#Codex

[sandbox_workspace_write]
writable_roots = ["/home/<you>/.local/share/cafleet"]

network_access = true is required because cafleet's multiplexer backends (tmux and herdr) communicate over a local socket, which the Codex sandbox classifies as network access — without it cafleet commands fail with Operation not permitted. writable_roots grants write access to cafleet's default SQLite DB directory. Use the absolute path matching CAFLEET_DATABASE_URL or the default XDG location.

The Codex rules for cafleet commands allow every subcommand while keeping cafleet member prompt prompting; the reference above covers their precedence and where operator customizations belong.

#Trust the working directory

Coding agents ask for a trust confirmation the first time they start in a new directory, and that first-run prompt stalls a freshly spawned member — it ignores every incoming message until the prompt is cleared. Trust the workspace in advance: launch your coding agent once in the working directory the member panes will run in and accept the prompt, or add a trust entry to the agent's configuration file (see your agent's reference page). Trust is granted per directory, so each git worktree needs its own approval.

#Simple example — invoke from a coding agent

For the simplest path, ask Claude Code or Codex to demonstrate CAFleet for you. Inside an agent, send the following prompt:

I want to see how cafleet works.
Please create a new team with two members using cafleet and let them ping-pong each other.
After the demonstration, please shutdown the team.

The coding agent will invoke the cafleet skill, which guides it through the fleet-create / member-create / message-send loop and finally tears the team down.

#Raw CLI walkthrough

If you would rather drive CAFleet from the shell directly, the commands below mirror what the skill does internally. Run them inside a tmux or herdr session — the fleet create and member create commands require one.

cafleet fleet create --name "demo" --coding-agent claude

1 director=2

cafleet member create --fleet-id 1 \
  --name "demo-member" \
  --description "Demo member" \
  --text "You are demo-member. Reply hello when polled."

3 demo-member backend=claude pane=%7

cafleet member create --fleet-id 1 \
  --name "reviewer" \
  --description "Reviewer member" \
  --text "You are reviewer. Reply hello when polled."

4 reviewer backend=claude pane=%8

cafleet member list --fleet-id 1

3 members:
  member_id  name           kind      backend   pane_id  idle
  ---------  -------------  --------  --------  -------  ----
  2          Director       director  claude    %0       -
  3          demo-member    member    claude    %7       -
  4          reviewer       member    claude    %8       -

cafleet message send --fleet-id 1 --from-member-id 3 --to-member-id 4 --text "hi"

Message sent.
[10 | from:3 | 2026-06-11T09:00:00.123456+00:00]
hi

cafleet member delete --fleet-id 1 --member-id 3
cafleet member delete --fleet-id 1 --member-id 4
cafleet fleet delete --fleet-id 1

Deleted fleet 1. Deregistered 1 members.

Where to go next:

• CLI options — every subcommand and flag.
• How-to guides — prompt-first task guides.