AGENTS.md · git:20261013.0344f80 · 2026-10-13 · sha256 120d461fd98e36df

AGENTS.md git:20261013.0344f80A

Immutable. This exact content never changes and is served at /api/v1/blob/120d461fd98e36df.

# AGENTS.md

A Claude Code plugin marketplace in ESM.
Code that needs Python is Python, and the tests and `tools/` run on Bun 1.4.3 or later, with `bun install` for the dev dependencies.
The core plugin is in `plugins/dotclaude/`, next to seven add-on plugins: `dotclaude-codegraph`, `dotclaude-browser`, `dotclaude-docs`, `dotclaude-sessions`, `dotclaude-lab`, `dcc-plugin-agents-md`, and `dcc-plugin-you-should-know`.
Each add-on plugin works without the core plugin, so it imports nothing from another plugin.
Only `plugins/` ships to users.
`tests/` has one folder for each plugin, with `tests/dotclaude/<slice>/` for each slice of the core plugin.
`tests/kernel/` tests `src/kernel/`, and `tests/support/` holds the helpers of the tests.
`tools/` holds the repository scripts.
`src/` holds the source of each plugin, the shared kernel, and each text that a plugin ships, such as the agents, the skills, and `hooks.json`.
Edit the source in `src/` and run `just generate`, because a test fails when a generated file differs from its source.
Do not edit `plugins/` by hand.
Docs, design, and evidence: the [wiki](https://github.com/xsyetopz/dotclaude/wiki), with its source in `wiki/`.

The rules that apply to some files only are in [`.claude/rules/`](.claude/rules/).
Each of those rules has a `paths:` list, and Claude Code loads the rule when Claude works on a matching file.

## Commands (repository root)

- `just check` runs lint, the type check, the check of the generated files, tests, validation, and the hook labs.
  It must pass before done.
- `just test tests/dotclaude/guard/rules.test.ts` runs one test file with `bun test`.
- `just lab` runs the hook lab of each plugin: the tests of its hooks module with stubbed Claude Code events.
  Test each change to `hooks/register.ts` there before a live session.
- `bun run lint:md` lints the Markdown files.
  Headings and code blocks have a 100-column bound.
- `just sandbox` runs Claude Code with this checkout in a separate config.
  Read `wiki/plugins/Sandbox.md` first.

## Rules

- Use the env vars of Claude Code and flags.
  Add a dotclaude env var only when neither can do the work, and give it the prefix `DOTCLAUDE_`.
- Keep each file at 300 lines or less, and each test file at 500 lines or less, which `just validate` checks.
  Split a larger file into files that each hold one concern, and split a long `.md` file into linked parts.
  Generated files, such as `schemas/`, are out of scope.
- Write docs in STE-flavored ASD-STE100.
  Use no semicolons.
- Use semantic line breaks in all text that is not code: Markdown, comments, messages to Claude, commit messages, pull requests, and chat replies.
  Start each sentence on a new line, and break a long sentence only between clauses.
  Never break a line at a column or in a word.
- Put each code item in inline code (single backticks) in all text that is not code: Markdown, comments, test names, messages to Claude, commit messages, pull requests, and chat replies.
  A code item is a command, a tool name, a file path, an identifier, a settings key, an env var, or a literal value, such as `cat F`, `Read`, `hooks.json`, and `maxTurns`.
  The backticks show a reader, a person or a model, which words are code and which words are prose.
- Change a shared runtime bound only in `src/kernel/budget.ts`,
  a slice bound only in `slices/<s>/limits.ts`,
  and a repository bound only in `tools/limits.ts`.
  Tests pin the copies of each bound in code and config, not in prose.
- Never patch the Claude Code CLI binary or its npm package, although it is minified JavaScript that you can read.
  A patch violates Anthropic's terms of service.
  Use only documented extension points.
  Reading the bundle for evidence is permitted.
- Run the sandbox sessions and the measurements of a package yourself, and do not give them to the user.
  The user approves the use of their login in `just sandbox` and `just sandbox-alone` for this work (the user, 2026-10-13).
  When a guard stops a sandbox session in a subagent, run that session from the main session (the user, 2026-10-13).
  Write the results, with the method, to the evidence file of the package.
- Add CHANGELOG entries under `[Unreleased]`.
  Change versions with `just bump`.
- Write public docs in `wiki/`, and run `just wiki` to publish them.
  `docs/README.md` only links to the wiki.
  `external/` holds local sources, and git ignores it.