llms.txt

wt - LLM Quick Context

Audience
- This file is for LLMs and coding agents that index or enter this repository.
- It serves two audiences: (1) users of the wt tool, and (2) contributors changing wt source code.

What wt is
- wt is a Git worktree manager written in Go.
- It creates, checks out, lists, and removes worktrees with predictable paths.

Section A: Using wt (installed tool consumers)
- Use this section if you are helping someone USE wt, not modify this repository.
- Primary commands:
  - wt create <branch> [base-branch]
  - wt checkout <branch> (alias: wt co)
  - wt list (alias: wt ls)
  - wt remove <branch> (alias: wt rm)
  - wt pr [number|url] (requires gh)
  - wt mr [number|url] (requires glab)
  - wt info
  - wt init
- Typical consumer workflow:
  1) wt create feat/short-description
  2) Work in the created worktree
  3) wt ls to inspect worktrees
  4) wt rm <branch> when done
- Consumer checks:
  - No Go test/build/e2e steps are required to use an installed wt binary.

Section B: Contributing to wt (project authors/maintainers)
- Use this section only when modifying files in this repository.
- Contributor workflow rule:
  - Do not switch branches in the main checkout for task work.
  - Create an isolated worktree per task with wt create.
- Contributor validation checks:
  - go test ./...
  - go build -o bin/wt .
  - go run e2e/run.go

Configuration and hooks
- Config file: ~/.config/wt/config.toml (or WT_CONFIG / --config)
- Key settings: root, strategy, pattern, separator
- Env overrides: WORKTREE_ROOT, WORKTREE_STRATEGY, WORKTREE_PATTERN, WORKTREE_SEPARATOR
- Supported hooks: pre/post create, checkout, remove, pr, mr
- Hook env vars: WT_PATH, WT_BRANCH, WT_MAIN, WT_REPO_NAME, WT_REPO_HOST, WT_REPO_OWNER
- Disable hooks: WT_HOOKS_DISABLED=1

Dependencies
- Required: git
- Optional: gh (for wt pr), glab (for wt mr)
- Build from source: Go 1.24+

Canonical docs
- README.md: user-facing command usage, config, examples
- AGENTS.md: agent workflow and guardrails for repo changes
- CONTRIBUTING.md: contribution workflow and CI expectations

Non-interactive execution note
- For agent/CI contexts, prefer explicit args over interactive prompts:
  - wt co <branch>
  - wt rm <branch>
  - wt pr <id>
  - wt mr <id>