docs: Make documentation convoy-first (gt-yg8bs)
Update all documentation to present convoy as the primary unit of work tracking: - README.md: Show convoy create before sling in Quick Start and Workflows - reference.md: Reorder to show Convoy Management before Work Assignment - understanding-gas-town.md: Add convoy to dispatch workflow example - mayor.md.tmpl: Add convoy commands to Work Management section - crew.md.tmpl: Include convoy in dispatch workflow table Convoy is now the standard workflow - all slings should be part of a convoy. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
committed by
Steve Yegge
parent
d2a6ddb059
commit
0428922697
31
README.md
31
README.md
@@ -1,6 +1,6 @@
|
||||
# Gas Town
|
||||
|
||||
Multi-agent orchestrator for Claude Code. Sling work to agents; they run it.
|
||||
Multi-agent orchestrator for Claude Code. Track work with convoys; sling to agents.
|
||||
|
||||
## Why Gas Town?
|
||||
|
||||
@@ -23,8 +23,13 @@ gt install ~/gt
|
||||
# Add a project
|
||||
gt rig add myproject --remote=https://github.com/you/repo.git
|
||||
|
||||
# Sling work to a polecat (worker)
|
||||
# Create a convoy and sling work (standard workflow)
|
||||
gt convoy create "Feature X" issue-123 issue-456 --notify --human
|
||||
gt sling issue-123 myproject
|
||||
gt sling issue-456 myproject
|
||||
|
||||
# Track progress on dashboard
|
||||
gt convoy list
|
||||
```
|
||||
|
||||
## Core Concepts
|
||||
@@ -47,15 +52,20 @@ Town (~/gt/) Your workspace
|
||||
### Minimal (No Tmux)
|
||||
Run individual Claude Code instances manually. Gas Town just tracks state.
|
||||
```bash
|
||||
gt sling issue-123 myproject # Creates work assignment
|
||||
claude --resume # Agent reads mail, runs work
|
||||
gt convoy create "Fix bugs" issue-123 # Create convoy (sling auto-creates if skipped)
|
||||
gt sling issue-123 myproject # Assign to worker
|
||||
claude --resume # Agent reads mail, runs work
|
||||
gt convoy list # Check progress
|
||||
```
|
||||
|
||||
### Full Stack (Tmux)
|
||||
Agents run in tmux sessions. Daemon manages lifecycle.
|
||||
```bash
|
||||
gt daemon start # Start lifecycle manager
|
||||
gt sling issue-123 myproject # Spawns polecat automatically
|
||||
gt daemon start # Start lifecycle manager
|
||||
gt convoy create "Feature X" issue-123 issue-456
|
||||
gt sling issue-123 myproject # Spawns polecat automatically
|
||||
gt sling issue-456 myproject # Another worker
|
||||
gt convoy list # Dashboard view
|
||||
```
|
||||
|
||||
### Pick Your Roles
|
||||
@@ -99,7 +109,9 @@ needs = ["test"]
|
||||
bd formula list # See available formulas
|
||||
bd cook shiny # Cook into a protomolecule
|
||||
bd mol pour shiny --var feature=auth # Create runnable molecule
|
||||
gt convoy create "Auth feature" gt-xyz # Track with convoy
|
||||
gt sling gt-xyz myproject # Assign to worker
|
||||
gt convoy list # Monitor progress
|
||||
```
|
||||
|
||||
### What Happens
|
||||
@@ -178,7 +190,12 @@ Most other work happens through agents - just ask them.
|
||||
### For Agents
|
||||
|
||||
```bash
|
||||
# Work
|
||||
# Convoy (primary dashboard)
|
||||
gt convoy list # Active work across all rigs
|
||||
gt convoy status <id> # Detailed convoy progress
|
||||
gt convoy create "name" <issues> # Create new convoy
|
||||
|
||||
# Work assignment
|
||||
gt sling <bead> <rig> # Assign work to polecat
|
||||
bd ready # Show available work
|
||||
bd list --status=in_progress # Active work
|
||||
|
||||
@@ -214,24 +214,29 @@ gt rig list
|
||||
gt rig remove <name>
|
||||
```
|
||||
|
||||
### Work Assignment
|
||||
```bash
|
||||
gt sling <bead> <rig> # Assign to polecat
|
||||
gt sling <bead> <rig> --molecule=<proto>
|
||||
```
|
||||
|
||||
### Convoy Management (Work Tracking)
|
||||
### Convoy Management (Primary Dashboard)
|
||||
```bash
|
||||
gt convoy list # Dashboard of active convoys
|
||||
gt convoy status [convoy-id] # Show progress (🚚 hq-cv-*)
|
||||
gt convoy create "name" [issues...] # Create convoy tracking issues
|
||||
gt convoy create "name" gt-a bd-b --notify mayor/ # With notification
|
||||
gt convoy status [convoy-id] # Show progress (🚚 hq-cv-*)
|
||||
gt convoy list # Dashboard of active convoys
|
||||
gt convoy list --all # Include landed convoys
|
||||
gt convoy list --status=closed # Only landed convoys
|
||||
```
|
||||
|
||||
Note: "Swarm" is ephemeral (workers on a convoy's issues). See [Convoys](convoy.md).
|
||||
|
||||
### Work Assignment
|
||||
```bash
|
||||
# Standard workflow: convoy first, then sling
|
||||
gt convoy create "Feature X" gt-abc gt-def
|
||||
gt sling gt-abc <rig> # Assign to polecat
|
||||
gt sling gt-def <rig> --molecule=<proto> # With workflow template
|
||||
|
||||
# Quick sling (auto-creates convoy)
|
||||
gt sling <bead> <rig> # Auto-convoy for dashboard visibility
|
||||
```
|
||||
|
||||
### Communication
|
||||
```bash
|
||||
gt mail inbox
|
||||
|
||||
@@ -138,7 +138,8 @@ For work that should be owned by the target rig:
|
||||
# Create issue in target rig
|
||||
bd create --prefix beads "Fix authentication bug"
|
||||
|
||||
# Sling to target rig's workers
|
||||
# Create convoy and sling to target rig
|
||||
gt convoy create "Auth fix" bd-xyz
|
||||
gt sling bd-xyz beads
|
||||
```
|
||||
|
||||
|
||||
@@ -168,7 +168,7 @@ gt worktree remove beads
|
||||
|----------|----------|
|
||||
| Quick fix in another rig | Use `gt worktree` |
|
||||
| Substantial work in another rig | Use `gt worktree` |
|
||||
| Work should be done by target rig's workers | `gt sling` to target rig |
|
||||
| Work should be done by target rig's workers | `gt convoy create` + `gt sling` to target rig |
|
||||
| Infrastructure task | Leave it to the Deacon's dogs |
|
||||
|
||||
**Note**: Dogs are Deacon infrastructure helpers (like Boot). They're NOT for user-facing
|
||||
|
||||
@@ -192,9 +192,12 @@ bd show hq-abc # Routes to town beads
|
||||
- `gt polecats <rig>` - List polecats in a rig
|
||||
|
||||
### Work Management
|
||||
- `gt convoy list` - Dashboard of active work (primary view)
|
||||
- `gt convoy status <id>` - Detailed convoy progress
|
||||
- `gt convoy create "name" <issues>` - Create convoy for batch work
|
||||
- `gt sling <bead> <rig>` - Assign work to polecat (auto-creates convoy)
|
||||
- `bd ready` - Issues ready to work (no blockers)
|
||||
- `bd list --status=open` - All open issues
|
||||
- `gt sling <bead> <rig>` - Assign work to polecat in rig
|
||||
|
||||
### Delegation
|
||||
Prefer delegating to Refineries, not directly to polecats:
|
||||
|
||||
Reference in New Issue
Block a user