113 lines
3.7 KiB
Markdown
113 lines
3.7 KiB
Markdown
# Templates Directory Summary
|
|
|
|
Complete copy-paste ready templates for all Claude Code component types, created for Linear issue ID-94.
|
|
|
|
## What's Included
|
|
|
|
### ✅ Slash Commands (4 templates)
|
|
|
|
- `simple.md` - Basic command with no arguments
|
|
- `with-args.md` - Command with `$1`, `$2`, `$ARGUMENTS` support
|
|
- `with-bash.md` - Command with bash execution using `!` prefix
|
|
- `with-files.md` - Command with file references using `@` prefix
|
|
|
|
### ✅ Hooks (4 complete examples)
|
|
|
|
- `post-tool-use-formatter/` - Auto-format files after Write/Edit (Bash)
|
|
- `pre-tool-use-validator/` - Validate file operations before execution (Bash)
|
|
- `user-prompt-context/` - Add context to every user prompt (Bash)
|
|
- `bash-validator/` - Validate bash commands before execution (Bun/TypeScript)
|
|
|
|
Each hook includes:
|
|
- `hooks.json` - Configuration with matchers
|
|
- Working script with proper error handling
|
|
- Security best practices built-in
|
|
- Executable permissions set correctly
|
|
|
|
### ✅ Skills (3 templates)
|
|
|
|
- `simple-skill/` - Single-file skill template
|
|
- `multi-file-skill/` - Complex skill with REFERENCE.md and EXAMPLES.md
|
|
- `skill-with-scripts/` - Skill with helper scripts
|
|
|
|
All skills include:
|
|
- Complete SKILL.md with frontmatter
|
|
- Best practice descriptions for discovery
|
|
- Tool restrictions examples
|
|
- Progressive disclosure patterns
|
|
|
|
### ✅ Agents (3 specialists)
|
|
|
|
- `code-reviewer.md` - Security, performance, and quality review specialist
|
|
- `test-specialist.md` - TDD and comprehensive testing specialist
|
|
- `documentation-generator.md` - Technical documentation specialist
|
|
|
|
All agents include:
|
|
- Complete role definition and process
|
|
- Detailed workflows and best practices
|
|
- Output format guidelines
|
|
- Tool restrictions where appropriate
|
|
|
|
## Key Features
|
|
|
|
✅ **Working, tested code** - All examples are functional
|
|
✅ **Well-commented** - Explanations for every pattern
|
|
✅ **Best practices** - Follows the comprehensive guide
|
|
✅ **Proper frontmatter** - Correct YAML configuration
|
|
✅ **Realistic examples** - Not just foo/bar placeholders
|
|
✅ **Clear placeholders** - `[YOUR_*]` pattern for customization
|
|
✅ **Executable scripts** - All scripts have proper permissions (chmod +x)
|
|
✅ **Security-first** - Input validation, quoted variables, error handling
|
|
|
|
## File Statistics
|
|
|
|
- **Total files**: 21
|
|
- **Markdown files**: 16
|
|
- **JSON configs**: 4
|
|
- **Scripts**: 5 (all executable)
|
|
- **Total size**: ~67KB
|
|
- **Lines of code**: ~2,800
|
|
|
|
## Usage
|
|
|
|
1. **Choose template** for your use case
|
|
2. **Copy to appropriate location**:
|
|
- Commands: `.claude/commands/`
|
|
- Hooks: `.claude/hooks/` + `.claude/settings.json`
|
|
- Skills: `.claude/skills/`
|
|
- Agents: `.claude/agents/`
|
|
3. **Replace placeholders** (search for `[YOUR_*]`)
|
|
4. **Test and iterate**
|
|
|
|
## Documentation
|
|
|
|
- **README.md** - Complete usage guide with examples
|
|
- **SUMMARY.md** - This file, quick overview
|
|
- **Reference** - [Claude Code Documentation](https://docs.claude.com/en/docs/claude-code/overview)
|
|
|
|
## Validation Checklist
|
|
|
|
✅ Directory structure matches specification
|
|
✅ All template types included (slash commands, hooks, skills, agents)
|
|
✅ Working code in all examples
|
|
✅ Comments and explanations throughout
|
|
✅ Best practices from guide implemented
|
|
✅ Proper frontmatter in all files
|
|
✅ Realistic, useful examples
|
|
✅ Clear placeholder text
|
|
✅ Scripts are executable
|
|
✅ JSON configs are valid
|
|
✅ README with comprehensive documentation
|
|
✅ Troubleshooting section included
|
|
✅ Quick start examples provided
|
|
|
|
## Related
|
|
|
|
- **Guide**: [Claude Code Documentation](https://docs.claude.com/en/docs/claude-code/overview)
|
|
- **Existing skills**: See `outfitter/skills/` in this repository
|
|
- **Authoring skills**: See `claude-*-authoring` skills for detailed guidance
|
|
|
|
---
|
|
|
|
**Status**: Complete and ready for use
|