claudekit-cli 1.16.0 → 2.0.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 CHANGED
@@ -2,27 +2,32 @@
2
2
 
3
3
  Command-line tool for bootstrapping and updating ClaudeKit projects.
4
4
 
5
- ## Project Overview
5
+ **Version**: 1.16.0
6
6
 
7
- **ClaudeKit CLI** (`ck`) is a command-line tool for bootstrapping and updating projects from private GitHub repository releases. Built with Bun and TypeScript, it provides fast, secure, and user-friendly project setup and maintenance.
7
+ ## Overview
8
+
9
+ ClaudeKit CLI (`ck`) is a command-line tool for bootstrapping and updating projects from private GitHub releases. Built with Bun and TypeScript, provides fast, secure project setup and maintenance.
8
10
 
9
11
  **Key Features:**
10
- - Multi-tier GitHub authentication (`gh` CLI → env vars → keychain → prompt)
12
+ - Multi-tier GitHub authentication (gh CLI → env vars → keychain → prompt)
11
13
  - Streaming downloads with progress tracking
12
14
  - Smart file merging with conflict detection
13
- - Automatic skills directory migration (flat → categorized)
15
+ - Automatic skills directory migration
14
16
  - Secure credential storage using OS keychain
15
17
  - Beautiful CLI interface with interactive prompts
18
+ - Optional package installation (OpenCode, Gemini)
19
+ - System dependency auto-installation
16
20
 
17
21
  ## Documentation
18
22
 
19
- Comprehensive documentation is available in the `/docs` directory:
23
+ Comprehensive documentation in `/docs`:
20
24
 
21
- - **[Project Overview & PDR](./docs/project-overview-pdr.md)** - Product requirements, features, roadmap, and success metrics
22
- - **[Codebase Summary](./docs/codebase-summary.md)** - High-level overview, structure, key components, and metrics
23
- - **[Code Standards](./docs/code-standards.md)** - Coding conventions, best practices, and quality guidelines
24
- - **[System Architecture](./docs/system-architecture.md)** - Architecture diagrams, data flow, and integration points
25
- - **[Binary Distribution](./docs/binary-distribution.md)** - Platform-specific binary compilation and distribution
25
+ - **[Codebase Summary](./docs/codebase-summary.md)** - Overview, structure, key components
26
+ - **[Project Overview & PDR](./docs/project-overview-pdr.md)** - Requirements, features, roadmap
27
+ - **[System Architecture](./docs/system-architecture.md)** - Architecture diagrams, data flow
28
+ - **[Code Standards](./docs/code-standards.md)** - Coding conventions, best practices
29
+ - **[Project Roadmap](./docs/project-roadmap.md)** - Release timeline, feature status
30
+ - **[Deployment Guide](./docs/deployment-guide.md)** - Release procedures
26
31
 
27
32
  ## Prerequisites
28
33
 
@@ -70,161 +75,90 @@ ck --version
70
75
 
71
76
  ## Usage
72
77
 
73
- ### Create a New Project
78
+ ### Create New Project
74
79
 
75
80
  ```bash
76
- # Interactive mode (with version selection prompt)
81
+ # Interactive mode
77
82
  ck new
78
83
 
79
84
  # With options
80
85
  ck new --dir my-project --kit engineer
81
86
 
82
- # Show beta versions in selection prompt
83
- ck new --kit engineer --beta
87
+ # Show beta versions
88
+ ck new --beta
84
89
 
85
90
  # With exclude patterns
86
- ck new --kit engineer --exclude "*.log" --exclude "temp/**"
87
-
88
- # Multiple patterns
89
- ck new --exclude "*.log" --exclude "*.tmp" --exclude "cache/**"
90
-
91
- # With optional package installations (interactive)
92
- ck new
91
+ ck new --exclude "*.log" --exclude "temp/**"
93
92
 
94
- # With optional package installations (non-interactive)
93
+ # Optional packages (OpenCode, Gemini)
95
94
  ck new --opencode --gemini
96
- ck new --opencode
97
- ck new --gemini
98
95
 
99
- # With skills dependencies installation
100
- ck new --install-skills # Install Python packages, system tools
101
- ck new --opencode --gemini --install-skills # Install all optional packages
96
+ # Install skills dependencies (Python, Node packages, system tools)
97
+ ck new --install-skills
102
98
 
103
- # With /ck: prefix for slash commands
104
- ck new --prefix # All commands will be prefixed with /ck:
105
- ck new --prefix --kit engineer
99
+ # Command prefix (/ck: namespace to avoid conflicts)
100
+ ck new --prefix
106
101
  ```
