Skip to content

Commit a794ef0

Browse files
committed
docs: sync AGENTS guardrails
1 parent 76ade3b commit a794ef0

File tree

1 file changed

+8
-25
lines changed

1 file changed

+8
-25
lines changed

AGENTS.md

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -17,30 +17,8 @@ Shared guardrails distilled from the various `~/Projects/*/AGENTS.md` files (sta
1717
- Stick to the package manager and runtime mandated by the repo (pnpm-only, bun-only, swift-only, go-only, etc.). Never swap in alternatives without approval.
1818
- When editing shared guardrail scripts (runners, committer helpers, browser tools, etc.), mirror the same change back into the `agent-scripts` folder so the canonical copy stays current.
1919
- Ask the user before adding dependencies, changing build tooling, or altering project-wide configuration.
20-
- Keep the project’s `AGENTS.md` `<tools>
21-
# TOOLS
22-
23-
Edit guidance: keep the actual tool list inside the `<tools></tools>` block below so downstream AGENTS syncs can copy the block contents verbatim (without wrapping twice).
24-
25-
<tools>
26-
- `runner`: Bash shim that routes every command through Bun guardrails (timeouts, git policy, safe deletes).
27-
- `git` / `bin/git`: Git shim that forces git through the guardrails; use `./git --help` to inspect.
28-
- `scripts/committer`: Stages the files you list and creates the commit safely.
29-
- `scripts/docs-list.ts`: Walks `docs/`, enforces front-matter, prints summaries; run `tsx scripts/docs-list.ts`.
30-
- `scripts/browser-tools.ts`: Chrome helper for remote control/screenshot/eval; run `ts-node scripts/browser-tools.ts --help`.
31-
- `scripts/runner.ts`: Bun implementation backing `runner`; run `bun scripts/runner.ts --help`.
32-
- `bin/sleep`: Sleep shim that enforces the 30s ceiling; run `bin/sleep --help`.
33-
- `xcp`: Xcode project/workspace helper; run `xcp --help`.
34-
- `oracle`: CLI to bundle prompt + files for another AI; run `npx -y @steipete/oracle --help`.
35-
- `mcporter`: MCP launcher for any registered MCP server; run `npx mcporter`.
36-
- `iterm`: Full TTY terminal via MCP; run `npx mcporter iterm`.
37-
- `firecrawl`: MCP-powered site fetcher to Markdown; run `npx mcporter firecrawl`.
38-
- `XcodeBuildMCP`: MCP wrapper around Xcode tooling; run `npx mcporter XcodeBuildMCP`.
39-
- `gh`: GitHub CLI for PRs, CI logs, releases, repo queries; run `gh help`.
40-
</tools>
41-
42-
</tools>
43-
` block in sync with the full tool list from `TOOLS.md` so downstream repos get the latest tool descriptions.
20+
- When discussing dependencies, always provide a GitHub URL.
21+
- Keep the project’s `AGENTS.md` `<tools></tools>` block in sync with the full tool list from `TOOLS.md` so downstream repos get the latest tool descriptions.
4422

4523
### tmux & Long Tasks
4624
- Run any command that could hang (tests, servers, log streams, browser automation) inside tmux using the repository’s preferred entry point.
@@ -51,6 +29,7 @@ Edit guidance: keep the actual tool list inside the `<tools></tools>` block belo
5129
- Before handing off work, run the full “green gate” for that repo (lint, type-check, tests, doc scripts, etc.). Follow the same command set humans run—no ad-hoc shortcuts.
5230
- Leave existing watchers running unless the owner tells you to stop them; keep their tmux panes healthy if you started them.
5331
- Treat every bug fix as a chance to add or extend automated tests that prove the behavior.
32+
- When someone asks to “fix CI,” use the GitHub CLI (`gh`) to inspect, rerun, and unblock failing workflows on GitHub until they are green.
5433

5534
### Code Quality & Naming
5635
- Refactor in place. Never create duplicate files with suffixes such as “V2”, “New”, or “Fixed”; update the canonical file and remove obsolete paths entirely.
@@ -60,11 +39,13 @@ Edit guidance: keep the actual tool list inside the `<tools></tools>` block belo
6039

6140
### Git, Commits & Releases
6241
- Invoke git through the provided wrappers, especially for status, diffs, and commits. Only commit or push when the user asks you to do so.
42+
- To resolve a rebase, `git add`/`git commit` is allowed.
6343
- Follow the documented release or deployment checklists instead of inventing new steps.
6444
- Do not delete or rename unfamiliar files without double-checking with the user or the repo instructions.
6545

6646
### Documentation & Knowledge Capture
6747
- Update existing docs whenever your change affects them, including front-matter metadata if the repo’s `docs:list` tooling depends on it.
48+
- Whenever doing a large refactor, track work in `docs/refactor/<title><date>.md`, update it as you go, and delete it when the work is finished.
6849
- Only create new documentation when the user or local instructions explicitly request it; otherwise, edit the canonical file in place.
6950
- When you uncover a reproducible tooling or CI issue, record the repro steps and workaround in the designated troubleshooting doc for that repo.
7051

@@ -106,7 +87,7 @@ Edit guidance: keep the actual tool list inside the `<tools></tools>` block belo
10687
- `git` / `bin/git`: Git shim that forces git through the guardrails; use `./git --help` to inspect.
10788
- `scripts/committer`: Stages the files you list and creates the commit safely.
10889
- `scripts/docs-list.ts`: Walks `docs/`, enforces front-matter, prints summaries; run `tsx scripts/docs-list.ts`.
109-
- `scripts/browser-tools.ts`: Chrome helper for remote control/screenshot/eval; run `ts-node scripts/browser-tools.ts --help`.
90+
- `bin/browser-tools`: Compiled Chrome helper for remote control/screenshot/eval—use the binary (`bin/browser-tools --help`). Source lives in `scripts/browser-tools.ts`; edit there before rebuilding.
11091
- `scripts/runner.ts`: Bun implementation backing `runner`; run `bun scripts/runner.ts --help`.
11192
- `bin/sleep`: Sleep shim that enforces the 30s ceiling; run `bin/sleep --help`.
11293
- `xcp`: Xcode project/workspace helper; run `xcp --help`.
@@ -119,3 +100,5 @@ Edit guidance: keep the actual tool list inside the `<tools></tools>` block belo
119100
</tools>
120101

121102
</tools>
103+
104+
Guideline: ignore any project folders whose names either contain "copy" or end with a number (e.g., `sweetistics copy`, `sweetistics2`, `VibeMeter3`).

0 commit comments

Comments
 (0)