From 88cc37203bef71a3c6ec1e4dfa054b79e12aee0a Mon Sep 17 00:00:00 2001 From: Mufeed VH Date: Wed, 25 Jun 2025 03:29:09 +0530 Subject: [PATCH] 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 --- cc_agents/README.md | 148 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 148 insertions(+) create mode 100644 cc_agents/README.md diff --git a/cc_agents/README.md b/cc_agents/README.md new file mode 100644 index 0000000..1147a25 --- /dev/null +++ b/cc_agents/README.md @@ -0,0 +1,148 @@ +# ๐Ÿค– Claudia CC Agents + +
+

+ Pre-built AI agents for Claudia powered by Claude Code +

+

+ Browse Agents โ€ข + Import Guide โ€ข + Export Guide โ€ข + Contribute +

+
+ +--- + +## ๐Ÿ“ฆ Available Agents + +| Agent | Model | Permissions | Description | Default Task | +|-------|-------|-------------|-------------|--------------| +| **๐ŸŽฏ Git Commit Bot**
๐Ÿค– `bot` | Sonnet | โœ… File Read
โœ… File Write
โœ… Network
โŒ Sandbox | **Automate your Git workflow with intelligent commit messages**

Analyzes Git repository changes, generates detailed commit messages following Conventional Commits specification, and pushes changes to remote repository. | "Push all changes." | +| **๐Ÿ›ก๏ธ Security Scanner**
๐Ÿ›ก๏ธ `shield` | Opus | โœ… File Read
โœ… File Write
โŒ Network
โŒ Sandbox | **Advanced AI-powered Static Application Security Testing (SAST)**

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." | +| **๐Ÿงช Unit Tests Bot**
๐Ÿ’ป `code` | Opus | โœ… File Read
โœ… File Write
โŒ Network
โŒ Sandbox | **Automated comprehensive unit test generation for any codebase**

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." | + +### Available Icons + +Choose from these icon options when creating agents: +- `bot` - ๐Ÿค– General purpose +- `shield` - ๐Ÿ›ก๏ธ Security related +- `code` - ๐Ÿ’ป Development +- `terminal` - ๐Ÿ–ฅ๏ธ System/CLI +- `database` - ๐Ÿ—„๏ธ Data operations +- `globe` - ๐ŸŒ Network/Web +- `file-text` - ๐Ÿ“„ Documentation +- `git-branch` - ๐ŸŒฟ Version control + +--- + +## ๐Ÿ“ฅ Importing Agents + +### Method 1: Import from GitHub (Recommended) + +1. In Claudia, navigate to **CC Agents** +2. Click the **Import** dropdown button +3. Select **From GitHub** +4. Browse available agents from the official repository +5. Preview agent details and click **Import Agent** + +### Method 2: Import from Local File + +1. Download a `.claudia.json` file from this repository +2. In Claudia, navigate to **CC Agents** +3. Click the **Import** dropdown button +4. Select **From File** +5. Choose the downloaded `.claudia.json` file + +## ๐Ÿ“ค Exporting Agents + +### Export Your Custom Agents + +1. In Claudia, navigate to **CC Agents** +2. Find your agent in the grid +3. Click the **Export** button +4. Choose where to save the `.claudia.json` file + +### Agent File Format + +All agents are stored in `.claudia.json` format with the following structure: + +```json +{ + "version": 1, + "exported_at": "2025-01-23T14:29:58.156063+00:00", + "agent": { + "name": "Your Agent Name", + "icon": "bot", + "model": "opus|sonnet|haiku", + "system_prompt": "Your agent's instructions...", + "default_task": "Default task description", + "sandbox_enabled": false, + "enable_file_read": true, + "enable_file_write": true, + "enable_network": false + } +} +``` + +## ๐Ÿ”ง Technical Implementation + +### How Import/Export Works + +The agent import/export system is built on a robust architecture: + +#### Backend (Rust/Tauri) +- **Storage**: SQLite database stores agent configurations +- **Export**: Serializes agent data to JSON with version control +- **Import**: Validates and deduplicates agents on import +- **GitHub Integration**: Fetches agents via GitHub API + +#### Frontend (React/TypeScript) +- **UI Components**: + - `CCAgents.tsx` - Main agent management interface + - `GitHubAgentBrowser.tsx` - GitHub repository browser + - `CreateAgent.tsx` - Agent creation/editing form +- **File Operations**: Native file dialogs for import/export +- **Real-time Updates**: Live agent status and execution monitoring + +### Key Features + +1. **Version Control**: Each agent export includes version metadata +2. **Duplicate Prevention**: Automatic naming conflict resolution +3. **Permission System**: Granular control over file, network, and sandbox access +4. **Model Selection**: Choose between Opus, Sonnet, and Haiku models +5. **GitHub Integration**: Direct import from the official repository + +## ๐Ÿค Contributing + +We welcome agent contributions! Here's how to add your agent: + +### 1. Create Your Agent +Design and test your agent in Claudia with a clear, focused purpose. + +### 2. Export Your Agent +Export your agent to a `.claudia.json` file with a descriptive name. + +### 3. Submit a Pull Request +1. Fork this repository +2. Add your `.claudia.json` file to the `cc_agents` directory +3. Update this README with your agent's details +4. Submit a PR with a description of what your agent does + +### Agent Guidelines + +- **Single Purpose**: Each agent should excel at one specific task +- **Clear Documentation**: Write comprehensive system prompts +- **Safe Defaults**: Be conservative with permissions +- **Model Choice**: Use Haiku for simple tasks, Sonnet for general purpose, Opus for complex reasoning +- **Naming**: Use descriptive names that clearly indicate the agent's function + +## ๐Ÿ“œ License + +These agents are provided under the same license as the Claudia project. See the main LICENSE file for details. + +--- + +
+ Built with โค๏ธ by the Claudia community +
\ No newline at end of file