ccsetup 1.0.1 → 1.0.3
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 +62 -0
- package/package.json +7 -4
package/README.md
CHANGED
|
@@ -32,6 +32,68 @@ npx ccsetup . # in current directory
|
|
|
32
32
|
|
|
33
33
|
4. Start creating tickets in `tickets/` directory
|
|
34
34
|
|
|
35
|
+
## Using Agents
|
|
36
|
+
|
|
37
|
+
The boilerplate includes several specialized agents in the `agents/` directory:
|
|
38
|
+
|
|
39
|
+
- **planner.md** - Strategic planning and task breakdown
|
|
40
|
+
- **coder.md** - Implementation and development
|
|
41
|
+
- **checker.md** - Testing and quality assurance
|
|
42
|
+
- **researcher.md** - Research and information gathering
|
|
43
|
+
- **blockchain.md** - Web3 and smart contract development
|
|
44
|
+
- **frontend.md** - UI/UX and frontend development
|
|
45
|
+
- **shadcn.md** - shadcn/ui component development
|
|
46
|
+
|
|
47
|
+
### Selecting Agents for Your Project
|
|
48
|
+
|
|
49
|
+
You can customize which agents to use by:
|
|
50
|
+
|
|
51
|
+
1. Copy only the agents you need to `./claude/agents/` in your project
|
|
52
|
+
2. Remove any agents you don't need from the `agents/` directory
|
|
53
|
+
3. Create custom agents by adding new `.md` files
|
|
54
|
+
|
|
55
|
+
Example:
|
|
56
|
+
```bash
|
|
57
|
+
# After running ccsetup
|
|
58
|
+
mkdir -p ./claude/agents
|
|
59
|
+
cp agents/coder.md agents/checker.md ./claude/agents/
|
|
60
|
+
# Now Claude will only have access to coder and checker agents
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Getting Started with Claude Code
|
|
64
|
+
|
|
65
|
+
After setting up your project with `ccsetup`:
|
|
66
|
+
|
|
67
|
+
1. **Open Claude Code** in your project directory:
|
|
68
|
+
```bash
|
|
69
|
+
cd my-awesome-project
|
|
70
|
+
claude
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
2. **Let Claude understand your project** by asking:
|
|
74
|
+
- "Read the CLAUDE.md file to understand this project"
|
|
75
|
+
- "Check the roadmap in docs/ROADMAP.md"
|
|
76
|
+
- "What agents are available in the agents directory?"
|
|
77
|
+
- "Read the README files in docs, tickets, and plans folders to understand the workflow"
|
|
78
|
+
|
|
79
|
+
3. **Start working** with Claude:
|
|
80
|
+
- Use the planner agent: "Use the planner agent to help me design a user authentication system"
|
|
81
|
+
- Create tickets: "Create a ticket for implementing user login"
|
|
82
|
+
- Implement features: "Use the coder agent to implement the login functionality"
|
|
83
|
+
- Review code: "Use the checker agent to review the code we just wrote"
|
|
84
|
+
|
|
85
|
+
4. **Important setup steps**:
|
|
86
|
+
- **Update ROADMAP.md**: Define your project's goals, features, and development phases
|
|
87
|
+
- **Read folder documentation**: Each folder (docs/, tickets/, plans/) has a README explaining its purpose and format
|
|
88
|
+
- **Customize CLAUDE.md**: Add project-specific instructions, commands, and context
|
|
89
|
+
|
|
90
|
+
5. **Workflow tips**:
|
|
91
|
+
- Always start with planning for complex features
|
|
92
|
+
- Create tickets to track progress
|
|
93
|
+
- Use the appropriate agent for each task
|
|
94
|
+
- Keep CLAUDE.md updated with project-specific instructions
|
|
95
|
+
- Follow the workflow defined in docs/ROADMAP.md
|
|
96
|
+
|
|
35
97
|
## Features
|
|
36
98
|
|
|
37
99
|
- Pre-configured project structure for Claude Code
|
package/package.json
CHANGED
|
@@ -1,18 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ccsetup",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "Boilerplate for Claude Code projects with agents, tickets, and plans",
|
|
5
5
|
"bin": {
|
|
6
6
|
"ccsetup": "./bin/create-project.js"
|
|
7
7
|
},
|
|
8
8
|
"keywords": ["claude", "boilerplate", "project-template", "claude-code", "ai", "development"],
|
|
9
|
-
"author": "
|
|
9
|
+
"author": "MrMarciaOng",
|
|
10
|
+
"contributors": [
|
|
11
|
+
"vichannnnn"
|
|
12
|
+
],
|
|
10
13
|
"license": "MIT",
|
|
11
14
|
"repository": {
|
|
12
15
|
"type": "git",
|
|
13
|
-
"url": "https://github.com/
|
|
16
|
+
"url": "https://github.com/MrMarciaOng/ccsetup.git"
|
|
14
17
|
},
|
|
15
|
-
"homepage": "https://github.com/
|
|
18
|
+
"homepage": "https://github.com/MrMarciaOng/ccsetup#readme",
|
|
16
19
|
"files": [
|
|
17
20
|
"bin/",
|
|
18
21
|
"template/"
|