Skip to content

Commit 202b32f

Browse files
auge2uclaude
andcommitted
Initial setup: design, installer skill, shell component
- Design document with full architecture - Registry with 6 components and 3 bundles - Main installer skill (setup-claude-dev-kit) - Shell component skill (setup-cdk-shell) - Roadmap for remaining work 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
0 parents  commit 202b32f

6 files changed

Lines changed: 853 additions & 0 deletions

File tree

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Claude Dev Kit
2+
3+
A comprehensive, Claude-native developer environment toolkit.
4+
5+
**Claude installs itself** - the installer is a skill that Claude runs interactively.
6+
7+
## Quick Start
8+
9+
```
10+
# In Claude Code, simply say:
11+
"Set up my dev environment for Claude"
12+
13+
# Or invoke the skill directly:
14+
Skill: setup-claude-dev-kit
15+
```
16+
17+
## Bundles
18+
19+
| Bundle | Components | Use Case |
20+
|--------|------------|----------|
21+
| **minimal** | shell | Quick setup, just the essentials |
22+
| **standard** | shell, editor, git, templates | Most developers |
23+
| **full** | all components | Complete optimization |
24+
25+
## Components
26+
27+
| Component | Description |
28+
|-----------|-------------|
29+
| [cdk-shell](https://github.com/claude-dev-kit/cdk-shell) | Zsh, Powerlevel10k, completions, aliases |
30+
| [cdk-editor](https://github.com/claude-dev-kit/cdk-editor) | VS Code/Cursor settings, extensions |
31+
| [cdk-git](https://github.com/claude-dev-kit/cdk-git) | Hooks, commit templates, PR workflows |
32+
| [cdk-templates](https://github.com/claude-dev-kit/cdk-templates) | CLAUDE.md templates, project scaffolds |
33+
| [cdk-quality](https://github.com/claude-dev-kit/cdk-quality) | Linting, testing, review automation |
34+
| [cdk-memory](https://github.com/claude-dev-kit/cdk-memory) | Context/conversation management |
35+
36+
## Installation Modes
37+
38+
### Greenfield (Fresh Machine)
39+
Opinionated defaults, fast setup, minimal questions.
40+
41+
### Adaptation (Existing Setup)
42+
Respects your config, shows diffs, backs up before changes.
43+
44+
## Manual Installation
45+
46+
If you prefer not to use Claude:
47+
48+
```bash
49+
curl -fsSL https://raw.githubusercontent.com/claude-dev-kit/claude-dev-kit/main/install.sh | bash
50+
```
51+
52+
## License
53+
54+
MIT

ROADMAP.md

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# Claude Dev Kit - Roadmap
2+
3+
## Current Status
4+
5+
**Phase 1: Foundation** - COMPLETE
6+
- [x] Design document (`docs/plans/2025-12-07-claude-dev-kit-design.md`)
7+
- [x] Repository structure
8+
- [x] Registry with component definitions
9+
- [x] Main installer skill (`skills/SKILL.md`)
10+
- [x] Shell component skill (`skills/shell/SKILL.md`)
11+
12+
## Phase 2: Core Components
13+
14+
### 2.1 Editor Component
15+
**Location:** `skills/editor/SKILL.md`
16+
17+
Build `setup-cdk-editor` skill:
18+
- [ ] VS Code settings.json optimized for Claude
19+
- [ ] Cursor-specific settings variant
20+
- [ ] Extension recommendations (GitLens, Error Lens, etc.)
21+
- [ ] Keybindings for Claude workflows
22+
- [ ] Workspace template with `.vscode/` pre-configured
23+
24+
### 2.2 Git Component
25+
**Location:** `skills/git/SKILL.md`
26+
27+
Build `setup-cdk-git` skill:
28+
- [ ] Pre-commit hooks (lint, format, conventional commits)
29+
- [ ] Commit message template with Claude attribution
30+
- [ ] PR template with test plan section
31+
- [ ] Branch naming convention helper
32+
- [ ] `.gitignore` additions for Claude artifacts
33+
34+
### 2.3 Templates Component
35+
**Location:** `skills/templates/SKILL.md`
36+
37+
Build `setup-cdk-templates` skill:
38+
- [ ] CLAUDE.md templates by project type:
39+
- [ ] web-app (React, Next.js, Vue)
40+
- [ ] api (REST, GraphQL)
41+
- [ ] cli (Node, Python)
42+
- [ ] library (npm, pip package)
43+
- [ ] monorepo
44+
- [ ] `.claude/` directory scaffold (commands, hooks)
45+
- [ ] Project type detection logic
46+
- [ ] `create-claude-md` skill for existing projects
47+
48+
## Phase 3: Advanced Components
49+
50+
### 3.1 Quality Component
51+
**Location:** `skills/quality/SKILL.md`
52+
53+
Build `setup-cdk-quality` skill:
54+
- [ ] Enforcement level config (advisory/soft/hard)
55+
- [ ] Pre-commit hook collection
56+
- [ ] CI workflow templates (GitHub Actions)
57+
- [ ] Code review checklist skill
58+
- [ ] Per-project `.cdk-quality.json` config
59+
60+
### 3.2 Memory Component
61+
**Location:** `skills/memory/SKILL.md`
62+
63+
Build `setup-cdk-memory` skill:
64+
- [ ] Conversation search tool
65+
- [ ] Context summarization helper
66+
- [ ] Session export utility
67+
- [ ] Project memory patterns
68+
69+
## Phase 4: Distribution
70+
71+
### 4.1 Fallback Installer
72+
**Location:** `install.sh`
73+
74+
- [ ] Non-Claude installation script
75+
- [ ] Interactive prompts for bundle selection
76+
- [ ] Dependency checking (brew, git, etc.)
77+
- [ ] Cross-platform support (macOS, Linux)
78+
79+
### 4.2 Update Mechanism
80+
**Location:** `skills/update/SKILL.md`
81+
82+
- [ ] `update-claude-dev-kit` skill
83+
- [ ] Version checking against registry
84+
- [ ] Component-level updates
85+
- [ ] Changelog display
86+
87+
### 4.3 GitHub Release
88+
- [ ] Initial commit and push
89+
- [ ] GitHub Actions for releases
90+
- [ ] Documentation site (optional)
91+
- [ ] Community contribution guidelines
92+
93+
## Phase 5: Polish
94+
95+
### 5.1 Testing
96+
- [ ] Test on fresh macOS VM
97+
- [ ] Test on fresh Ubuntu VM
98+
- [ ] Test adaptation mode with existing configs
99+
- [ ] Document edge cases
100+
101+
### 5.2 Documentation
102+
- [ ] Component-specific READMEs
103+
- [ ] Troubleshooting guide
104+
- [ ] Contributing guide
105+
- [ ] Video walkthrough (optional)
106+
107+
---
108+
109+
## Quick Start for Contributors
110+
111+
```bash
112+
cd ~/github/claude-dev-kit-skills
113+
114+
# Read the design first
115+
cat docs/plans/2025-12-07-claude-dev-kit-design.md
116+
117+
# See existing skills
118+
cat skills/SKILL.md # Main installer
119+
cat skills/shell/SKILL.md # Shell component
120+
121+
# Build next component
122+
# Pick from Phase 2 above
123+
```
124+
125+
## Priority Order
126+
127+
1. **Editor** - High value, straightforward
128+
2. **Git** - High value, commonly needed
129+
3. **Templates** - Medium value, enables project setup
130+
4. **Quality** - Medium value, team-focused
131+
5. **Memory** - Lower priority, can defer
132+
6. **install.sh** - Needed for non-Claude users
133+
7. **Update mechanism** - Needed before v1.0 release
134+
135+
## Notes
136+
137+
- Each skill should follow the pattern in `skills/shell/SKILL.md`
138+
- Include adaptation mode handling (detect existing, backup, merge)
139+
- Add verification steps at the end
140+
- Keep skills under 500 words where possible

0 commit comments

Comments
 (0)