@markjaquith/agency 1.11.1 → 2.0.0

package/README.md

@@ -1,6 +1,16 @@
 # @markjaquith/agency
 
-Smuggle project-level LLM instruction into any Git repo. Plan your tasks. Commit your plans. Execute your plans using Opencode. Filter those plans out out your PRs.
+Agency manages durable agentic work across repositories. Epics, tasks, and
+phases live as Markdown documents in a filesystem-backed workbase. Repository
+aliases and Git worktrees provide each execution unit with the code it may read
+or write.
+
+## Requirements
+
+- [Bun](https://bun.sh) 1.0 or newer
+- Git
+- [GitHub CLI](https://cli.github.com/) for `agency pr create`
+- OpenCode or Claude Code for `agency work`
 
 ## Installation
 
@@ -8,170 +18,349 @@ Smuggle project-level LLM instruction into any Git repo. Plan your tasks. Commit
 bun install -g @markjaquith/agency
 ```
 
-## Primary Commands
-
-### `agency task <branch-name>`
-
-Create a new feature branch from the latest `origin/main` and initialize `AGENTS.md` and `TASK.md` files using the template you've set for this repo. Commits smuggled files and lands you on that branch.
-
-**Options:**
-
-- `--from <branch>` - Branch from a specific branch instead of `origin/main`
-- `--from-current` - Initialize on current branch instead of creating a new one
-- `--continue` - Continue a task by copying agency files to a new branch (after PR merge)
-
-**Examples:**
-
-```bash
-agency task my-feature              # Create 'my-feature' from latest origin/main
-agency task my-feature --from dev   # Create 'my-feature' from 'dev' branch
-agency task --from-current          # Initialize on current branch (no new branch)
-agency task --continue my-feature-v2 # Continue task on new branch after PR merge
+For development, run `bun link` from this repository.
+
+## Core Model
+
+- A **workbase** is the root containing durable documents and local repository
+  state.
+- An **epic** orchestrates tasks, may inspect repositories, and never writes
+  code.
+- A **task** describes one durable outcome and may stand alone or belong to an
+  epic.
+- A **phase** belongs to a multi-phase task and represents one PR or intended
+  PR.
+- An **execution unit** is either a single-phase task or a phase. It has exactly
+  one writable `repo`, optional read-only `repos`, a branch, a base, and a
+  `string | null` PR URL.
+
+Entity IDs come from directory names. Structured metadata lives in YAML 1.2
+frontmatter; prose below it supplies human and agent context.
+
+## Workbase Layout
+
+```text
+workbase/
+  agency.json
+  repos/
+    frontend/              # bare Git repository or symlink
+    backend/
+  epics/
+    checkout/
+      EPIC.md
+  tasks/
+    refresh-copy/          # single-phase task
+      TASK.md
+      code/                # created by agency work
+        frontend/
+    build-checkout/        # multi-phase task
+      TASK.md
+      phases/
+        backend-api/
+          PHASE.md
+          code/
+            backend/
+        frontend-ui/
+          PHASE.md
+          code/
+            frontend/
+            backend/
 ```
 
-### `agency edit`
-
-Open `TASK.md` in the system editor for editing. Nice if you have to paste in large amounts of context.
-
-### `agency work`
+Repository metadata comes directly from Git under `repos/{alias}`. Workbase
+configuration may provide a custom writable-worktree creation command.
+
+### Custom Worktree Command
+
+By default, Agency creates worktrees with Git. Set `worktreeCreateCommand` to an
+argv template when another tool should create writable worktrees:
+
+```json
+{
+	"version": 2,
+	"worktreeCreateCommand": [
+		"my-worktree-tool",
+		"--repo",
+		"{repo}",
+		"--destination",
+		"{worktree}",
+		"--branch",
+		"{branch}"
+	]
+}
+```
 
-Launch Opencode to work on the current task defined in `TASK.md`. All your context will be loaded.
+Available placeholders are:
+
+- `{repo}`: absolute repository alias path under `repos/`
+- `{worktree}`: absolute checkout path Agency requires
+- `{branch}`: execution branch the custom command must create or check out
+- `{base}`: configured execution base
+
+`{repo}` and `{worktree}` are required. Agency invokes the command directly
+without a shell, sets matching `AGENCY_REPO`, `AGENCY_WORKTREE`,
+`AGENCY_BRANCH`, and `AGENCY_BASE` environment variables, and verifies that the
+requested destination exists afterward.
+
+Worktrunk can be configured per workbase without changing the user's Worktrunk
+path settings:
+
+```json
+{
+	"version": 2,
+	"worktreeCreateCommand": [
+		"wt",
+		"-C",
+		"{repo}",
+		"-y",
+		"--config-set",
+		"worktree-path=\"{worktree}\"",
+		"switch",
+		"--create",
+		"--base",
+		"{base}",
+		"{branch}",
+		"--no-cd",
+		"--format",
+		"json"
+	]
+}
+```
 
-### `agency loop`
+Custom commands own writable branch creation. Agency checks for conflicting
+worktrees first, invokes the command only when the branch is not checked out,
+and verifies that `{worktree}` exists afterward.
+
+The configured command applies only to the writable checkout. Supplemental
+read-only repositories remain detached Git worktrees at their declared refs so
+they do not acquire writable branches.
+
+## Frontmatter
+
+### Epic
+
+```yaml
+---
+ticketUrl: https://example.com/tickets/checkout
+description: Coordinate the checkout experience across frontend and backend.
+repos:
+  - repo: frontend
+    ref: main
+  - repo: backend
+    ref: main
+tasks:
+  - id: backend-api
+  - id: frontend-ui
+    dependsOn:
+      - backend-api
+---
+```
 
-Run a Ralph Wiggum loop over the current `TASK.md`.
-The command repeatedly invokes `opencode run` in isolated iterations, committing progress after each loop, until all tasks are complete or a maximum loop count is reached.
+### Single-Phase Task
+
+```yaml
+---
+ticketUrl: https://example.com/tickets/refresh-copy
+description: Refresh user-facing checkout copy.
+epic: checkout
+repo: frontend
+repos:
+  - repo: backend
+    ref: main
+branch: task/refresh-copy
+base: main
+pr: null
+---
+```
 
-When all work is finished, the loop terminates and outputs `<promise>COMPLETE</promise>`.
+### Multi-Phase Task
+
+```yaml
+---
+ticketUrl: https://example.com/tickets/build-checkout
+description: Deliver checkout through sequenced backend and frontend changes.
+epic: checkout
+phases:
+  - id: backend-api
+  - id: frontend-ui
+    dependsOn:
+      - backend-api
+---
+```
 
-**Options:**
+Each listed phase has a `phases/{id}/PHASE.md` containing its execution fields:
+
+```yaml
+---
+description: Build the checkout interface against the new backend API.
+repo: frontend
+repos:
+  - repo: backend
+    ref: main
+branch: task/checkout-ui
+base: task/checkout-api
+pr: null
+---
+```
 
-- `--min-loops <n>` - Run at least `n` iterations, even if tasks complete earlier
-- `--max-loops <n>` - Stop after `n` iterations even if tasks remain
+Epic task dependencies belong in `EPIC.md`. Phase dependencies belong in the
+owning `TASK.md`. Stable IDs do not encode ordering in directory names.
 
-**Example:**
+## Quick Start
 
 ```bash
-agency loop --max-loops 10
+agency init ~/work
+cd ~/work
+
+agency repo add frontend git@github.com:example/frontend.git
+agency repo link backend ~/Dev/backend
+
+agency task create refresh-copy \
+  --ticket-url https://example.com/tickets/refresh-copy \
+  --description "Refresh user-facing checkout copy" \
+  --repo frontend \
+  --reference backend:main \
+  --branch task/refresh-copy \
+  --base main
+
+agency validate
+agency work refresh-copy
+agency pr create refresh-copy
 ```
 
-### `agency emit [base-branch]`
-
-Create an emit branch with smuggled files reverted to their merge-base state (removes additions/modifications to those files made on feature branch). Default branch name is current branch with `--PR` suffix.
+## Commands
 
-### `agency push [base-branch]`
+### Workbase and Repositories
 
-Runs `agency emit`, pushes the branch, and then switches back to the source branch.
-
-**Options:**
-
-- `--pr` - Open GitHub PR in browser after pushing (requires `gh` CLI)
-- `--force` - Force push to remote if branch has diverged
-- `--branch <name>` - Custom name for emit branch
-
-### `agency merge`
-
-Runs `agency emit`, and then merges the PR back into the base branch locally.
-
-**Options:**
+```text
+agency init [path] [--json]
+agency repo add <alias> <remote> [--json]
+agency repo link <alias> <path> [--json]
+agency repo list [--json]
+```
 
-- `--squash` - Use squash merge instead of regular merge (stages changes, requires manual commit)
-- `--push` - Push the base branch to origin after merging
+`repo add` creates a bare clone. `repo link` creates a symlink to an existing Git
+repository. Alias names are then used by all documents and commands.
 
-## Other Commands
+Commands that print Agency-owned results accept `--json`, including initialization,
+repository mutations, entity creation/list/show, status, validation, and PR creation.
 
-### `agency template use [template]`
+### Epics
 
-Set which template to use for this repository. Shows interactive selection if no template name provided. Saves to `.git/config`.
+```text
+agency epic create <id> --ticket-url <url> [--description <text>] [--json]
+  --repo <alias>:<ref> [--repo <alias>:<ref>...]
+agency epic list [--json]
+agency epic show <id> [--json]
+```
 
-### `agency template save <files...>`
+Creating a task with `--epic <id>` adds the task to the epic and writes the task
+back-reference.
 
-Save the specified files back to the configured template directory (so they will be used for future `agency task` commands).
+### Tasks
 
-### `agency base get`
+Create a single-phase task:
 
-Get the base branch for the current feature branch.
+```text
+agency task create <id> --ticket-url <url> --repo <alias>
+  --branch <name> --base <name>
+  [--description <text>] [--epic <id>] [--reference <alias>:<ref>...] [--json]
+```
 
-### `agency base set <branch>`
+Create a multi-phase task container:
 
-Set the base branch for the current feature branch.
+```text
+agency task create <id> --ticket-url <url> --multi-phase
+  [--description <text>] [--epic <id>] [--json]
+```
 
-### `agency switch`
+Inspect tasks:
 
-Toggle between source branch and emit branch. If on an emit branch (e.g., `foo--PR`), switches to source branch (e.g., `foo`). If on source branch and emit branch exists, switches to emit branch.
+```text
+agency task list [--json]
+agency task show <id> [--json]
+```
 
-### `agency source`
+To add a phase to an existing single-phase task, name the phase that will own
+the task's current execution fields with `--first-phase`:
 
-Switch to the source branch for the current emit branch.
+```text
+agency phase create refresh-copy verification
+  --first-phase implementation
+  --repo frontend --branch task/refresh-copy-verification --base main
+  --depends-on implementation
+```
 
-### `agency completions <bash|zsh>`
+Agency converts `TASK.md` to the multi-phase shape, creates both phase documents,
+and moves existing worktrees from the task's `code/` directory into the first
+phase. Dependencies remain explicit through `--depends-on`.
 
-Generate shell completion scripts. The generated scripts are static, so shell startup and tab completion do not call `agency`.
+### Phases
 
-**zsh:**
+```text
+agency phase create <task-id> <phase-id>
+  --repo <alias> --branch <name> --base <name>
+  [--description <text>] [--reference <alias>:<ref>...]
+  [--depends-on <phase-id>...] [--first-phase <phase-id>] [--json]
 
-```bash
-mkdir -p ~/.zsh/completions
-agency completions zsh > ~/.zsh/completions/_agency
+agency phase list <task-id> [--json]
+agency phase show <task-id> <phase-id> [--json]
 ```
 
-Then add this to `~/.zshrc` before `compinit`:
+### Work and Pull Requests
 
-```bash
-fpath=(~/.zsh/completions $fpath)
-autoload -Uz compinit && compinit
+```text
+agency work <task-id> [phase-id] [--opencode | --claude]
+agency pr create <task-id> [phase-id] [--draft] [--json]
 ```
 
-**bash:**
-
-```bash
-mkdir -p ~/.local/share/bash-completion/completions
-agency completions bash > ~/.local/share/bash-completion/completions/agency
-```
+`agency work` fetches repositories, creates or reuses worktrees under `code/`,
+and launches an agent in the writable checkout with absolute task and phase
+context paths.
 
-## Requirements
+Each writable `(repo, branch)` pair may belong to only one task or phase. Agency
+validation reports duplicate ownership, and `agency work` checks Git's worktree
+registry before creating or reusing a checkout. It reuses only an exact
+path/branch match; if the branch is checked out elsewhere or the target path has
+the wrong branch, the command fails with the conflicting path instead of forcing
+another checkout.
 
-- [Bun](https://bun.sh) >= 1.0.0 (recommended)
-- TypeScript ^5
+Read-only references use `<alias>:<ref>` on the CLI and `{ repo, ref }` in YAML.
+Agency resolves the ref to a commit and creates a detached worktree. Existing
+reference worktrees are reused only while their commit still matches the declared
+ref; use a commit SHA as `ref` when reproducibility matters.
 
-## Development
+`agency pr create` requires a clean writable worktree. It pushes the branch,
+runs `gh pr create --fill`, and writes the returned GitHub PR URL into `pr` in
+the owning `TASK.md` or `PHASE.md`.
 
-To install dependencies:
+### Status and Validation
 
-```bash
-bun install
+```text
+agency status [--json]
+agency validate [--json]
 ```
 
-To run:
-
-```bash
-bun run index.ts
-```
+Validation checks JSON and YAML parsing, Effect Schema conformance, repository
+aliases, parent/child backlinks, phase directories, duplicate references,
+unknown dependencies, and dependency cycles. YAML duplicate keys, anchors,
+aliases, and custom tags are rejected.
 
-### Git Hooks
+## Agent Skill
 
-This project uses [hk](https://github.com/jdx/hk) for git hook management. The configuration is in `hk.pkl`.
+`skills/agency/SKILL.md` contains an agent-oriented operating guide for Agency.
+Install or link that directory into your agent's skill location when you want
+Agency workflows to be discovered automatically.
 
-To install the git hooks:
+## Development
 
 ```bash
-hk install
+bun install
+bun link
+bun run build
 ```
 
-**Pre-commit hook runs:**
-
-- Prettier formatting
-- Knip (unused code detection)
-- TypeScript type checking
-
-**Commit-msg hook validates:**
-
-- Conventional commits format
-- Commit message history
-
-**Pre-push hook runs the same checks as pre-commit.**
-
-Note: Tests are intentionally excluded from git hooks as they are slow. Run them manually with `bun test`.
+Run focused tests with `bun test <test-file>`. Run formatting with `bun format`.
 
 ## License