worktree AGENTS.md

Repository-specific instructions for Worktree Manager, a Go command-line tool that creates and coordinates Git worktrees across multiple projects. A Git worktree is a separate working directory linked to a repository, and these instructions cover ports, Docker instances, and configuration.

In plain words
What is it for?
Use them when changing the Worktree Manager CLI, its registry or configuration, port allocation, Docker setup, or integrations with coding agents.
Why use it?
They explain how the registry tracks branches, projects, and available ports, so an agent does not break coordination between development instances.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/braunmar/worktree/agents-md
Clone the repo
git clone --depth 1 https://github.com/braunmar/worktree

Made for: Codex, OpenCode.

Per session 4,526 This file is loaded in full into every session.
When invoked 4,526 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.04526 $0.04526
Opus 5 $0.02263 $0.02263
Sonnet 5 $0.00905 $0.00905
Haiku 4.5 $0.00453 $0.00453

Measured yesterday against content hash 4bcd3edfacf7, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

worktree AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 514 lines

How it starts

The opening of the file, as written. The whole thing — 514 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

This file provides guidance to AI coding agent when working with code in this repository.

Project Overview

Worktree Manager is a Go CLI tool for managing git worktrees in multi-instance development environments. It creates coordinated worktrees across multiple projects (backend, frontend), allocates ports dynamically, manages Docker instances, and integrates with Claude Code for autonomous development workflows.

Core Architecture

Registry System

Location: pkg/registry/registry.go

The registry is the source of truth for all worktree instances and port allocations:

  • File: worktrees/.registry.json
  • Structure: Maps normalized feature names to worktree metadata (branch, ports, projects, compose names)
  • Port Allocation: Thread-safe allocation from configured ranges
  • Persistence: Atomic writes with temp file + rename

Key Functions:

  • Load() - Loads registry from disk, builds port ranges from config
  • AllocatePorts() - Finds available ports across all configured services
  • FindAvailablePort() - Checks registry + live port availability (binds to verify)
  • NormalizeBranchName() - Converts feature/user-authfeature-user-auth

Configuration System

Location: pkg/config/workconfig.go

Configuration is loaded from .worktree.yml in the project root:

Key Structures:

  • WorktreeConfig - Main configuration (projects, presets, ports, symlinks, copies)
  • ProjectConfig - Per-project settings (dir, main_branch, start_command, post_command)
  • PresetConfig - Groups of projects (e.g., "fullstack" = backend + frontend)
  • PortConfig - Port/service configuration (name, URL template, port expression, env var)

Port Expression Syntax: Port values support dynamic calculation using {instance} placeholder:

  • Simple offset: "3000 + {instance}" → 3000, 3001, 3002, ...
  • Multiplication: "4510 + {instance} * 50" → 4510, 4560, 4610, ...
  • Static value: "8080" → always 8080

Expression Parsing (parseExpression(), CalculatePort()):

  1. Replace {instance} with actual instance number
  2. Parse expression: base, offset, multiplier
  3. Calculate: base + (offset * multiplier) or base + offset or just base
  4. Validate result is in range 1-65535

Read the full file on GitHub · 514 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 514 lines · 4,526 tokens per session scan A 4bcd3edfacf7

Subscribe to this mod's changes

worktree AGENTS.md is an instructions file published in the GitHub repository braunmar/worktree (5 stars, last pushed 6d ago), licensed MIT. It adds 4,526 tokens to every session, about $0.0226 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

buildNext

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

spec-kit AGENTS.md

Instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,040 tokens

langchain AGENTS.md

Instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens