Skip to content

Commit 88cc372

Browse files
committed
docs(cc-agents): add comprehensive README with agent catalog and usage guide
- Add detailed documentation for CC Agents feature - Include agent catalog with Git Commit Bot, Security Scanner, and Unit Tests Bot - Document import/export functionality and file format specifications - Provide technical implementation details for backend and frontend - Add contributing guidelines for community agent development - Include visual elements with badges and structured tables for better UX
1 parent 5b55695 commit 88cc372

File tree

1 file changed

+148
-0
lines changed

1 file changed

+148
-0
lines changed

cc_agents/README.md

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
# 🤖 Claudia CC Agents
2+
3+
<div align="center">
4+
<p>
5+
<strong>Pre-built AI agents for Claudia powered by Claude Code</strong>
6+
</p>
7+
<p>
8+
<a href="#available-agents">Browse Agents</a> •
9+
<a href="#importing-agents">Import Guide</a> •
10+
<a href="#exporting-agents">Export Guide</a> •
11+
<a href="#contributing">Contribute</a>
12+
</p>
13+
</div>
14+
15+
---
16+
17+
## 📦 Available Agents
18+
19+
| Agent | Model | Permissions | Description | Default Task |
20+
|-------|-------|-------------|-------------|--------------|
21+
| **🎯 Git Commit Bot**<br/>🤖 `bot` | <img src="https://img.shields.io/badge/Sonnet-blue?style=flat-square" alt="Sonnet"> | ✅ File Read<br/>✅ File Write<br/>✅ Network<br/>❌ Sandbox | **Automate your Git workflow with intelligent commit messages**<br/><br/>Analyzes Git repository changes, generates detailed commit messages following Conventional Commits specification, and pushes changes to remote repository. | "Push all changes." |
22+
| **🛡️ Security Scanner**<br/>🛡️ `shield` | <img src="https://img.shields.io/badge/Opus-purple?style=flat-square" alt="Opus"> | ✅ File Read<br/>✅ File Write<br/>❌ Network<br/>❌ Sandbox | **Advanced AI-powered Static Application Security Testing (SAST)**<br/><br/>Performs comprehensive security audits by spawning specialized sub-agents for: codebase intelligence gathering, threat modeling (STRIDE), vulnerability scanning (OWASP Top 10, CWE), exploit validation, remediation design, and professional report generation. | "Review the codebase for security issues." |
23+
| **🧪 Unit Tests Bot**<br/>💻 `code` | <img src="https://img.shields.io/badge/Opus-purple?style=flat-square" alt="Opus"> | ✅ File Read<br/>✅ File Write<br/>❌ Network<br/>❌ Sandbox | **Automated comprehensive unit test generation for any codebase**<br/><br/>Analyzes codebase and generates comprehensive unit tests by: analyzing code structure, creating test plans, writing tests matching your style, verifying execution, optimizing coverage (>80% overall, 100% critical paths), and generating documentation. | "Generate unit tests for this codebase." |
24+
25+
### Available Icons
26+
27+
Choose from these icon options when creating agents:
28+
- `bot` - 🤖 General purpose
29+
- `shield` - 🛡️ Security related
30+
- `code` - 💻 Development
31+
- `terminal` - 🖥️ System/CLI
32+
- `database` - 🗄️ Data operations
33+
- `globe` - 🌐 Network/Web
34+
- `file-text` - 📄 Documentation
35+
- `git-branch` - 🌿 Version control
36+
37+
---
38+
39+
## 📥 Importing Agents
40+
41+
### Method 1: Import from GitHub (Recommended)
42+
43+
1. In Claudia, navigate to **CC Agents**
44+
2. Click the **Import** dropdown button
45+
3. Select **From GitHub**
46+
4. Browse available agents from the official repository
47+
5. Preview agent details and click **Import Agent**
48+
49+
### Method 2: Import from Local File
50+
51+
1. Download a `.claudia.json` file from this repository
52+
2. In Claudia, navigate to **CC Agents**
53+
3. Click the **Import** dropdown button
54+
4. Select **From File**
55+
5. Choose the downloaded `.claudia.json` file
56+
57+
## 📤 Exporting Agents
58+
59+
### Export Your Custom Agents
60+
61+
1. In Claudia, navigate to **CC Agents**
62+
2. Find your agent in the grid
63+
3. Click the **Export** button
64+
4. Choose where to save the `.claudia.json` file
65+
66+
### Agent File Format
67+
68+
All agents are stored in `.claudia.json` format with the following structure:
69+
70+
```json
71+
{
72+
"version": 1,
73+
"exported_at": "2025-01-23T14:29:58.156063+00:00",
74+
"agent": {
75+
"name": "Your Agent Name",
76+
"icon": "bot",
77+
"model": "opus|sonnet|haiku",
78+
"system_prompt": "Your agent's instructions...",
79+
"default_task": "Default task description",
80+
"sandbox_enabled": false,
81+
"enable_file_read": true,
82+
"enable_file_write": true,
83+
"enable_network": false
84+
}
85+
}
86+
```
87+
88+
## 🔧 Technical Implementation
89+
90+
### How Import/Export Works
91+
92+
The agent import/export system is built on a robust architecture:
93+
94+
#### Backend (Rust/Tauri)
95+
- **Storage**: SQLite database stores agent configurations
96+
- **Export**: Serializes agent data to JSON with version control
97+
- **Import**: Validates and deduplicates agents on import
98+
- **GitHub Integration**: Fetches agents via GitHub API
99+
100+
#### Frontend (React/TypeScript)
101+
- **UI Components**:
102+
- `CCAgents.tsx` - Main agent management interface
103+
- `GitHubAgentBrowser.tsx` - GitHub repository browser
104+
- `CreateAgent.tsx` - Agent creation/editing form
105+
- **File Operations**: Native file dialogs for import/export
106+
- **Real-time Updates**: Live agent status and execution monitoring
107+
108+
### Key Features
109+
110+
1. **Version Control**: Each agent export includes version metadata
111+
2. **Duplicate Prevention**: Automatic naming conflict resolution
112+
3. **Permission System**: Granular control over file, network, and sandbox access
113+
4. **Model Selection**: Choose between Opus, Sonnet, and Haiku models
114+
5. **GitHub Integration**: Direct import from the official repository
115+
116+
## 🤝 Contributing
117+
118+
We welcome agent contributions! Here's how to add your agent:
119+
120+
### 1. Create Your Agent
121+
Design and test your agent in Claudia with a clear, focused purpose.
122+
123+
### 2. Export Your Agent
124+
Export your agent to a `.claudia.json` file with a descriptive name.
125+
126+
### 3. Submit a Pull Request
127+
1. Fork this repository
128+
2. Add your `.claudia.json` file to the `cc_agents` directory
129+
3. Update this README with your agent's details
130+
4. Submit a PR with a description of what your agent does
131+
132+
### Agent Guidelines
133+
134+
- **Single Purpose**: Each agent should excel at one specific task
135+
- **Clear Documentation**: Write comprehensive system prompts
136+
- **Safe Defaults**: Be conservative with permissions
137+
- **Model Choice**: Use Haiku for simple tasks, Sonnet for general purpose, Opus for complex reasoning
138+
- **Naming**: Use descriptive names that clearly indicate the agent's function
139+
140+
## 📜 License
141+
142+
These agents are provided under the same license as the Claudia project. See the main LICENSE file for details.
143+
144+
---
145+
146+
<div align="center">
147+
<strong>Built with ❤️ by the Claudia community</strong>
148+
</div>

0 commit comments

Comments
 (0)