107
102
 
108
- **Skills Dependencies Installation (`--install-skills` flag):**
109
-
110
- The `--install-skills` flag automatically installs dependencies required for ClaudeKit skills, including:
111
- - Python packages (google-genai, pypdf, python-docx, Pillow, etc.)
112
- - System tools (FFmpeg, ImageMagick)
113
- - Node.js global packages (rmbg-cli, pnpm, wrangler, repomix)
114
-
115
- **Interactive mode:**
116
- ```bash
117
- ck new # Will prompt: "Install skills dependencies?"
118
- ```
119
-
120
- **Non-interactive mode:**
121
- ```bash
122
- ck new --install-skills # Auto-install skills dependencies
123
- ck init --install-skills # Auto-install during update
124
- ck init --global --install-skills # Install for global setup
125
- ```
126
-
127
- **Platform support:**
128
- - **Linux/macOS**: Runs `.claude/skills/install.sh`
129
- - **Windows**: Runs `.claude/skills/install.ps1`
130
-
131
- **Note**: Installation is optional and non-blocking. If it fails, you can install manually later using the installation script in `.claude/skills/`.
132
-
133
- **Command Prefix (`--prefix` flag):**
134
-
135
- The `--prefix` flag reorganizes slash commands to use a `/ck:` namespace, moving all commands from `.claude/commands/*` to `.claude/commands/ck/*`.
136
-
137
- **Benefits:**
138
- - Namespace all ClaudeKit commands under `/ck:` (e.g., `/ck:plan`, `/ck:fix`, `/ck:cook`)
139
- - Avoid conflicts with user's custom commands or other tools
140
- - Cleaner command organization
141
-
142
- **Example:**
143
- ```bash
144
- # Without --prefix
145
- /plan, /fix, /cook
146
-
147
- # With --prefix
148
- /ck:plan, /ck:fix, /ck:cook
149
- ```
103
+ **Flags:**
104
+ - `--install-skills`: Auto-install Python packages, system tools (FFmpeg, ImageMagick), Node.js packages
105
+ - `--prefix`: Move commands to /ck: namespace (/plan /ck:plan)
106
+ - `--beta`: Show pre-release versions in selection
107
+ - `--opencode/--gemini`: Install optional packages
150
108
 
151
109
  ### Initialize or Update Project
152
110
 
153
- **Note:** this command should be run from the root directory of your project.
154
-
155
- **⚠️ Deprecation Notice:** The `update` command has been renamed to `init`. The `update` command still works but will show a deprecation warning. Please use `init` instead.
111
+ **Note:** Run from project root.
156
112
 
157
113
  ```bash
158
- # Interactive mode with version selection (recommended)
114
+ # Interactive mode
159
115
  ck init
160
116
 
161
117
  # With options
162
- ck init --kit engineer
163
-
164
- # Show beta versions in selection prompt
165
118
  ck init --kit engineer --beta
166
119
 
167
- # With exclude patterns
168
- ck init --exclude "local-config/**" --exclude "*.local"
169
-
170
- # Global mode - use platform-specific user configuration
120
+ # Global mode (platform-specific paths)
171
121
  ck init --global
172
- ck init -g --kit engineer
173
122
 
174
- # Fresh installation - completely remove .claude directory before downloading
175
- # ⚠️ WARNING: This will permanently delete ALL custom files and configurations!
123
+ # Fresh installation (⚠️ DESTRUCTIVE - removes ALL customizations)
176
124
  ck init --fresh
177
- ck init --fresh --global # Fresh install in global mode
178
125
 
179
- # With /ck: prefix for slash commands
180
- ck init --prefix # All commands will be prefixed with /ck:
181
- ck init --prefix --global
182
-
183
- # Legacy (deprecated - use 'init' instead)
184
- ck update # Shows deprecation warning
126
+ # With exclude patterns and prefix
127
+ ck init --exclude "*.local" --prefix
185
128
  ```
