Browse Source

docs: Update README and AGENTS with current structure

- Update structure diagram with accurate counts and directories
- Fix testing section (justfile now in tests/)
- Remove license section (file removed)
- Expand AGENTS.md with project overview and key directories

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
0xDarkMatter 4 months ago
parent
commit
6f6831f8f6
2 changed files with 46 additions and 13 deletions
  1. 33 1
      AGENTS.md
  2. 13 12
      README.md

+ 33 - 1
AGENTS.md

@@ -1,9 +1,41 @@
 # Agent Instructions
 # Agent Instructions
 
 
+## Project Overview
+
+This is **claude-mods** - a collection of custom extensions for Claude Code:
+- **24 expert agents** for specialized domains (React, Python, AWS, etc.)
+- **11 slash commands** for workflows (/sync, /plan, /review, etc.)
+- **10 skills** for CLI tool integration (git-workflow, code-stats, etc.)
+
+## Key Directories
+
+| Directory | Purpose |
+|-----------|---------|
+| `agents/` | Expert subagent prompts (.md files) |
+| `commands/` | Slash command definitions |
+| `skills/` | Skill definitions with SKILL.md |
+| `rules/` | Claude Code rules (cli-tools.md) |
+| `tools/` | Modern CLI toolkit documentation |
+| `tests/` | Validation scripts + justfile |
+| `scripts/` | Install scripts |
+| `docs/` | PLAN.md, DASH.md |
+
 ## Session Init
 ## Session Init
 
 
 On "INIT:" message at session start:
 On "INIT:" message at session start:
 1. Read the specified file (.claude/.context-init.md)
 1. Read the specified file (.claude/.context-init.md)
 2. Proceed with user request - no summary needed
 2. Proceed with user request - no summary needed
 
 
-This ensures you have project context before making any changes.
+## CLI Tool Preferences
+
+See `rules/cli-tools.md` for modern CLI tool preferences:
+- Use `rg` over grep, `fd` over find, `eza` over ls
+- Use `bat` over cat, `dust` over du, `tldr` over man
+- Web fetching: WebFetch → Jina → firecrawl → firecrawl-expert
+
+## Testing
+
+Run from `tests/` directory:
+```bash
+cd tests && just test
+```

+ 13 - 12
README.md

@@ -6,13 +6,15 @@ Custom commands, skills, and agents for [Claude Code](https://docs.anthropic.com
 
 
 ```
 ```
 claude-mods/
 claude-mods/
-├── commands/           # Slash commands
-├── skills/             # Custom skills
-├── agents/             # Custom subagents
+├── agents/             # Expert subagents (24)
+├── commands/           # Slash commands (11)
+├── skills/             # Custom skills (10)
+├── rules/              # Claude Code rules
 ├── tools/              # Modern CLI toolkit docs
 ├── tools/              # Modern CLI toolkit docs
-├── rules/              # Claude Code rules (cli-tools.md)
-├── tests/              # Test suites and justfile
-└── scripts/            # Install scripts
+├── tests/              # Test suites + justfile
+├── scripts/            # Install scripts
+├── docs/               # Project docs (PLAN.md, DASH.md)
+└── templates/          # Extension templates
 ```
 ```
 
 
 ## Installation
 ## Installation
@@ -130,14 +132,16 @@ See [tools/README.md](tools/README.md) for full documentation and install script
 Validate all extensions before committing:
 Validate all extensions before committing:
 
 
 ```bash
 ```bash
+cd tests
+
 # Run full validation (requires just)
 # Run full validation (requires just)
 just test
 just test
 
 
 # Or run directly
 # Or run directly
-bash tests/validate.sh
+bash validate.sh
 
 
 # Windows
 # Windows
-powershell tests/validate.ps1
+powershell validate.ps1
 ```
 ```
 
 
 ### What's Validated
 ### What's Validated
@@ -149,6 +153,7 @@ powershell tests/validate.ps1
 ### Available Tasks
 ### Available Tasks
 
 
 ```bash
 ```bash
+cd tests
 just              # List all tasks
 just              # List all tasks
 just test         # Run full validation
 just test         # Run full validation
 just validate-yaml # YAML only
 just validate-yaml # YAML only
@@ -216,10 +221,6 @@ git pull
 
 
 Then re-run the install script to update your global Claude configuration.
 Then re-run the install script to update your global Claude configuration.
 
 
-## License
-
-MIT
-
 ---
 ---
 
 
 *Extend Claude Code. Your way.*
 *Extend Claude Code. Your way.*