feat: add custom agents and slash commands
Add comprehensive custom agents for specialized workflows: - gentoo-sysadmin: Gentoo Linux system administration (OpenRC, Portage) - tdd-test-writer: TDD Ping-Pong workflow implementation - code-reviewer: Code review against strict style guidelines - documentation-writer: Comprehensive project documentation - python-ai-tutor: AI/ML coursework assistant with teaching focus - dotfiles-manager: Dotfiles management with chezmoi Add custom slash commands for quick workflows: - /gentoo-update: Safe Gentoo system update procedure - /tdd-next: Start next TDD test cycle - /style-check: Comprehensive code style validation - /doc-sync: Update all project documentation - /review-pr: Review pull request before merge - /script-install: Install system script with proper permissions Updated .gitignore to properly track agents and commands while excluding session-specific data (plans/, etc.) Added README.md documenting the configuration structure and usage. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
168
README.md
Normal file
168
README.md
Normal file
@@ -0,0 +1,168 @@
|
||||
# Claude Code Configuration
|
||||
|
||||
This directory contains global Claude Code configuration that is synced
|
||||
across machines via git.
|
||||
|
||||
## What's Tracked
|
||||
|
||||
### Global Instructions
|
||||
- **CLAUDE.md** - Global working preferences, code style standards, TDD
|
||||
workflow, and communication style
|
||||
|
||||
### Settings
|
||||
- **settings.json** - Claude Code application settings
|
||||
|
||||
### Custom Agents (`agents/`)
|
||||
Specialized agents for specific workflows:
|
||||
- **gentoo-sysadmin.json** - Gentoo Linux system administration (OpenRC,
|
||||
Portage, kernel)
|
||||
- **tdd-test-writer.json** - TDD Ping-Pong workflow (writes failing tests)
|
||||
- **code-reviewer.json** - Code review against strict style guidelines
|
||||
- **documentation-writer.json** - Creates comprehensive project documentation
|
||||
- **python-ai-tutor.json** - AI/ML coursework assistant with teaching focus
|
||||
- **dotfiles-manager.json** - Dotfiles management with chezmoi
|
||||
|
||||
### Slash Commands (`commands/`)
|
||||
Quick workflow commands:
|
||||
- **/gentoo-update** - Safe Gentoo system update workflow
|
||||
- **/tdd-next** - Start next TDD test cycle
|
||||
- **/style-check** - Comprehensive code style validation
|
||||
- **/doc-sync** - Update all project documentation
|
||||
- **/review-pr** - Review pull request before merge
|
||||
- **/script-install** - Install system script with proper permissions
|
||||
|
||||
## What's NOT Tracked
|
||||
|
||||
The `.gitignore` excludes machine-specific and sensitive data:
|
||||
- `.credentials.json` - Authentication tokens (SENSITIVE)
|
||||
- `history.jsonl` - Conversation history (machine-specific)
|
||||
- `todos/` - Session-specific todo lists
|
||||
- `projects/` - Project state (machine-specific paths)
|
||||
- `session-env/` - Session environment data
|
||||
- `file-history/` - File version history
|
||||
- `plans/` - Plan mode drafts
|
||||
- `debug/`, `downloads/`, `statsig/` - Temporary/analytics data
|
||||
|
||||
## Using Custom Agents
|
||||
|
||||
Custom agents are invoked using the Task tool:
|
||||
|
||||
```python
|
||||
# In conversation context
|
||||
Use the Task tool with subagent_type matching the agent name
|
||||
```
|
||||
|
||||
Or via CLI:
|
||||
```bash
|
||||
claude --agents '{"review": "~/.claude/agents/code-reviewer.json"}'
|
||||
```
|
||||
|
||||
## Using Slash Commands
|
||||
|
||||
In Claude Code conversation:
|
||||
```
|
||||
/gentoo-update
|
||||
/tdd-next
|
||||
/style-check
|
||||
/doc-sync
|
||||
/review-pr <pr-number>
|
||||
/script-install
|
||||
```
|
||||
|
||||
## Setup on New Machine
|
||||
|
||||
1. Clone this repository:
|
||||
```bash
|
||||
cd ~/.claude
|
||||
git init
|
||||
git remote add origin <your-repo-url>
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
2. Set up credentials (not tracked):
|
||||
```bash
|
||||
claude setup-token
|
||||
```
|
||||
|
||||
3. Verify configuration:
|
||||
```bash
|
||||
cat CLAUDE.md
|
||||
ls agents/
|
||||
ls commands/
|
||||
```
|
||||
|
||||
## Style Guidelines
|
||||
|
||||
All code follows strict standards defined in `CLAUDE.md`:
|
||||
- 80-character line limit
|
||||
- 2-space indentation
|
||||
- Language-specific conventions (PEP 8, Airbnb, POSIX sh)
|
||||
- Minimal comments
|
||||
- Security-first approach
|
||||
- TDD Ping-Pong workflow for development
|
||||
|
||||
## Maintenance
|
||||
|
||||
### Adding New Agents
|
||||
1. Create `agents/<name>.json` with:
|
||||
- `name`: Agent identifier
|
||||
- `description`: When to use this agent
|
||||
- `prompt`: Detailed agent instructions
|
||||
2. Commit and push
|
||||
|
||||
### Adding New Commands
|
||||
1. Create `commands/<name>.md` with markdown instructions
|
||||
2. Commit and push
|
||||
|
||||
### Updating Global Instructions
|
||||
1. Edit `CLAUDE.md`
|
||||
2. Test with a few conversations
|
||||
3. Commit and push
|
||||
|
||||
## Repository Structure
|
||||
|
||||
```
|
||||
~/.claude/
|
||||
├── README.md # This file
|
||||
├── CLAUDE.md # Global instructions
|
||||
├── settings.json # Application settings
|
||||
├── .gitignore # Ignore patterns
|
||||
├── agents/ # Custom agents (tracked)
|
||||
│ ├── gentoo-sysadmin.json
|
||||
│ ├── tdd-test-writer.json
|
||||
│ ├── code-reviewer.json
|
||||
│ ├── documentation-writer.json
|
||||
│ ├── python-ai-tutor.json
|
||||
│ └── dotfiles-manager.json
|
||||
├── commands/ # Slash commands (tracked)
|
||||
│ ├── gentoo-update.md
|
||||
│ ├── tdd-next.md
|
||||
│ ├── style-check.md
|
||||
│ ├── doc-sync.md
|
||||
│ ├── review-pr.md
|
||||
│ └── script-install.md
|
||||
└── [ignored directories] # Machine-specific data (not tracked)
|
||||
├── .credentials.json
|
||||
├── history.jsonl
|
||||
├── todos/
|
||||
├── projects/
|
||||
├── session-env/
|
||||
├── file-history/
|
||||
├── plans/
|
||||
├── debug/
|
||||
├── downloads/
|
||||
└── statsig/
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
When adding or modifying agents/commands:
|
||||
1. Follow the existing format
|
||||
2. Test thoroughly
|
||||
3. Update this README if adding new categories
|
||||
4. Use semantic commit messages
|
||||
5. Keep documentation in sync
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-11-26
|
||||
Reference in New Issue
Block a user