186
129
 
187
- **Fresh Installation (`--fresh` flag):**
188
-
189
- ⚠️ **WARNING: DESTRUCTIVE OPERATION**
130
+ **Flags:**
131
+ - `--global/-g`: Use platform-specific config (macOS/Linux: ~/.claude, Windows: %USERPROFILE%\.claude)
132
+ - `--fresh`: Clean reinstall, removes .claude directory (requires "yes" confirmation)
133
+ - `--beta`: Show pre-release versions
134
+ - `--prefix`: Apply /ck: namespace to commands
190
135
 
191
- The `--fresh` flag completely removes your `.claude` directory before downloading a new version. This is useful when:
192
- - You want a completely clean installation
193
- - You're experiencing corruption or configuration issues
194
- - You want to reset to default settings
136
+ ### Update CLI
195
137
 
196
- **What happens:**
197
- 1. Shows confirmation prompt with full path to be deleted
198
- 2. Requires typing "yes" to confirm
199
- 3. Completely removes the `.claude` directory (or global directory with `--global`)
200
- 4. Permanently deletes ALL custom files, configurations, and modifications
201
- 5. Downloads and installs fresh version
202
-
203
- **⚠️ Use with extreme caution:** All customizations will be lost. Back up any custom files before using this flag.
138
+ Keep the ClaudeKit CLI up to date:
204
139
 
205
140
  ```bash
206
- # Fresh installation examples
207
- ck init --fresh # Remove local .claude directory
208
- ck init --fresh --global # Remove global ~/.claude directory
209
- ck init --fresh --kit engineer # Fresh install specific kit
210
- ```
141
+ # Check for CLI updates
142
+ ck update --check
211
143
 
212
- **Global vs Local Configuration:**
144
+ # Update to latest version
145
+ ck update
213
146
 
214
- By default, ClaudeKit will be installed in the current directory (`.claude` directory), or we used to call it project-scoped.
147
+ # Update to specific version
148
+ ck update --version 1.17.0
215
149
 
216
- For platform-specific user-scoped (global) settings:
217
- - **macOS/Linux**: `~/.claude`
218
- - **Windows**: `%USERPROFILE%\.claude`
150
+ # Update to beta / skip confirmation
151
+ ck update --beta
152
+ ck update --yes
153
+ ```
219
154
 
220
- Global mode uses user-scoped directories (no sudo required), allowing separate configurations for different projects.
155
+ The CLI notifies you when updates are available via `ck --version`.
221
156
 
222
- **Automatic Skills Migration:**
223
- - Detects structure changes (flat → categorized)
224
- - Preserves all customizations via SHA-256 hashing
157
+ **Skills Migration:**
158
+ - Auto-detects structure changes (flat → categorized)
159
+ - Preserves customizations (SHA-256 hashing)
225
160
  - Creates backup before migration
226
161
  - Rollback on failure
227
- - Interactive prompts for confirmation
228
162
 
229
163
  ### List Available Versions
230
164
 
@@ -245,62 +179,56 @@ ck versions --all
245
179
 
246
180
  ### Diagnostics & Doctor
247
181
 
248
- The `ck doctor` command checks system dependencies required for ClaudeKit skills and offers to install them automatically.
249
-
250
182
  ```bash
251
- # Interactive mode - checks and offers to install missing dependencies
183
+ # Check system dependencies, offer auto-installation
252
184
  ck doctor
253
185
 
254
- # Check only global installation status (skip project-specific checks)
186
+ # Global installation check only
255
187
  ck doctor --global
256
- ck doctor -g
257
188
 
