Skip to content

Commit dbbc2ff

Browse files
docs: Update README with v1.4.0 features and context-forge examples
1 parent 96d246f commit dbbc2ff

File tree

1 file changed

+101
-13
lines changed

1 file changed

+101
-13
lines changed

README.md

Lines changed: 101 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ Claude Sub-Agents Manager is a powerful CLI tool that enhances Claude Code with
3333
- **🛠️ Developer First**: Built by developers, for developers
3434
- **🔗 Context-Forge Integration**: Seamlessly works with context-forge projects and PRPs
3535

36+
### 🎉 New in v1.4.0 - Context-Forge Integration
37+
38+
- **🛠️ Full Context-Forge Support**: Automatic detection and smart integration
39+
- **📦 Init Command**: `claude-agents init` for one-command project setup
40+
- **🧹 Uninstall Command**: Bulk removal with cleanup options
41+
- **📁 Smart Command Organization**: No conflicts with existing context-forge commands
42+
- **⚡ Concurrent Execution Rules**: Enforces best practices for maximum performance
43+
- **📝 CLAUDE.md Integration**: Appends configuration without overwriting
44+
- **🎯 PRP Awareness**: Agents understand and work with your existing PRPs
45+
3646
## 🚀 Installation
3747

3848
### NPM (Recommended)
@@ -55,25 +65,75 @@ npm link
5565

5666
## ⚡ Quick Start
5767

68+
### For New Projects
5869
```bash
59-
# Initialize in your project (recommended)
70+
# Initialize all agents in your project
6071
claude-agents init
6172

62-
# Or install agents globally
63-
claude-agents install --all
64-
6573
# List available agents
6674
claude-agents list
75+
```
6776

68-
# Use an agent via slash command
69-
# In Claude Code:
70-
> /review
71-
> /test
72-
> /debug TypeError in production
77+
### For Context-Forge Projects
78+
```bash
79+
# Initialize with context-forge awareness
80+
claude-agents init --respect-context-forge
81+
82+
# Agents will:
83+
# - Detect existing PRPs and CLAUDE.md
84+
# - Place commands in .claude/commands/agents/
85+
# - Append to CLAUDE.md without overwriting
86+
# - Work alongside your existing setup
87+
```
88+
89+
### Example Agent Tasks
90+
91+
```bash
92+
# Project Planning - Reads and understands your PRPs
93+
claude-agents run project-planner --task "Create implementation roadmap from existing PRPs"
94+
claude-agents run project-planner --task "Break down auth-prp into sprint tasks"
95+
96+
# API Development - PRP-aware implementation
97+
claude-agents run api-developer --task "Implement user endpoints from feature-auth-prp.md"
98+
claude-agents run api-developer --task "Create REST API following our conventions"
99+
100+
# Frontend Development
101+
claude-agents run frontend-developer --task "Build login UI matching dark-theme-ui-prp"
102+
claude-agents run frontend-developer --task "Create dashboard from feature-dashboard-prp.md"
103+
104+
# Testing & Quality
105+
claude-agents run tdd-specialist --task "Create tests for authentication flow"
106+
claude-agents run code-reviewer --task "Review API endpoints for security"
107+
claude-agents run security-scanner --task "Scan authentication implementation"
108+
109+
# Documentation
110+
claude-agents run api-documenter --task "Generate OpenAPI spec from implemented endpoints"
111+
claude-agents run doc-writer --task "Update Implementation.md with progress"
112+
113+
# Debugging & Refactoring
114+
claude-agents run debugger --task "Analyze login timeout issue"
115+
claude-agents run refactor --task "Improve error handling in auth module"
116+
117+
# DevOps & Deployment
118+
claude-agents run devops-engineer --task "Setup CI/CD for main branch"
119+
claude-agents run devops-engineer --task "Create Docker configuration"
120+
121+
# Product & Marketing
122+
claude-agents run product-manager --task "Create user stories from PRPs"
123+
claude-agents run marketing-writer --task "Write feature announcement for auth system"
124+
```
125+
126+
### Using in Claude Code
127+
```bash
128+
# Via slash commands (in .claude/commands/agents/)
129+
> /agent-review # Triggers code review
130+
> /agent-api # Triggers API development
131+
> /agent-debug login issue # Debug specific problem
73132

74-
# Works seamlessly with context-forge projects
75-
# Agents automatically detect and use PRPs:
76-
claude-agents run api-developer --task "implement auth endpoints"
133+
# Via Task tool
134+
> Task("project-planner: analyze all PRPs and create sprint plan")
135+
> Task("api-developer: implement endpoints from feature-auth-prp.md")
136+
> Task("frontend-developer: build UI from feature-dashboard-prp.md")
77137
```
78138

79139
## 📋 Available Sub-Agents
@@ -620,7 +680,35 @@ DEBUG=claude-agents claude-agents run <agent> --task "test"
620680
621681
## 📊 Release Notes
622682
623-
### Version 1.0.0 (Latest)
683+
### Version 1.4.0 (Latest) - Context-Forge Integration
684+
- 🛠️ **Context-Forge Support**: Full integration with context-forge projects
685+
- 📦 **Init Command**: One-command setup with `claude-agents init`
686+
- 🧹 **Uninstall Command**: Bulk removal with cleanup options
687+
- 🎯 **PRP Awareness**: Agents understand and work with existing PRPs
688+
- 📁 **Smart Commands**: Organized in `.claude/commands/agents/` to avoid conflicts
689+
- ⚡ **Concurrent Execution**: CLAUDE.md rules for maximum performance
690+
- 📝 **Safe Integration**: Appends to CLAUDE.md without overwriting
691+
- 🔧 **Bug Fixes**: Project scope installation now works correctly
692+
693+
### Version 1.3.1
694+
- 🐛 Fixed "agent not found" error for global installations
695+
- 📍 Enhanced path resolution for various npm configurations
696+
- 🔍 Added debug mode with `DEBUG=claude-agents`
697+
698+
### Version 1.3.0
699+
- 🎯 Context-forge detection utility
700+
- 🧠 Enhanced agent system with PRP awareness
701+
- 💾 Memory system integration
702+
- 📚 Context-aware command templates
703+
704+
### Version 1.2.0
705+
- 🤖 15 specialized AI agents
706+
- ⚡ Concurrent execution patterns
707+
- 💾 Shared memory system
708+
- 🌐 Web dashboard
709+
- 🎯 Slash command integration
710+
711+
### Version 1.0.0
624712
- 🎉 Initial release
625713
- 6 production-ready agents
626714
- Interactive CLI interface

0 commit comments

Comments
 (0)