claude-code-starter 0.7.0 → 0.9.0
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 +73 -144
- package/dist/cli.js +1 -1
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
[](https://nodejs.org/)
|
|
8
8
|
[](https://bun.sh/)
|
|
9
9
|
|
|
10
|
-
Intelligent CLI that
|
|
10
|
+
Intelligent CLI that uses Claude to deeply analyze your project and generate tailored Claude Code configurations.
|
|
11
11
|
|
|
12
12
|
## Quick Start
|
|
13
13
|
|
|
@@ -17,11 +17,28 @@ npx claude-code-starter
|
|
|
17
17
|
claude
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
+
**Requires [Claude CLI](https://claude.ai/download) to be installed.**
|
|
21
|
+
|
|
20
22
|
## What It Does
|
|
21
23
|
|
|
22
24
|
1. **Analyzes your repository** - Detects languages, frameworks, tools, and patterns
|
|
23
|
-
2. **
|
|
24
|
-
3. **
|
|
25
|
+
2. **Launches Claude CLI** - Claude reads your actual source files and understands your architecture
|
|
26
|
+
3. **Generates a professional CLAUDE.md** - Project-specific documentation with architecture, conventions, and patterns
|
|
27
|
+
4. **Creates supporting configurations** - Skills, agents, rules, and commands tailored to your stack
|
|
28
|
+
|
|
29
|
+
## How It Works
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
npx claude-code-starter
|
|
33
|
+
|
|
|
34
|
+
├── 1. Detect tech stack (languages, frameworks, tools)
|
|
35
|
+
├── 2. Generate supporting files (skills, agents, rules, commands)
|
|
36
|
+
├── 3. Launch Claude CLI for deep project analysis
|
|
37
|
+
│ └── Claude reads source files → understands architecture → writes CLAUDE.md
|
|
38
|
+
└── 4. Done! Run `claude` to start working
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
The key difference from static scaffolding tools: Claude actually **reads your codebase** and generates documentation specific to your project's architecture, patterns, conventions, and domain knowledge.
|
|
25
42
|
|
|
26
43
|
## Tech Stack Detection
|
|
27
44
|
|
|
@@ -29,20 +46,21 @@ Automatically detects and configures for:
|
|
|
29
46
|
|
|
30
47
|
| Category | Detected |
|
|
31
48
|
| -------------- | ------------------------------------------------------------------- |
|
|
32
|
-
| **Languages** | TypeScript, JavaScript, Python, Go, Rust, Java, Ruby,
|
|
49
|
+
| **Languages** | TypeScript, JavaScript, Python, Go, Rust, Java, Ruby, Swift, Kotlin |
|
|
33
50
|
| **Frameworks** | Next.js, React, Vue, Svelte, FastAPI, Django, NestJS, Express, etc. |
|
|
34
|
-
| **Tools** | npm, yarn, pnpm, bun, pip, cargo, go modules
|
|
51
|
+
| **Tools** | npm, yarn, pnpm, bun, pip, cargo, go modules |
|
|
35
52
|
| **Testing** | Jest, Vitest, Pytest, Go test, Rust test |
|
|
36
|
-
| **Linting** | ESLint, Biome, Ruff, Pylint
|
|
53
|
+
| **Linting** | ESLint, Biome, Ruff, Pylint |
|
|
37
54
|
|
|
38
55
|
## Generated Configurations
|
|
39
56
|
|
|
40
57
|
Based on your stack, creates:
|
|
41
58
|
|
|
42
|
-
-
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
-
|
|
59
|
+
- **CLAUDE.md** - Comprehensive project documentation generated by Claude's deep analysis of your codebase
|
|
60
|
+
- **Skills** - Framework-specific patterns (e.g., Next.js App Router, FastAPI endpoints)
|
|
61
|
+
- **Agents** - Specialized assistants (code reviewer, test writer)
|
|
62
|
+
- **Rules** - Language conventions (TypeScript strict mode, Python PEP 8)
|
|
63
|
+
- **Commands** - Workflow shortcuts (`/task`, `/status`, `/done`, `/analyze`, `/code-review`)
|
|
46
64
|
|
|
47
65
|
## Commands
|
|
48
66
|
|
|
@@ -67,25 +85,41 @@ npx claude-code-starter --help # Show help
|
|
|
67
85
|
## Example Output
|
|
68
86
|
|
|
69
87
|
```
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
║ AI-Assisted Development Setup ║
|
|
73
|
-
╚═══════════════════════════════════╝
|
|
88
|
+
Claude Code Starter v0.4.1
|
|
89
|
+
Intelligent AI-Assisted Development Setup
|
|
74
90
|
|
|
75
|
-
|
|
91
|
+
Analyzing repository...
|
|
76
92
|
|
|
77
|
-
|
|
93
|
+
Tech Stack
|
|
78
94
|
Language: TypeScript
|
|
79
95
|
Framework: Next.js
|
|
80
96
|
Package Manager: bun
|
|
81
97
|
Testing: vitest
|
|
82
98
|
|
|
83
|
-
|
|
99
|
+
Existing project with 42 source files
|
|
100
|
+
|
|
101
|
+
Generating supporting configuration...
|
|
102
|
+
|
|
103
|
+
Created:
|
|
104
|
+
+ .claude/settings.json
|
|
105
|
+
+ .claude/skills/pattern-discovery.md
|
|
106
|
+
+ .claude/skills/nextjs-patterns.md
|
|
107
|
+
...
|
|
108
|
+
|
|
109
|
+
Launching Claude for deep project analysis...
|
|
110
|
+
Claude will read your codebase and generate a comprehensive CLAUDE.md
|
|
111
|
+
|
|
112
|
+
Claude analysis complete!
|
|
113
|
+
|
|
114
|
+
Done! (15 files)
|
|
84
115
|
|
|
85
116
|
Generated for your stack:
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
117
|
+
CLAUDE.md (deep analysis by Claude)
|
|
118
|
+
9 skills (pattern-discovery, iterative-development, security, nextjs-patterns, ...)
|
|
119
|
+
2 agents (code-reviewer, test-writer)
|
|
120
|
+
2 rules
|
|
121
|
+
|
|
122
|
+
Next step: Run claude to start working!
|
|
89
123
|
```
|
|
90
124
|
|
|
91
125
|
## Project Structure
|
|
@@ -94,7 +128,7 @@ After running, your project will have:
|
|
|
94
128
|
|
|
95
129
|
```
|
|
96
130
|
.claude/
|
|
97
|
-
├── CLAUDE.md # Project-specific
|
|
131
|
+
├── CLAUDE.md # Project-specific docs (generated by Claude analysis)
|
|
98
132
|
├── settings.json # Permissions configuration
|
|
99
133
|
├── agents/ # Specialized AI agents
|
|
100
134
|
│ ├── code-reviewer.md
|
|
@@ -122,15 +156,13 @@ After running, your project will have:
|
|
|
122
156
|
└── task.md # Current task tracking
|
|
123
157
|
```
|
|
124
158
|
|
|
125
|
-
##
|
|
126
|
-
|
|
127
|
-
### Architecture
|
|
159
|
+
## Architecture
|
|
128
160
|
|
|
129
161
|
```mermaid
|
|
130
162
|
flowchart LR
|
|
131
163
|
A[CLI] --> B[Analyzer]
|
|
132
164
|
B --> C[Generator]
|
|
133
|
-
|
|
165
|
+
B --> D[Claude CLI]
|
|
134
166
|
|
|
135
167
|
B -->|reads| E[package.json]
|
|
136
168
|
B -->|reads| F[config files]
|
|
@@ -140,15 +172,16 @@ flowchart LR
|
|
|
140
172
|
C -->|creates| I[agents/]
|
|
141
173
|
C -->|creates| J[rules/]
|
|
142
174
|
C -->|creates| K[commands/]
|
|
175
|
+
|
|
176
|
+
D -->|reads| L[source files]
|
|
177
|
+
D -->|creates| M[CLAUDE.md]
|
|
143
178
|
```
|
|
144
179
|
|
|
145
180
|
### Artifact Generation
|
|
146
181
|
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
|
150
|
-
|---------------|------------------|
|
|
151
|
-
| **CLAUDE.md** | Generated with project name, description, and detected stack |
|
|
182
|
+
| Artifact Type | Generation Method |
|
|
183
|
+
|---------------|-------------------|
|
|
184
|
+
| **CLAUDE.md** | Claude CLI deep analysis of your actual source files |
|
|
152
185
|
| **settings.json** | Generated with safe default permissions |
|
|
153
186
|
| **Skills** | Core skills + framework-specific patterns (if detected) |
|
|
154
187
|
| **Agents** | Code reviewer and test writer agents |
|
|
@@ -166,20 +199,6 @@ When running on an existing project with `.claude/` configuration:
|
|
|
166
199
|
| **With `-f` flag** | Overwritten |
|
|
167
200
|
| **state/task.md** | Always preserved |
|
|
168
201
|
|
|
169
|
-
### Detection Sources
|
|
170
|
-
|
|
171
|
-
The CLI examines these files to detect your stack:
|
|
172
|
-
|
|
173
|
-
| Source | Detects |
|
|
174
|
-
|--------|---------|
|
|
175
|
-
| `package.json` | JS/TS frameworks, testing, linting |
|
|
176
|
-
| `pyproject.toml` / `requirements.txt` | Python frameworks, tools |
|
|
177
|
-
| `go.mod` | Go and its web frameworks |
|
|
178
|
-
| `Cargo.toml` | Rust and its frameworks |
|
|
179
|
-
| `*.lockfile` | Package manager (bun.lockb, yarn.lock, etc.) |
|
|
180
|
-
| `.github/workflows/` | CI/CD platform |
|
|
181
|
-
| Config files | Linters, formatters, bundlers |
|
|
182
|
-
|
|
183
202
|
### Framework-Specific Patterns
|
|
184
203
|
|
|
185
204
|
When a framework is detected, additional skills are generated:
|
|
@@ -190,96 +209,16 @@ When a framework is detected, additional skills are generated:
|
|
|
190
209
|
| React | `react-components.md` - Hooks, component patterns |
|
|
191
210
|
| FastAPI | `fastapi-patterns.md` - Async endpoints, Pydantic |
|
|
192
211
|
| NestJS | `nestjs-patterns.md` - Modules, decorators, DI |
|
|
212
|
+
| SwiftUI | `swiftui-patterns.md` - Declarative UI patterns |
|
|
213
|
+
| UIKit | `uikit-patterns.md` - View controller patterns |
|
|
214
|
+
| Vapor | `vapor-patterns.md` - Server-side Swift |
|
|
215
|
+
| Jetpack Compose | `compose-patterns.md` - Compose UI patterns |
|
|
216
|
+
| Android Views | `android-views-patterns.md` - XML views |
|
|
193
217
|
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
<details>
|
|
197
|
-
<summary><b>📚 Skill Example</b> (pattern-discovery.md)</summary>
|
|
198
|
-
|
|
199
|
-
```markdown
|
|
200
|
-
---
|
|
201
|
-
description: "Systematic approach to discovering patterns in unfamiliar codebases"
|
|
202
|
-
---
|
|
218
|
+
## Requirements
|
|
203
219
|
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
## When to Use
|
|
207
|
-
- Starting work on unfamiliar code
|
|
208
|
-
- Investigating "how does X work here?"
|
|
209
|
-
- Before making changes to existing systems
|
|
210
|
-
|
|
211
|
-
## Approach
|
|
212
|
-
1. Find entry points (main, index, app)
|
|
213
|
-
2. Trace data flow through the system
|
|
214
|
-
3. Identify naming conventions
|
|
215
|
-
4. Map directory structure to responsibilities
|
|
216
|
-
```
|
|
217
|
-
</details>
|
|
218
|
-
|
|
219
|
-
<details>
|
|
220
|
-
<summary><b>🤖 Agent Example</b> (code-reviewer.md)</summary>
|
|
221
|
-
|
|
222
|
-
```markdown
|
|
223
|
-
---
|
|
224
|
-
name: "Code Reviewer"
|
|
225
|
-
description: "Reviews code for quality, patterns, and potential issues"
|
|
226
|
-
model: "sonnet"
|
|
227
|
-
tools: ["Read", "Glob", "Grep"]
|
|
228
|
-
---
|
|
229
|
-
|
|
230
|
-
# Code Reviewer Agent
|
|
231
|
-
|
|
232
|
-
You are a code reviewer focused on:
|
|
233
|
-
- Code quality and readability
|
|
234
|
-
- Potential bugs and edge cases
|
|
235
|
-
- Performance considerations
|
|
236
|
-
- Security vulnerabilities
|
|
237
|
-
```
|
|
238
|
-
</details>
|
|
239
|
-
|
|
240
|
-
<details>
|
|
241
|
-
<summary><b>📏 Rule Example</b> (typescript.md)</summary>
|
|
242
|
-
|
|
243
|
-
```markdown
|
|
244
|
-
---
|
|
245
|
-
paths: ["**/*.ts", "**/*.tsx"]
|
|
246
|
-
---
|
|
247
|
-
|
|
248
|
-
# TypeScript Conventions
|
|
249
|
-
|
|
250
|
-
- Use strict mode (`"strict": true`)
|
|
251
|
-
- Prefer `interface` over `type` for object shapes
|
|
252
|
-
- Use explicit return types on exported functions
|
|
253
|
-
- Avoid `any`, prefer `unknown` for truly unknown types
|
|
254
|
-
```
|
|
255
|
-
</details>
|
|
256
|
-
|
|
257
|
-
<details>
|
|
258
|
-
<summary><b>⚡ Command Example</b> (task.md)</summary>
|
|
259
|
-
|
|
260
|
-
```markdown
|
|
261
|
-
---
|
|
262
|
-
description: "Start or switch to a new task"
|
|
263
|
-
---
|
|
264
|
-
|
|
265
|
-
# /task
|
|
266
|
-
|
|
267
|
-
Update `.claude/state/task.md` with:
|
|
268
|
-
- Task description from user input
|
|
269
|
-
- Status: In Progress
|
|
270
|
-
- Empty decisions/notes sections
|
|
271
|
-
- Clear next steps
|
|
272
|
-
```
|
|
273
|
-
</details>
|
|
274
|
-
|
|
275
|
-
## Tip
|
|
276
|
-
|
|
277
|
-
Add `.claude/` to your global gitignore:
|
|
278
|
-
|
|
279
|
-
```bash
|
|
280
|
-
echo ".claude/" >> ~/.gitignore
|
|
281
|
-
git config --global core.excludesfile ~/.gitignore
|
|
282
|
-
```
|
|
220
|
+
- **Node.js 18+** (for running via npx)
|
|
221
|
+
- **[Claude CLI](https://claude.ai/download)** (for deep project analysis)
|
|
283
222
|
|
|
284
223
|
## CI/CD
|
|
285
224
|
|
|
@@ -331,19 +270,9 @@ Configure these in your GitHub repository settings:
|
|
|
331
270
|
| `GITHUB_TOKEN` | Auto-provided by GitHub | Creating releases |
|
|
332
271
|
|
|
333
272
|
To create an npm token:
|
|
334
|
-
1. Go to [npmjs.com](https://npmjs.com)
|
|
273
|
+
1. Go to [npmjs.com](https://npmjs.com) -> Access Tokens
|
|
335
274
|
2. Generate a new "Automation" token
|
|
336
|
-
3. Add it as `NPM_TOKEN` in GitHub repo
|
|
337
|
-
|
|
338
|
-
### Branch Protection (Recommended)
|
|
339
|
-
|
|
340
|
-
Configure these settings for the `main` branch:
|
|
341
|
-
|
|
342
|
-
- ✅ Require a pull request before merging
|
|
343
|
-
- ✅ Require status checks to pass before merging
|
|
344
|
-
- Required checks: `lint`, `typecheck`, `test`, `build`, `pr-check-complete`
|
|
345
|
-
- ✅ Require branches to be up to date before merging
|
|
346
|
-
- ✅ Do not allow bypassing the above settings
|
|
275
|
+
3. Add it as `NPM_TOKEN` in GitHub repo -> Settings -> Secrets
|
|
347
276
|
|
|
348
277
|
## Development
|
|
349
278
|
|
package/dist/cli.js
CHANGED
|
@@ -4335,7 +4335,7 @@ async function main() {
|
|
|
4335
4335
|
pc.gray("Your CLAUDE.md was generated by deep analysis - review it with: cat .claude/CLAUDE.md")
|
|
4336
4336
|
);
|
|
4337
4337
|
}
|
|
4338
|
-
var isMain = process.argv[1] === fileURLToPath(import.meta.url);
|
|
4338
|
+
var isMain = fs3.realpathSync(process.argv[1]) === fileURLToPath(import.meta.url);
|
|
4339
4339
|
if (isMain) {
|
|
4340
4340
|
main().catch((err) => {
|
|
4341
4341
|
console.error(pc.red("Error:"), err.message);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "claude-code-starter",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.9.0",
|
|
4
4
|
"description": "A lightweight starter kit for AI-assisted development with Claude Code",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"claude",
|
|
@@ -29,7 +29,9 @@
|
|
|
29
29
|
"build": "bun run tsup",
|
|
30
30
|
"dev": "bun run tsup --watch",
|
|
31
31
|
"start": "bun dist/cli.js",
|
|
32
|
-
"test": "bun test",
|
|
32
|
+
"test": "bun test src/cli.test.ts",
|
|
33
|
+
"test:e2e": "bun run build && bun test src/cli.e2e.test.ts",
|
|
34
|
+
"test:all": "bun run build && bun test",
|
|
33
35
|
"typecheck": "bun run tsc --noEmit",
|
|
34
36
|
"lint": "biome lint src/",
|
|
35
37
|
"lint:fix": "biome lint --write src/",
|