258
- # Non-interactive mode (CI/CD) - shows status only
189
+ # Non-interactive mode (CI/CD)
259
190
  CI=true ck doctor
260
- NON_INTERACTIVE=1 ck doctor
261
191
 
262
- # Also available: authentication and access diagnostics
263
- ck diagnose # Check auth, access, releases
264
- ck diagnose --verbose # Detailed diagnostics
192
+ # Auth and access diagnostics
193
+ ck diagnose
194
+ ck diagnose --verbose
265
195
  ```
266
196
 
267
- **What it checks:**
268
- - Claude CLI (optional, v1.0.0+)
269
- - Python (required, v3.8.0+)
270
- - pip (required, any version)
271
- - Node.js (required, v16.0.0+)
272
- - npm (required, any version)
273
- - Skills dependencies installation status (global and project)
274
- - Global and project ClaudeKit setup
275
- - Component counts (agents, commands, workflows, skills)
276
-
277
- **Auto-installation support:**
278
- - **macOS**: Homebrew, installer script
279
- - **Linux**: apt, dnf, pacman, installer script
280
- - **Windows**: PowerShell script
281
- - Cross-platform with WSL support
282
-
283
- **Security notes:**
284
- - All installations require user confirmation in interactive mode
285
- - Manual installation instructions provided as fallback
286
- - No automatic installation in CI/CD environments
197
+ **Checks:**
198
+ - Claude CLI (optional, v1.0.0+), Python (3.8.0+), pip, Node.js (16.0.0+), npm
199
+ - Skills dependencies status
200
+ - ClaudeKit setup (global and project)
201
+ - Component counts
202
+
203
+ **Auto-installation:** macOS (Homebrew), Linux (apt/dnf/pacman), Windows (PowerShell). Requires user confirmation in interactive mode.
287
204
 
288
205
  ### Uninstall
289
206
 
290
207
  Remove ClaudeKit installations from your system:
291
208
 
292
209
  ```bash
293
- ck uninstall # Interactive mode - prompts for confirmation
210
+ ck uninstall # Interactive mode - prompts for scope and confirmation
211
+ ck uninstall --local # Uninstall only local installation (current project)
212
+ ck uninstall --global # Uninstall only global installation (~/.claude/)
213
+ ck uninstall -l -y # Local only, skip confirmation
214
+ ck uninstall -g -y # Global only, skip confirmation
294
215
  ck uninstall --yes # Non-interactive - skip confirmation (for scripts)
295
- ck uninstall -y # Short flag
296
216
  ```
297
217
 
218
+ **Scope Selection:**
219
+ - When both local and global installations exist, you'll be prompted to choose:
220
+ - **Local only**: Remove from current project (`.claude/`)
221
+ - **Global only**: Remove from user directory (`~/.claude/`)
222
+ - **Both**: Remove all ClaudeKit installations
223
+ - Use `--local` or `--global` flags to skip the prompt
224
+
298
225
  **What it does:**
299
226
  - Detects local `.claude` directory in current project
300
227
  - Detects global `~/.claude` ClaudeKit installation
301
228
  - Shows paths before deletion
302
229
  - Requires confirmation (unless `--yes` flag)
303
- - Safely removes detected installations
230
+ - Removes ClaudeKit subdirectories (`commands/`, `agents/`, `skills/`, `workflows/`, `hooks/`, `metadata.json`)
231
+ - **Preserves user configs** like `settings.json`, `settings.local.json`, and `CLAUDE.md`
304
232
 
305
233
  **Note:** Only removes valid ClaudeKit installations (with metadata.json). Regular `.claude` directories from Claude Desktop are not affected.
306
234
 
Binary file
package/bin/ck-darwin-x64 CHANGED
Binary file
package/bin/ck-linux-x64 CHANGED
Binary file
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "claudekit-cli",
3
- "version": "1.16.0",
3
+ "version": "2.0.0",
4
4
  "description": "CLI tool for bootstrapping and updating ClaudeKit projects",
5
5
  "type": "module",
6
6
  "repository": {