Skip to content

docs: trim README ~80%, de-duplicate with AGENTS.md #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vaintrub merged 2 commits into from
May 31, 2026
Merged

docs: trim README ~80%, de-duplicate with AGENTS.md #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f756e94
docs: trim README ~80%, de-duplicate with AGENTS.md
vaintrub May 31, 2026
f066c5f
docs(agents): add Claude/Codex not-tracked + never-commit list
vaintrub May 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,19 @@ Source-of-truth location is `~/.local/share/chezmoi/` — chezmoi's default (XDG
install for its Claude side; Codex side is manual (`npx skills add ...
-a codex` doesn't currently wire per-agent symlinks).

### Claude/Codex — NOT tracked (machine-local; some are secrets — never commit)

Only user-curated config is tracked. These stay out of the repo:

- `~/.claude/settings.local.json` — per-machine permissions allowlist (Anthropic's documented convention is to gitignore it).
- `~/.claude/plugins/{installed_plugins,known_marketplaces}.json` — absolute install paths + per-user marketplace registrations.
- **`~/.claude.json`** — lives at `$HOME`, not `~/.claude/`. Holds OAuth tokens, MCP server credentials, NUX `tipsHistory`. **Never commit.**
- `~/.codex/auth.json`, `installation_id` — secrets + per-machine identifiers.
- `~/.codex/{sessions,cache,log,tmp,history.jsonl,*.sqlite}`, `memories/`, `plugins/` — runtime state / cloned plugin repos.
- `~/.claude/RTK.md`, `~/.codex/RTK.md` — written fresh by `rtk init` (bundled rtk version's content, not ours). `.chezmoiignore`d.

We also deliberately don't manage `~/.claude/commands/` (deprecated by skills upstream) or `~/.claude/hooks/` (not a Claude dir convention — hooks live inline in `settings.json`).

### Bootstrap scripts — `.chezmoiscripts/`

Scripts here don't create `$HOME` files (no `dot_*` sibling). They run as part
Expand Down
Loading
Loading