docs: update nested READMEs in tools/, documents/, agents/ to reflect current contents
This commit is contained in:
+25
-8
@@ -1,17 +1,34 @@
|
||||
# Agents
|
||||
|
||||
Per-agent configuration, context, and notes for AI tools working in this environment.
|
||||
Per-agent configuration, context, and notes for AI coding tools working in this environment.
|
||||
|
||||
Each file is tailored to a specific AI coding agent — its quirks, best practices, and how to get the most out of it in Jacob Mathison's stack.
|
||||
Each file is tailored to a specific agent — workspace paths, behavioral rules, tool patterns, and environment-specific tips.
|
||||
|
||||
## Agents
|
||||
|
||||
| File | Agent | Notes |
|
||||
|------|-------|-------|
|
||||
| [`claude.md`](./claude.md) | Anthropic Claude (Claude Code / API) | |
|
||||
| [`cursor.md`](./cursor.md) | Cursor IDE AI | |
|
||||
| [`codex.md`](./codex.md) | OpenAI Codex / ChatGPT with code access | |
|
||||
| File | Agent | Status |
|
||||
|------|-------|--------|
|
||||
| [`claude.md`](./claude.md) | Anthropic Claude (Claude Code / API) | ✅ Filled |
|
||||
| [`cursor.md`](./cursor.md) | Cursor IDE AI | 🔲 Blank |
|
||||
| [`codex.md`](./codex.md) | OpenAI Codex / ChatGPT with code access | 🔲 Blank |
|
||||
|
||||
## How to Use
|
||||
|
||||
When starting a session with one of these agents, point it at the relevant file alongside the surface guides (`gitea.llm.md`, `github.llm.md`, `aws-cli.llm.md`) for full context.
|
||||
Point your agent at the relevant file at session start alongside the surface guides in `tools/` for full context:
|
||||
|
||||
```
|
||||
tools/gitea.llm.md → local git access
|
||||
tools/github.llm.md → GitHub access
|
||||
tools/aws-cli.llm.md → AWS access
|
||||
tools/tailscale.llm.md → network / machines
|
||||
tools/vault.llm.md → secrets
|
||||
tools/k8s.llm.md → local services
|
||||
tools/local-llm.llm.md → local LLMs
|
||||
tools/claude-cli.md → Claude Code CLI reference
|
||||
tools/codex-cli.md → Codex CLI reference
|
||||
tools/cursor-cli.md → Cursor reference
|
||||
```
|
||||
|
||||
## Adding a New Agent
|
||||
|
||||
Create `<agent-slug>.md` in this folder, then update `agents/README.md` and `manifest.json`.
|
||||
|
||||
Reference in New Issue
Block a user