22
33A comprehensive, Claude-native developer environment toolkit.
44
5- ** Claude installs itself ** - the installer is a skill that Claude runs interactively .
5+ Optimizes your machine for Claude Code development: shell, editor, git, templates, quality gates, and more .
66
7- ## Installation
7+ ## Two Ways to Install
88
9- ### As Claude Code Plugin (Recommended)
9+ | Method | Best For | Experience |
10+ | --------| ----------| ------------|
11+ | ** Claude Code Plugin** | Claude Code users | Interactive, conversational setup |
12+ | ** Standalone Script** | Anyone | Traditional CLI installer |
1013
11- ``` bash
12- # Install from GitHub
13- claude /install-plugin github:auge2u/claude-dev-kit
14- ```
14+ Both methods configure the same things - choose based on your preference.
1515
16- Once installed, the skills are automatically available in Claude Code.
16+ ---
1717
18- ### Quick Start with Claude Code
18+ ## Option 1: Claude Code Plugin (Interactive)
1919
20- ``` bash
21- # In Claude Code, simply say:
22- " Set up my dev environment for Claude"
20+ If you have Claude Code, install as a plugin for the full interactive experience:
2321
24- # Or invoke the skill directly:
25- Skill: setup-claude-dev-kit
22+ ``` bash
23+ # Install the plugin
24+ claude /install-plugin github:auge2u/claude-dev-kit
2625```
2726
28- ### Without Claude Code
27+ Then start a conversation:
2928
3029``` bash
31- # One-liner installation
32- curl -fsSL https://raw.githubusercontent.com/claude-dev-kit/claude-dev-kit/main/install.sh | bash
30+ # Ask Claude to set up your environment
31+ claude " Set up my dev environment "
3332
34- # Or clone and run
35- git clone https://github.com/claude-dev-kit/claude-dev-kit.git
36- cd claude-dev-kit
37- ./install.sh
33+ # Or be specific
34+ claude " Setup shell with powerlevel10k"
35+ claude " Configure VS Code for Claude development"
3836```
3937
40- ## Bundles
41-
42- | Bundle | Components | Use Case |
43- | --------| ------------| ----------|
44- | ** minimal** | shell | Quick setup, just the essentials |
45- | ** standard** | shell, editor, git, templates | Most developers |
46- | ** full** | all components | Complete optimization |
38+ ** What you get:**
39+ - Claude walks you through options
40+ - Asks about your preferences
41+ - Adapts to your existing setup
42+ - Explains what it's doing
4743
48- ## Components
44+ ---
4945
50- | Component | Skill | Description |
51- | -----------| -------| -------------|
52- | Shell | [ ` setup-cdk-shell ` ] ( skills/shell/SKILL.md ) | Zsh, Powerlevel10k, completions, aliases |
53- | Editor | [ ` setup-cdk-editor ` ] ( skills/editor/SKILL.md ) | VS Code/Cursor settings, extensions |
54- | Git | [ ` setup-cdk-git ` ] ( skills/git/SKILL.md ) | Hooks, commit templates, PR workflows |
55- | Templates | [ ` setup-cdk-templates ` ] ( skills/templates/SKILL.md ) | CLAUDE.md templates, project scaffolds |
56- | Quality | [ ` setup-cdk-quality ` ] ( skills/quality/SKILL.md ) | Linting, CI workflows, review automation |
57- | Memory | [ ` setup-cdk-memory ` ] ( skills/memory/SKILL.md ) | Context management, session export |
46+ ## Option 2: Standalone Script (No Claude Required)
5847
59- ## Installation Modes
48+ Run directly without Claude Code:
6049
61- ### Greenfield (Fresh Machine)
62- Opinionated defaults, fast setup, minimal questions.
50+ ``` bash
51+ # One-liner (interactive)
52+ curl -fsSL https://raw.githubusercontent.com/auge2u/claude-dev-kit/main/install.sh | bash
6353
64- ### Adaptation (Existing Setup)
65- Respects your config, shows diffs, backs up before changes.
54+ # Or clone first
55+ git clone https://github.com/auge2u/claude-dev-kit.git
56+ cd claude-dev-kit
57+ ./install.sh
58+ ```
6659
67- ## Install Script Options
60+ ** Fastest install ** - no prompts, smart defaults:
6861
6962``` bash
70- ./install.sh [options]
63+ ./install.sh --feeling-lucky
7164```
7265
66+ ### Script Options
67+
7368| Flag | Description |
7469| ------| -------------|
7570| ` --feeling-lucky ` | Auto-configure everything with smart defaults |
76- | ` --bundle <name> ` | Choose bundle: minimal, standard, full |
71+ | ` --bundle <name> ` | Choose bundle: ` minimal ` , ` standard ` , ` full ` |
7772| ` --non-interactive ` | Skip all prompts, use defaults |
7873| ` --help ` | Show help |
7974
80- ** Fastest install:**
81- ``` bash
82- ./install.sh --feeling-lucky
83- ```
75+ ---
76+
77+ ## What Gets Installed
78+
79+ ### Bundles
80+
81+ | Bundle | Components | Use Case |
82+ | --------| ------------| ----------|
83+ | ** minimal** | shell | Quick setup, just the essentials |
84+ | ** standard** | shell, editor, git, templates | Most developers (default) |
85+ | ** full** | all components | Complete optimization |
86+
87+ ### Components
88+
89+ | Component | What it does |
90+ | -----------| --------------|
91+ | ** Shell** | Zsh, Oh My Zsh, Powerlevel10k, MesloLGS fonts, aliases |
92+ | ** Editor** | VS Code/Cursor settings, extensions (GitLens, Error Lens, Prettier) |
93+ | ** Git** | Pre-commit hooks, commit templates, PR templates, conventions |
94+ | ** Templates** | CLAUDE.md templates, ` .claude/ ` directory scaffolds |
95+ | ** Quality** | Linting setup, CI workflows, code review checklists |
96+ | ** Memory** | Context management, session export, project memory |
97+
98+ ## Installation Modes
99+
100+ The installer detects your environment and adapts:
101+
102+ | Mode | When | Behavior |
103+ | ------| ------| ----------|
104+ | ** Greenfield** | Fresh machine, minimal config | Opinionated defaults, fast setup |
105+ | ** Adaptation** | Existing setup detected | Respects your config, backs up before changes |
84106
85107## Updating
86108
87109``` bash
88110# With Claude Code
89111claude " update-claude-dev-kit"
90112
91- # Or re-run install script (safe to run multiple times)
113+ # Or re-run install script (idempotent - safe to run multiple times)
92114./install.sh
93115```
94116
@@ -102,12 +124,12 @@ claude "update-claude-dev-kit"
102124
103125## Requirements
104126
127+ ** Required:**
105128- macOS 12+ or Ubuntu 22.04+
106- - git
107- - curl
129+ - git, curl
108130
109- Optional:
110- - [ Claude Code] ( https://claude.ai/code ) - For the full interactive experience
131+ ** Optional:**
132+ - [ Claude Code] ( https://claude.ai/code ) - For the interactive plugin experience
111133- VS Code or Cursor - For editor component
112134
113135## License
0 commit comments