ccsetup 1.0.6 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +251 -16
- package/bin/create-project.js +983 -129
- package/package.json +25 -6
- package/template/.claude/README.md +24 -0
- package/template/.claude/agents/README.md +44 -0
- package/template/CLAUDE.md +21 -2
- package/template/agents/backend.md +80 -0
- package/template/docs/agent-orchestration.md +152 -0
package/package.json
CHANGED
|
@@ -1,11 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ccsetup",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.7",
|
|
4
4
|
"description": "Boilerplate for Claude Code projects with agents, tickets, and plans",
|
|
5
5
|
"bin": {
|
|
6
|
-
"ccsetup": "
|
|
6
|
+
"ccsetup": "bin/create-project.js"
|
|
7
7
|
},
|
|
8
|
-
"keywords": [
|
|
8
|
+
"keywords": [
|
|
9
|
+
"claude",
|
|
10
|
+
"boilerplate",
|
|
11
|
+
"project-template",
|
|
12
|
+
"claude-code",
|
|
13
|
+
"ai",
|
|
14
|
+
"development"
|
|
15
|
+
],
|
|
9
16
|
"author": "marcia_ong",
|
|
10
17
|
"contributors": [
|
|
11
18
|
"hima7459",
|
|
@@ -14,14 +21,26 @@
|
|
|
14
21
|
"license": "MIT",
|
|
15
22
|
"repository": {
|
|
16
23
|
"type": "git",
|
|
17
|
-
"url": "https://github.com/MrMarciaOng/ccsetup.git"
|
|
24
|
+
"url": "git+https://github.com/MrMarciaOng/ccsetup.git"
|
|
18
25
|
},
|
|
19
26
|
"homepage": "https://github.com/MrMarciaOng/ccsetup#readme",
|
|
20
27
|
"files": [
|
|
21
28
|
"bin/",
|
|
22
|
-
"template/"
|
|
29
|
+
"template/",
|
|
30
|
+
"README.md"
|
|
23
31
|
],
|
|
24
32
|
"engines": {
|
|
25
33
|
"node": ">=14.0.0"
|
|
34
|
+
},
|
|
35
|
+
"dependencies": {
|
|
36
|
+
"@inquirer/checkbox": "^4.0.4"
|
|
37
|
+
},
|
|
38
|
+
"devDependencies": {
|
|
39
|
+
"jest": "^30.0.5"
|
|
40
|
+
},
|
|
41
|
+
"scripts": {
|
|
42
|
+
"test": "jest",
|
|
43
|
+
"test:watch": "jest --watch",
|
|
44
|
+
"test:coverage": "jest --coverage"
|
|
26
45
|
}
|
|
27
|
-
}
|
|
46
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# .claude Directory
|
|
2
|
+
|
|
3
|
+
This directory contains Claude Code configuration and project-specific resources.
|
|
4
|
+
|
|
5
|
+
## Structure
|
|
6
|
+
|
|
7
|
+
- **agents/** - Project-specific AI agents with custom prompts
|
|
8
|
+
- **commands/** - Custom slash commands (created as needed)
|
|
9
|
+
- **settings.json** - Shared project settings (created as needed)
|
|
10
|
+
- **settings.local.json** - Personal settings (git-ignored, created as needed)
|
|
11
|
+
|
|
12
|
+
## Agents
|
|
13
|
+
|
|
14
|
+
The `agents/` directory contains specialized AI agents for your project. These agents are automatically available in Claude Code and can be invoked using the Task tool.
|
|
15
|
+
|
|
16
|
+
To add a new agent:
|
|
17
|
+
1. Create a markdown file in the `agents/` directory
|
|
18
|
+
2. Follow the agent template structure
|
|
19
|
+
3. The agent will be automatically available in Claude Code
|
|
20
|
+
|
|
21
|
+
## Learn More
|
|
22
|
+
|
|
23
|
+
For more information about Claude Code configuration, visit:
|
|
24
|
+
https://docs.anthropic.com/claude-code/
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Claude Code Agents
|
|
2
|
+
|
|
3
|
+
This directory contains project-specific AI agents that extend Claude Code's capabilities.
|
|
4
|
+
|
|
5
|
+
## Using Agents
|
|
6
|
+
|
|
7
|
+
Agents in this directory are automatically available in Claude Code. You can invoke them using the Task tool by specifying the agent type.
|
|
8
|
+
|
|
9
|
+
## Agent Structure
|
|
10
|
+
|
|
11
|
+
Each agent should be a markdown file with the following structure:
|
|
12
|
+
|
|
13
|
+
```markdown
|
|
14
|
+
---
|
|
15
|
+
name: agent-name
|
|
16
|
+
description: Brief description of what this agent does
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
# Agent Name
|
|
20
|
+
|
|
21
|
+
## Purpose
|
|
22
|
+
[What this agent does]
|
|
23
|
+
|
|
24
|
+
## Capabilities
|
|
25
|
+
- [Capability 1]
|
|
26
|
+
- [Capability 2]
|
|
27
|
+
|
|
28
|
+
## Instructions
|
|
29
|
+
[Detailed instructions for the agent]
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Available Agents
|
|
33
|
+
|
|
34
|
+
Agents will be listed here as they are added to this directory.
|
|
35
|
+
|
|
36
|
+
## Creating Custom Agents
|
|
37
|
+
|
|
38
|
+
To create a custom agent:
|
|
39
|
+
1. Create a new `.md` file in this directory
|
|
40
|
+
2. Add the frontmatter with name and description
|
|
41
|
+
3. Define the agent's purpose, capabilities, and instructions
|
|
42
|
+
4. The agent will be immediately available in Claude Code
|
|
43
|
+
|
|
44
|
+
For more information about agents, see the main project's `agents/` directory.
|
package/template/CLAUDE.md
CHANGED
|
@@ -1,17 +1,22 @@
|
|
|
1
1
|
# Claude Code Project Instructions
|
|
2
2
|
|
|
3
3
|
## Project Overview
|
|
4
|
+
|
|
4
5
|
[Brief description of your project goes here]
|
|
5
6
|
|
|
6
7
|
## Key Objectives
|
|
8
|
+
|
|
7
9
|
- [Objective 1]
|
|
8
10
|
- [Objective 2]
|
|
9
11
|
- [Objective 3]
|
|
10
12
|
|
|
11
13
|
## Project Structure
|
|
14
|
+
|
|
12
15
|
```
|
|
13
16
|
.
|
|
14
17
|
├── CLAUDE.md # This file - project instructions for Claude
|
|
18
|
+
├── .claude/ # Claude Code configuration (auto-generated)
|
|
19
|
+
│ └── agents/ # Project-specific agent overrides
|
|
15
20
|
├── agents/ # Custom agents for specialized tasks
|
|
16
21
|
├── docs/ # Project documentation
|
|
17
22
|
├── plans/ # Project plans and architectural documents
|
|
@@ -21,21 +26,25 @@
|
|
|
21
26
|
## Development Guidelines
|
|
22
27
|
|
|
23
28
|
### Code Style
|
|
29
|
+
|
|
24
30
|
- Follow existing code conventions in the project
|
|
25
31
|
- Use consistent naming patterns
|
|
26
32
|
- Maintain clean, readable code
|
|
27
33
|
|
|
28
34
|
### Testing
|
|
35
|
+
|
|
29
36
|
- Run tests before committing changes
|
|
30
37
|
- Add tests for new functionality
|
|
31
38
|
- Ensure all tests pass
|
|
32
39
|
|
|
33
40
|
### Git Workflow
|
|
41
|
+
|
|
34
42
|
- Create descriptive commit messages
|
|
35
43
|
- Keep commits focused and atomic
|
|
36
44
|
- Review changes before committing
|
|
37
45
|
|
|
38
46
|
## Common Commands
|
|
47
|
+
|
|
39
48
|
```bash
|
|
40
49
|
# Add your common project commands here
|
|
41
50
|
# npm install
|
|
@@ -44,18 +53,26 @@
|
|
|
44
53
|
```
|
|
45
54
|
|
|
46
55
|
## Important Context
|
|
56
|
+
|
|
47
57
|
[Add any project-specific context, dependencies, or requirements here]
|
|
48
58
|
|
|
49
59
|
## Agents
|
|
60
|
+
|
|
50
61
|
See @agents/README.md for available agents and their purposes
|
|
51
62
|
|
|
63
|
+
## Agent Orchestration
|
|
64
|
+
|
|
65
|
+
After adding the agents you want to in `./claude/agents` folder, setup the workflow for Claude code to follow
|
|
66
|
+
|
|
52
67
|
## Tickets
|
|
68
|
+
|
|
53
69
|
See @tickets/README.md for ticket format and management approach
|
|
54
70
|
|
|
55
71
|
## Plans
|
|
72
|
+
|
|
56
73
|
See @plans/README.md for planning documents and architectural decisions
|
|
57
74
|
|
|
58
|
-
## Development Context
|
|
75
|
+
## Development Context
|
|
59
76
|
|
|
60
77
|
- See @docs/ROADMAP.md for current status and next steps
|
|
61
78
|
- Task-based development workflow with tickets in `/tickets` directory
|
|
@@ -64,6 +81,7 @@ See @plans/README.md for planning documents and architectural decisions
|
|
|
64
81
|
## Important Instructions
|
|
65
82
|
|
|
66
83
|
Before starting any task:
|
|
84
|
+
|
|
67
85
|
1. **Confirm understanding**: Always confirm you understand the request and outline your plan before proceeding
|
|
68
86
|
2. **Ask clarifying questions**: Never make assumptions - ask questions when requirements are unclear
|
|
69
87
|
3. **Create planning documents**: Before implementing any code or features, create a markdown file documenting the approach
|
|
@@ -71,4 +89,5 @@ Before starting any task:
|
|
|
71
89
|
5. **No code comments**: Never add comments to any code you write - code should be self-documenting
|
|
72
90
|
|
|
73
91
|
## Additional Notes
|
|
74
|
-
|
|
92
|
+
|
|
93
|
+
[Any other important information for Claude to know about this project]
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: backend
|
|
3
|
+
description: Backend development specialist. Use PROACTIVELY for API design, database architecture, authentication, microservices, and server-side optimization. Invoke when building APIs, services, or backend infrastructure.
|
|
4
|
+
tools: Read, Write, Edit, Grep, Glob, Bash, WebSearch, WebFetch
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
You are a senior backend engineer with expertise in server-side technologies and distributed systems. Your role is to design and implement scalable, secure, and performant backend services.
|
|
8
|
+
|
|
9
|
+
## Core Responsibilities:
|
|
10
|
+
1. **API Design**: Create RESTful and GraphQL APIs with proper documentation
|
|
11
|
+
2. **Database Architecture**: Design efficient schemas and optimize queries
|
|
12
|
+
3. **Authentication & Security**: Implement secure auth flows and data protection
|
|
13
|
+
4. **Microservices**: Build scalable, distributed service architectures
|
|
14
|
+
5. **Performance & Scaling**: Ensure high availability and optimal response times
|
|
15
|
+
|
|
16
|
+
## Expertise Areas:
|
|
17
|
+
|
|
18
|
+
### Languages & Frameworks:
|
|
19
|
+
- **Node.js**: Express, Fastify, NestJS, middleware patterns
|
|
20
|
+
- **Python**: Django, FastAPI, Flask, async programming
|
|
21
|
+
- **Java**: Spring Boot, microservices, reactive programming
|
|
22
|
+
- **Go**: High-performance services, concurrent programming
|
|
23
|
+
- **Ruby**: Rails, API-only applications, background jobs
|
|
24
|
+
|
|
25
|
+
### Technical Skills:
|
|
26
|
+
- **Databases**: PostgreSQL, MySQL, MongoDB, Redis, Elasticsearch
|
|
27
|
+
- **Message Queues**: RabbitMQ, Kafka, Redis Pub/Sub, AWS SQS
|
|
28
|
+
- **Caching**: Redis, Memcached, CDN strategies
|
|
29
|
+
- **Testing**: Unit, integration, load testing, TDD/BDD
|
|
30
|
+
- **DevOps**: Docker, Kubernetes, CI/CD, monitoring
|
|
31
|
+
|
|
32
|
+
## Development Process:
|
|
33
|
+
1. Analyze requirements and define API contracts
|
|
34
|
+
2. Design database schema and relationships
|
|
35
|
+
3. Implement service layer with business logic
|
|
36
|
+
4. Create comprehensive error handling
|
|
37
|
+
5. Add authentication and authorization
|
|
38
|
+
6. Optimize queries and implement caching
|
|
39
|
+
7. Write thorough tests and documentation
|
|
40
|
+
|
|
41
|
+
## Best Practices:
|
|
42
|
+
- **API Design**: RESTful principles, versioning, consistent responses
|
|
43
|
+
- **Security**: Input validation, SQL injection prevention, rate limiting
|
|
44
|
+
- **Performance**: Query optimization, connection pooling, caching strategies
|
|
45
|
+
- **Scalability**: Horizontal scaling, load balancing, stateless design
|
|
46
|
+
- **Error Handling**: Graceful degradation, meaningful error messages
|
|
47
|
+
- **Monitoring**: Logging, metrics, distributed tracing
|
|
48
|
+
|
|
49
|
+
## Architecture Patterns:
|
|
50
|
+
- **Microservices**: Service boundaries, API gateway, service mesh
|
|
51
|
+
- **Event-Driven**: Event sourcing, CQRS, message-driven architecture
|
|
52
|
+
- **Serverless**: Lambda functions, edge computing, FaaS patterns
|
|
53
|
+
- **Monolithic**: When appropriate, modular monoliths
|
|
54
|
+
- **Database**: Repository pattern, unit of work, migrations
|
|
55
|
+
|
|
56
|
+
## Security Considerations:
|
|
57
|
+
- Authentication: JWT, OAuth2, session management
|
|
58
|
+
- Authorization: RBAC, ABAC, policy engines
|
|
59
|
+
- Data Protection: Encryption at rest and in transit
|
|
60
|
+
- API Security: Rate limiting, CORS, input sanitization
|
|
61
|
+
- Compliance: GDPR, PCI DSS, HIPAA considerations
|
|
62
|
+
|
|
63
|
+
## Performance Optimization:
|
|
64
|
+
- **Database**: Indexing, query optimization, connection pooling
|
|
65
|
+
- **Caching**: Multi-level caching, cache invalidation strategies
|
|
66
|
+
- **Async Processing**: Background jobs, message queues
|
|
67
|
+
- **Load Balancing**: Round-robin, least connections, health checks
|
|
68
|
+
- **Monitoring**: APM tools, custom metrics, alerting
|
|
69
|
+
|
|
70
|
+
## Output Format:
|
|
71
|
+
Structure backend solutions with:
|
|
72
|
+
- **Architecture Overview**: Service boundaries and interactions
|
|
73
|
+
- **API Documentation**: Endpoints, request/response formats
|
|
74
|
+
- **Database Schema**: Tables, relationships, indexes
|
|
75
|
+
- **Implementation**: Clean, maintainable service code
|
|
76
|
+
- **Security Measures**: Auth flow and data protection
|
|
77
|
+
- **Performance Strategy**: Caching, optimization techniques
|
|
78
|
+
- **Deployment Plan**: Infrastructure and scaling approach
|
|
79
|
+
|
|
80
|
+
Remember: Backend services are the foundation. Focus on reliability, security, and scalability in every implementation.
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# Agent Orchestration Guide
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
This document defines the standard workflows for orchestrating multiple agents in Claude Code to complete complex tasks efficiently. Follow these patterns to ensure consistent and thorough task execution.
|
|
5
|
+
|
|
6
|
+
## Core Agent Workflows
|
|
7
|
+
|
|
8
|
+
### 1. Feature Development Workflow
|
|
9
|
+
**Purpose**: Implement new features from conception to completion
|
|
10
|
+
|
|
11
|
+
**Flow**:
|
|
12
|
+
1. **Researcher Agent** → Gather requirements and understand existing codebase
|
|
13
|
+
2. **Planner Agent** → Create detailed implementation plan and architecture
|
|
14
|
+
3. **Coder Agent** → Implement the feature following the plan
|
|
15
|
+
4. **Checker Agent** → Test, review, and validate the implementation
|
|
16
|
+
|
|
17
|
+
**Example Prompt**:
|
|
18
|
+
```
|
|
19
|
+
"I need to add user authentication to the app. First use the researcher agent to understand the current architecture, then the planner to design the auth system, coder to implement it, and checker to validate."
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### 2. Bug Fix Workflow
|
|
23
|
+
**Purpose**: Systematically identify and fix bugs
|
|
24
|
+
|
|
25
|
+
**Flow**:
|
|
26
|
+
1. **Researcher Agent** → Investigate the bug and find root cause
|
|
27
|
+
2. **Coder Agent** → Implement the fix
|
|
28
|
+
3. **Checker Agent** → Verify fix and check for regressions
|
|
29
|
+
|
|
30
|
+
### 3. Refactoring Workflow
|
|
31
|
+
**Purpose**: Improve code quality without changing functionality
|
|
32
|
+
|
|
33
|
+
**Flow**:
|
|
34
|
+
1. **Researcher Agent** → Analyze current implementation and identify improvements
|
|
35
|
+
2. **Planner Agent** → Design refactoring approach
|
|
36
|
+
3. **Coder Agent** → Execute refactoring
|
|
37
|
+
4. **Checker Agent** → Ensure functionality remains intact
|
|
38
|
+
|
|
39
|
+
### 4. API Development Workflow
|
|
40
|
+
**Purpose**: Design and implement APIs
|
|
41
|
+
|
|
42
|
+
**Flow**:
|
|
43
|
+
1. **Planner Agent** → Design API architecture and endpoints
|
|
44
|
+
2. **Backend Agent** → Implement server-side logic
|
|
45
|
+
3. **Frontend Agent** → Create client integration (if needed)
|
|
46
|
+
4. **Checker Agent** → Test API functionality and security
|
|
47
|
+
|
|
48
|
+
### 5. UI Component Workflow
|
|
49
|
+
**Purpose**: Create user interface components
|
|
50
|
+
|
|
51
|
+
**Flow**:
|
|
52
|
+
1. **Frontend Agent** → Design and implement UI components
|
|
53
|
+
2. **Shadcn Agent** → Apply shadcn/ui styling (if using React)
|
|
54
|
+
3. **Checker Agent** → Test accessibility and responsiveness
|
|
55
|
+
|
|
56
|
+
### 6. Blockchain Development Workflow
|
|
57
|
+
**Purpose**: Develop Web3 features and smart contracts
|
|
58
|
+
|
|
59
|
+
**Flow**:
|
|
60
|
+
1. **Planner Agent** → Design smart contract architecture
|
|
61
|
+
2. **Blockchain Agent** → Implement contracts and Web3 integration
|
|
62
|
+
3. **Checker Agent** → Security audit and testing
|
|
63
|
+
|
|
64
|
+
## Orchestration Best Practices
|
|
65
|
+
|
|
66
|
+
### 1. Always Start with Understanding
|
|
67
|
+
- Use Researcher Agent first for non-trivial tasks
|
|
68
|
+
- Understand existing code before making changes
|
|
69
|
+
- Document findings in plans directory
|
|
70
|
+
|
|
71
|
+
### 2. Plan Before Implementation
|
|
72
|
+
- Use Planner Agent for complex features
|
|
73
|
+
- Create detailed plans in `/plans` directory
|
|
74
|
+
- Break down large tasks into smaller tickets
|
|
75
|
+
|
|
76
|
+
### 3. Sequential Execution
|
|
77
|
+
- Complete each agent's task before moving to the next
|
|
78
|
+
- Use TodoWrite to track progress through the workflow
|
|
79
|
+
- Don't skip agents unless explicitly instructed
|
|
80
|
+
|
|
81
|
+
### 4. Validation is Mandatory
|
|
82
|
+
- Always end with Checker Agent
|
|
83
|
+
- Run tests and linting
|
|
84
|
+
- Verify all acceptance criteria
|
|
85
|
+
|
|
86
|
+
### 5. Documentation Updates
|
|
87
|
+
- Update ROADMAP.md after completing workflows
|
|
88
|
+
- Mark tickets as complete with summaries
|
|
89
|
+
- Keep plans updated with outcomes
|
|
90
|
+
|
|
91
|
+
## Workflow Triggers
|
|
92
|
+
|
|
93
|
+
### When to use Feature Development Workflow:
|
|
94
|
+
- Adding new functionality
|
|
95
|
+
- Implementing user stories
|
|
96
|
+
- Creating new modules or services
|
|
97
|
+
|
|
98
|
+
### When to use Bug Fix Workflow:
|
|
99
|
+
- Fixing reported issues
|
|
100
|
+
- Addressing error messages
|
|
101
|
+
- Resolving unexpected behavior
|
|
102
|
+
|
|
103
|
+
### When to use Refactoring Workflow:
|
|
104
|
+
- Improving code readability
|
|
105
|
+
- Optimizing performance
|
|
106
|
+
- Updating deprecated code
|
|
107
|
+
|
|
108
|
+
### When to use API Development Workflow:
|
|
109
|
+
- Creating new endpoints
|
|
110
|
+
- Designing service interfaces
|
|
111
|
+
- Building integrations
|
|
112
|
+
|
|
113
|
+
### When to use UI Component Workflow:
|
|
114
|
+
- Building new UI elements
|
|
115
|
+
- Updating existing interfaces
|
|
116
|
+
- Implementing design changes
|
|
117
|
+
|
|
118
|
+
### When to use Blockchain Workflow:
|
|
119
|
+
- Smart contract development
|
|
120
|
+
- DeFi integrations
|
|
121
|
+
- Web3 features
|
|
122
|
+
|
|
123
|
+
## Example Multi-Agent Execution
|
|
124
|
+
|
|
125
|
+
```
|
|
126
|
+
User: "I need to add a payment processing feature"
|
|
127
|
+
|
|
128
|
+
Claude's Response Flow:
|
|
129
|
+
1. "I'll help you add payment processing. Let me start by using the researcher agent to understand your current architecture and any existing payment-related code."
|
|
130
|
+
[Uses Researcher Agent]
|
|
131
|
+
|
|
132
|
+
2. "Based on my research, I'll now use the planner agent to design the payment processing system."
|
|
133
|
+
[Uses Planner Agent, creates plan in /plans]
|
|
134
|
+
|
|
135
|
+
3. "With the plan ready, I'll use the backend agent to implement the server-side payment processing."
|
|
136
|
+
[Uses Backend Agent]
|
|
137
|
+
|
|
138
|
+
4. "Now I'll use the frontend agent to create the payment UI components."
|
|
139
|
+
[Uses Frontend Agent]
|
|
140
|
+
|
|
141
|
+
5. "Finally, let me use the checker agent to verify the implementation and ensure security."
|
|
142
|
+
[Uses Checker Agent]
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## Workflow Customization
|
|
146
|
+
|
|
147
|
+
You can create custom workflows by:
|
|
148
|
+
1. Combining agents in different sequences
|
|
149
|
+
2. Adding conditional paths based on findings
|
|
150
|
+
3. Creating specialized workflows for your project
|
|
151
|
+
|
|
152
|
+
Remember: The goal is systematic, thorough task completion with proper validation at each step.
|