ccjk 1.3.1
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/LICENSE +21 -0
- package/README.ja.md +455 -0
- package/README.ko.md +455 -0
- package/README.md +550 -0
- package/README.zh-CN.md +488 -0
- package/bin/ccjk.mjs +2 -0
- package/dist/chunks/api-providers.mjs +89 -0
- package/dist/chunks/claude-code-config-manager.mjs +733 -0
- package/dist/chunks/claude-code-incremental-manager.mjs +603 -0
- package/dist/chunks/codex-config-switch.mjs +427 -0
- package/dist/chunks/codex-provider-manager.mjs +232 -0
- package/dist/chunks/codex-uninstaller.mjs +404 -0
- package/dist/chunks/commands.mjs +120 -0
- package/dist/chunks/features.mjs +642 -0
- package/dist/chunks/simple-config.mjs +10445 -0
- package/dist/cli.d.mts +1 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.mjs +5972 -0
- package/dist/i18n/locales/en/api.json +63 -0
- package/dist/i18n/locales/en/ccjk.json +276 -0
- package/dist/i18n/locales/en/ccr.json +65 -0
- package/dist/i18n/locales/en/cli.json +57 -0
- package/dist/i18n/locales/en/codex.json +124 -0
- package/dist/i18n/locales/en/cometix.json +29 -0
- package/dist/i18n/locales/en/common.json +20 -0
- package/dist/i18n/locales/en/configuration.json +77 -0
- package/dist/i18n/locales/en/errors.json +26 -0
- package/dist/i18n/locales/en/installation.json +80 -0
- package/dist/i18n/locales/en/interview.json +104 -0
- package/dist/i18n/locales/en/language.json +19 -0
- package/dist/i18n/locales/en/mcp.json +38 -0
- package/dist/i18n/locales/en/menu.json +51 -0
- package/dist/i18n/locales/en/multi-config.json +79 -0
- package/dist/i18n/locales/en/shencha.json +14 -0
- package/dist/i18n/locales/en/team.json +7 -0
- package/dist/i18n/locales/en/tools.json +42 -0
- package/dist/i18n/locales/en/uninstall.json +56 -0
- package/dist/i18n/locales/en/updater.json +25 -0
- package/dist/i18n/locales/en/workflow.json +25 -0
- package/dist/i18n/locales/zh-CN/api.json +63 -0
- package/dist/i18n/locales/zh-CN/ccjk.json +276 -0
- package/dist/i18n/locales/zh-CN/ccr.json +65 -0
- package/dist/i18n/locales/zh-CN/cli.json +57 -0
- package/dist/i18n/locales/zh-CN/codex.json +124 -0
- package/dist/i18n/locales/zh-CN/cometix.json +29 -0
- package/dist/i18n/locales/zh-CN/common.json +20 -0
- package/dist/i18n/locales/zh-CN/configuration.json +77 -0
- package/dist/i18n/locales/zh-CN/errors.json +26 -0
- package/dist/i18n/locales/zh-CN/installation.json +80 -0
- package/dist/i18n/locales/zh-CN/interview.json +104 -0
- package/dist/i18n/locales/zh-CN/language.json +19 -0
- package/dist/i18n/locales/zh-CN/mcp.json +38 -0
- package/dist/i18n/locales/zh-CN/menu.json +51 -0
- package/dist/i18n/locales/zh-CN/multi-config.json +79 -0
- package/dist/i18n/locales/zh-CN/shencha.json +14 -0
- package/dist/i18n/locales/zh-CN/team.json +7 -0
- package/dist/i18n/locales/zh-CN/tools.json +42 -0
- package/dist/i18n/locales/zh-CN/uninstall.json +56 -0
- package/dist/i18n/locales/zh-CN/updater.json +25 -0
- package/dist/i18n/locales/zh-CN/workflow.json +25 -0
- package/dist/index.d.mts +2644 -0
- package/dist/index.d.ts +2644 -0
- package/dist/index.mjs +1706 -0
- package/package.json +157 -0
- package/templates/CLAUDE.md +219 -0
- package/templates/claude-code/CLAUDE.md +250 -0
- package/templates/claude-code/common/settings.json +38 -0
- package/templates/claude-code/en/workflow/bmad/commands/bmad-init.md +165 -0
- package/templates/claude-code/en/workflow/common/agents/get-current-datetime.md +29 -0
- package/templates/claude-code/en/workflow/common/agents/init-architect.md +114 -0
- package/templates/claude-code/en/workflow/common/commands/init-project.md +53 -0
- package/templates/claude-code/en/workflow/plan/agents/planner.md +116 -0
- package/templates/claude-code/en/workflow/plan/agents/ui-ux-designer.md +91 -0
- package/templates/claude-code/en/workflow/plan/commands/feat.md +105 -0
- package/templates/claude-code/zh-CN/workflow/bmad/commands/bmad-init.md +172 -0
- package/templates/claude-code/zh-CN/workflow/common/agents/get-current-datetime.md +29 -0
- package/templates/claude-code/zh-CN/workflow/common/agents/init-architect.md +114 -0
- package/templates/claude-code/zh-CN/workflow/common/commands/init-project.md +53 -0
- package/templates/claude-code/zh-CN/workflow/plan/agents/planner.md +116 -0
- package/templates/claude-code/zh-CN/workflow/plan/agents/ui-ux-designer.md +91 -0
- package/templates/claude-code/zh-CN/workflow/plan/commands/feat.md +105 -0
- package/templates/codex/common/config.toml +0 -0
- package/templates/common/output-styles/en/casual-friendly.md +97 -0
- package/templates/common/output-styles/en/engineer-professional.md +88 -0
- package/templates/common/output-styles/en/expert-concise.md +93 -0
- package/templates/common/output-styles/en/laowang-engineer.md +127 -0
- package/templates/common/output-styles/en/nekomata-engineer.md +120 -0
- package/templates/common/output-styles/en/ojousama-engineer.md +121 -0
- package/templates/common/output-styles/en/teaching-mode.md +102 -0
- package/templates/common/output-styles/en/technical-precise.md +101 -0
- package/templates/common/output-styles/zh-CN/engineer-professional.md +89 -0
- package/templates/common/output-styles/zh-CN/laowang-engineer.md +127 -0
- package/templates/common/output-styles/zh-CN/nekomata-engineer.md +120 -0
- package/templates/common/output-styles/zh-CN/ojousama-engineer.md +121 -0
- package/templates/common/workflow/git/en/git-cleanBranches.md +102 -0
- package/templates/common/workflow/git/en/git-commit.md +205 -0
- package/templates/common/workflow/git/en/git-rollback.md +90 -0
- package/templates/common/workflow/git/en/git-worktree.md +276 -0
- package/templates/common/workflow/git/zh-CN/git-cleanBranches.md +102 -0
- package/templates/common/workflow/git/zh-CN/git-commit.md +205 -0
- package/templates/common/workflow/git/zh-CN/git-rollback.md +90 -0
- package/templates/common/workflow/git/zh-CN/git-worktree.md +276 -0
- package/templates/common/workflow/interview/en/interview.md +212 -0
- package/templates/common/workflow/interview/zh-CN/interview.md +212 -0
- package/templates/common/workflow/sixStep/en/workflow.md +251 -0
- package/templates/common/workflow/sixStep/zh-CN/workflow.md +215 -0
- package/templates/industry/devops/en/ci-cd-pipeline.md +410 -0
- package/templates/industry/web-dev/en/api-design.md +299 -0
- package/templates/industry/web-dev/en/react-nextjs-setup.md +236 -0
package/README.md
ADDED
|
@@ -0,0 +1,550 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
SEO Meta: CCJK - Claude Code JinKu | Best AI Coding Assistant | 11+ AI Agents | Free & Open Source
|
|
3
|
+
Description: CCJK is the most powerful enhancement toolkit for Claude Code. Features 11+ AI agents,
|
|
4
|
+
LLM-driven code auditing, skills automation, and plugin system. Zero-config setup in seconds.
|
|
5
|
+
-->
|
|
6
|
+
|
|
7
|
+
<div align="center">
|
|
8
|
+
|
|
9
|
+
<!-- Logo & Badges - Optimized for GitHub Social Preview -->
|
|
10
|
+
<img src="https://raw.githubusercontent.com/miounet11/ccjk/main/docs/assets/ccjk-logo.png" alt="CCJK Logo" width="200" />
|
|
11
|
+
|
|
12
|
+
# CCJK - Claude Code JinKu
|
|
13
|
+
|
|
14
|
+
### 🏆 The #1 AI Coding Assistant Enhancement Toolkit
|
|
15
|
+
|
|
16
|
+
[![npm version][npm-version-src]][npm-version-href]
|
|
17
|
+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
|
18
|
+
[![License][license-src]][license-href]
|
|
19
|
+
[![GitHub stars][stars-src]][stars-href]
|
|
20
|
+
[](https://github.com/miounet11/ccjk/pulls)
|
|
21
|
+
|
|
22
|
+
**[English](README.md)** | **[简体中文](README.zh-CN.md)** | **[日本語](README.ja.md)** | **[한국어](README.ko.md)**
|
|
23
|
+
|
|
24
|
+
<br/>
|
|
25
|
+
|
|
26
|
+
## 🎉 v1.3.1 Released! (January 2025)
|
|
27
|
+
|
|
28
|
+
> **Complete Rebranding: ZCF → CCJK**
|
|
29
|
+
> - 🔄 All references updated from ZCF to CCJK
|
|
30
|
+
> - 🚀 New brand: **CCJK - Claude Code Jailbreak Kit**
|
|
31
|
+
> - ⬆️ Existing users: Run `ccjk upgrade` to update!
|
|
32
|
+
> - 🔧 Fixed install script version detection
|
|
33
|
+
|
|
34
|
+
<br/>
|
|
35
|
+
|
|
36
|
+
> 💡 **One command to supercharge your AI coding experience**
|
|
37
|
+
>
|
|
38
|
+
> ```bash
|
|
39
|
+
> curl -fsSL https://raw.githubusercontent.com/miounet11/ccjk/main/install.sh | bash
|
|
40
|
+
> ```
|
|
41
|
+
|
|
42
|
+
<br/>
|
|
43
|
+
|
|
44
|
+
[📖 Documentation](#-quick-start-guide) · [🚀 Features](#-core-features) · [💬 Community](#-community--support) · [🤝 Contributing](#-contributing)
|
|
45
|
+
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## 🎯 What is CCJK?
|
|
51
|
+
|
|
52
|
+
**CCJK (Claude Code JinKu)** transforms Claude Code from a simple AI assistant into a **complete AI development team**. With 11+ specialized AI agents, intelligent automation, and the world's first LLM-driven code auditor, CCJK helps you write better code faster.
|
|
53
|
+
|
|
54
|
+
<table>
|
|
55
|
+
<tr>
|
|
56
|
+
<td width="33%" align="center">
|
|
57
|
+
<h3>🤖 11+ AI Agents</h3>
|
|
58
|
+
<p>Security, Performance, Testing, DevOps, Code Review, and more</p>
|
|
59
|
+
</td>
|
|
60
|
+
<td width="33%" align="center">
|
|
61
|
+
<h3>⚡ Zero Config</h3>
|
|
62
|
+
<p>One command setup. Works out of the box.</p>
|
|
63
|
+
</td>
|
|
64
|
+
<td width="33%" align="center">
|
|
65
|
+
<h3>🆓 100% Free</h3>
|
|
66
|
+
<p>Open source. No hidden costs. MIT licensed.</p>
|
|
67
|
+
</td>
|
|
68
|
+
</tr>
|
|
69
|
+
</table>
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## 🚀 Quick Start Guide
|
|
74
|
+
|
|
75
|
+
### One-Click Installation (Recommended)
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
# Install with a single command
|
|
79
|
+
curl -fsSL https://raw.githubusercontent.com/miounet11/ccjk/main/install.sh | bash
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### 🇨🇳 中国用户安装 (China Mirror)
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
# 方式一:使用 ghproxy 镜像
|
|
86
|
+
curl -fsSL https://ghproxy.com/https://raw.githubusercontent.com/miounet11/ccjk/main/install.sh | bash
|
|
87
|
+
|
|
88
|
+
# 方式二:使用 npmmirror 直接安装
|
|
89
|
+
npm install -g ccjk --registry https://registry.npmmirror.com
|
|
90
|
+
|
|
91
|
+
# 方式三:使用 jsdelivr CDN
|
|
92
|
+
curl -fsSL https://cdn.jsdelivr.net/gh/miounet11/ccjk@main/install.sh | bash
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Alternative Installation Methods
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
# Option A: Clone and install manually
|
|
99
|
+
git clone https://github.com/miounet11/ccjk.git
|
|
100
|
+
cd ccjk && pnpm install && pnpm build && npm install -g .
|
|
101
|
+
|
|
102
|
+
# Option B: Install from GitHub directly
|
|
103
|
+
npm install -g git+https://github.com/miounet11/ccjk.git
|
|
104
|
+
|
|
105
|
+
# Option C: Use gitee mirror (中国镜像)
|
|
106
|
+
git clone https://gitee.com/mirrors/ccjk.git
|
|
107
|
+
cd ccjk && pnpm install && pnpm build && npm install -g .
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Step 2: Configure Your API
|
|
111
|
+
|
|
112
|
+
When you run `ccjk`, you'll see a friendly menu:
|
|
113
|
+
|
|
114
|
+
```
|
|
115
|
+
╔═══════════════════════════════════════════════════════════╗
|
|
116
|
+
║ ██████╗ ██████╗ ██╗██╗ ██╗ ║
|
|
117
|
+
║ ██╔════╝██╔════╝ ██║██║ ██╔╝ ║
|
|
118
|
+
║ ██║ ██║ ██║█████╔╝ Claude Code JinKu ║
|
|
119
|
+
║ ██║ ██║ ██ ██║██╔═██╗ v1.3.1 ║
|
|
120
|
+
║ ╚██████╗╚██████╗╚█████╔╝██║ ██╗ ║
|
|
121
|
+
║ ╚═════╝ ╚═════╝ ╚════╝ ╚═╝ ╚═╝ ║
|
|
122
|
+
╚═══════════════════════════════════════════════════════════╝
|
|
123
|
+
|
|
124
|
+
? Select an option:
|
|
125
|
+
❯ 🚀 Quick Setup (Recommended)
|
|
126
|
+
⚙️ API Configuration
|
|
127
|
+
🛠️ Advanced Settings
|
|
128
|
+
📖 Help
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
Just select **"Quick Setup"** and follow the prompts!
|
|
132
|
+
|
|
133
|
+
### Step 3: Start Coding!
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
# Run Claude Code with CCJK enhancements
|
|
137
|
+
claude
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
That's it! You now have access to 11+ AI agents, skills automation, and more.
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## ✨ Core Features
|
|
145
|
+
|
|
146
|
+
### 🤖 AI Agent Army
|
|
147
|
+
|
|
148
|
+
Your personal AI development team, available 24/7:
|
|
149
|
+
|
|
150
|
+
| Agent | What It Does | Example Use Case |
|
|
151
|
+
|-------|--------------|------------------|
|
|
152
|
+
| 🛡️ **Security Expert** | Finds vulnerabilities, OWASP checks | "Review this auth code for security issues" |
|
|
153
|
+
| ⚡ **Performance Expert** | Optimizes speed, reduces memory | "Why is my app slow?" |
|
|
154
|
+
| 🧪 **Testing Specialist** | Writes tests, coverage analysis | "Add unit tests for this function" |
|
|
155
|
+
| 🚀 **DevOps Expert** | CI/CD, Docker, Kubernetes | "Create a GitHub Actions workflow" |
|
|
156
|
+
| 📝 **Code Reviewer** | Best practices, code quality | "Review this PR" |
|
|
157
|
+
| 🏗️ **API Architect** | REST, GraphQL, API design | "Design an API for user management" |
|
|
158
|
+
| 💾 **Database Expert** | Query optimization, indexing | "Optimize this SQL query" |
|
|
159
|
+
| 🎨 **Frontend Architect** | React, Vue, accessibility | "Refactor this component" |
|
|
160
|
+
| ⚙️ **Backend Architect** | Microservices, event-driven | "Design a scalable backend" |
|
|
161
|
+
| 📚 **Documentation Expert** | API docs, READMEs, guides | "Document this codebase" |
|
|
162
|
+
| 🔄 **Refactoring Expert** | Clean code, design patterns | "Refactor using SOLID principles" |
|
|
163
|
+
|
|
164
|
+
### 🔍 ShenCha - AI Code Auditor
|
|
165
|
+
|
|
166
|
+
The world's first **fully autonomous** AI code auditor:
|
|
167
|
+
|
|
168
|
+
```
|
|
169
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
170
|
+
│ 🧠 ShenCha Audit Engine │
|
|
171
|
+
├─────────────────────────────────────────────────────────────┤
|
|
172
|
+
│ │
|
|
173
|
+
│ 1️⃣ SCAN → AI discovers issues (no predefined rules) │
|
|
174
|
+
│ 2️⃣ ANALYZE → Understands context and impact │
|
|
175
|
+
│ 3️⃣ FIX → Generates and applies fixes automatically │
|
|
176
|
+
│ 4️⃣ VERIFY → Confirms fixes work correctly │
|
|
177
|
+
│ │
|
|
178
|
+
│ ✅ Runs continuously in 72-hour cycles │
|
|
179
|
+
│ ✅ Generates comprehensive reports │
|
|
180
|
+
│ │
|
|
181
|
+
└─────────────────────────────────────────────────────────────┘
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### 🎤 Interview-Driven Development (NEW!)
|
|
185
|
+
|
|
186
|
+
> **"Interview first. Spec second. Code last."** - Based on Thariq (@trq212) from Anthropic's viral workflow (1.2M views)
|
|
187
|
+
|
|
188
|
+
Stop coding the wrong thing! The Interview system surfaces **hidden assumptions** before any code is written:
|
|
189
|
+
|
|
190
|
+
```
|
|
191
|
+
╔════════════════ Interview Progress ════════════════╗
|
|
192
|
+
║ ║
|
|
193
|
+
║ ← ☑ Industry │ ☐ Customer │ ☐ Features │ ☐ Submit →║
|
|
194
|
+
║ ║
|
|
195
|
+
║ Question 12 of ~40 ║
|
|
196
|
+
║ ║
|
|
197
|
+
║ What's your target customer segment? ║
|
|
198
|
+
║ ║
|
|
199
|
+
║ ❯ 1. ⚡ Quick Start (Recommended) ║
|
|
200
|
+
║ 2. 🔬 Deep Dive ║
|
|
201
|
+
║ 3. ⚙️ Custom Setup ║
|
|
202
|
+
║ 4. 💨 Express Mode ║
|
|
203
|
+
║ ║
|
|
204
|
+
╚═════════════════════════════════════════════════════╝
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
```bash
|
|
208
|
+
# In Claude Code, just type:
|
|
209
|
+
/ccjk:interview # Smart mode selector
|
|
210
|
+
/ccjk:interview --quick # 10 essential questions
|
|
211
|
+
/ccjk:interview --deep # 40+ comprehensive questions
|
|
212
|
+
|
|
213
|
+
# Or use the CLI:
|
|
214
|
+
ccjk interview # Interactive interview
|
|
215
|
+
ccjk quick # Express mode
|
|
216
|
+
ccjk deep # Deep dive mode
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
**Features:**
|
|
220
|
+
- 🧠 **Smart Project Detection** - Auto-detects webapp/api/saas/ecommerce
|
|
221
|
+
- 📊 **Progress Tracking** - Visual breadcrumbs and progress bar
|
|
222
|
+
- ⏸️ **Pause & Resume** - Save progress and continue later
|
|
223
|
+
- 📝 **Spec Generation** - Outputs comprehensive SPEC.md file
|
|
224
|
+
|
|
225
|
+
### ⚡ Skills System
|
|
226
|
+
|
|
227
|
+
Create powerful automation with simple commands:
|
|
228
|
+
|
|
229
|
+
```bash
|
|
230
|
+
# For TypeScript developers
|
|
231
|
+
ccjk skills create-batch --lang typescript
|
|
232
|
+
# Creates: ts-debug, ts-refactor, ts-test, ts-type-check, ts-migrate
|
|
233
|
+
|
|
234
|
+
# For Python developers
|
|
235
|
+
ccjk skills create-batch --lang python
|
|
236
|
+
# Creates: py-debug, py-refactor, py-test, py-lint, py-type
|
|
237
|
+
|
|
238
|
+
# For SEO optimization
|
|
239
|
+
ccjk skills create-batch --seo
|
|
240
|
+
# Creates: meta-optimize, sitemap-generate, schema-markup, core-web-vitals
|
|
241
|
+
|
|
242
|
+
# For DevOps
|
|
243
|
+
ccjk skills create-batch --devops
|
|
244
|
+
# Creates: docker-setup, ci-pipeline, deploy-script, monitoring
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
### 🌐 13+ API Providers Built-in
|
|
248
|
+
|
|
249
|
+
Connect to any AI provider with one click:
|
|
250
|
+
|
|
251
|
+
| Provider | Type | Free Tier |
|
|
252
|
+
|----------|------|:---------:|
|
|
253
|
+
| **Anthropic** | Official | - |
|
|
254
|
+
| **OpenRouter** | Multi-model | ✅ |
|
|
255
|
+
| **DeepSeek** | Cost-effective | ✅ |
|
|
256
|
+
| **Groq** | Fast inference | ✅ |
|
|
257
|
+
| **Gemini** | Google AI | ✅ |
|
|
258
|
+
| **Ollama** | Local/Private | ✅ |
|
|
259
|
+
| 302.AI, Qwen, SiliconFlow, Kimi, GLM... | Chinese Providers | Varies |
|
|
260
|
+
|
|
261
|
+
```bash
|
|
262
|
+
# Quick API setup
|
|
263
|
+
ccjk api setup deepseek sk-your-api-key
|
|
264
|
+
|
|
265
|
+
# Or use the interactive wizard
|
|
266
|
+
ccjk api wizard
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### 🔌 Plugin System
|
|
270
|
+
|
|
271
|
+
Extend CCJK with custom plugins:
|
|
272
|
+
|
|
273
|
+
```typescript
|
|
274
|
+
// ~/.ccjk/plugins/my-plugin/index.ts
|
|
275
|
+
export default {
|
|
276
|
+
name: 'my-awesome-plugin',
|
|
277
|
+
version: '1.0.0',
|
|
278
|
+
|
|
279
|
+
// Add custom agents
|
|
280
|
+
agents: [
|
|
281
|
+
{ name: 'my-agent', model: 'sonnet', template: '...' }
|
|
282
|
+
],
|
|
283
|
+
|
|
284
|
+
// Add custom skills
|
|
285
|
+
skills: [
|
|
286
|
+
{ id: 'my-skill', trigger: '/my-skill', template: '...' }
|
|
287
|
+
],
|
|
288
|
+
|
|
289
|
+
// Add custom workflows
|
|
290
|
+
workflows: [...]
|
|
291
|
+
}
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
---
|
|
295
|
+
|
|
296
|
+
## 📖 Complete Command Reference
|
|
297
|
+
|
|
298
|
+
### Essential Commands (Use These First!)
|
|
299
|
+
|
|
300
|
+
| Command | Description | When to Use |
|
|
301
|
+
|---------|-------------|-------------|
|
|
302
|
+
| `npx ccjk` | Interactive setup menu | First time setup |
|
|
303
|
+
| `ccjk setup` | Guided onboarding wizard | New to CCJK |
|
|
304
|
+
| `ccjk doctor` | Check your environment | Something not working? |
|
|
305
|
+
| `ccjk upgrade` | Update everything | Stay up to date |
|
|
306
|
+
|
|
307
|
+
### Configuration Commands
|
|
308
|
+
|
|
309
|
+
| Command | Description |
|
|
310
|
+
|---------|-------------|
|
|
311
|
+
| `ccjk init` | Full initialization with all options |
|
|
312
|
+
| `ccjk api wizard` | Configure API providers |
|
|
313
|
+
| `ccjk api list` | Show available providers |
|
|
314
|
+
| `ccjk api status` | Check current API config |
|
|
315
|
+
| `ccjk api test` | Test API connection |
|
|
316
|
+
|
|
317
|
+
### Tool Management
|
|
318
|
+
|
|
319
|
+
| Command | Description |
|
|
320
|
+
|---------|-------------|
|
|
321
|
+
| `ccjk tools list` | Show all AI coding tools |
|
|
322
|
+
| `ccjk tools install <tool>` | Install a specific tool |
|
|
323
|
+
| `ccjk tools status` | Check installation status |
|
|
324
|
+
|
|
325
|
+
### Skills & Automation
|
|
326
|
+
|
|
327
|
+
| Command | Description |
|
|
328
|
+
|---------|-------------|
|
|
329
|
+
| `ccjk skills list` | List all skills |
|
|
330
|
+
| `ccjk skills create-batch --lang <lang>` | Create language-specific skills |
|
|
331
|
+
| `ccjk skills enable <skill>` | Enable a skill |
|
|
332
|
+
| `ccjk skills disable <skill>` | Disable a skill |
|
|
333
|
+
|
|
334
|
+
### Interview-Driven Development
|
|
335
|
+
|
|
336
|
+
| Command | Description |
|
|
337
|
+
|---------|-------------|
|
|
338
|
+
| `ccjk interview` or `ccjk iv` | Start interactive interview |
|
|
339
|
+
| `ccjk quick` | Express mode (~10 questions) |
|
|
340
|
+
| `ccjk deep` | Deep dive (~40+ questions) |
|
|
341
|
+
| `ccjk interview --resume` | Resume paused session |
|
|
342
|
+
| `ccjk interview --list` | List saved sessions |
|
|
343
|
+
|
|
344
|
+
**In Claude Code:**
|
|
345
|
+
| Slash Command | Description |
|
|
346
|
+
|--------------|-------------|
|
|
347
|
+
| `/ccjk:interview` | Start interview in Claude Code |
|
|
348
|
+
| `/ccjk:interview --quick` | Quick interview mode |
|
|
349
|
+
| `/ccjk:interview --deep` | Deep interview mode |
|
|
350
|
+
|
|
351
|
+
### Advanced Commands
|
|
352
|
+
|
|
353
|
+
| Command | Description |
|
|
354
|
+
|---------|-------------|
|
|
355
|
+
| `ccjk config-scan` | Find all Claude Code configs |
|
|
356
|
+
| `ccjk permissions` | Manage Claude Code permissions |
|
|
357
|
+
| `ccjk versions` | Check all component versions |
|
|
358
|
+
| `ccjk uninstall` | Clean uninstallation |
|
|
359
|
+
|
|
360
|
+
---
|
|
361
|
+
|
|
362
|
+
## 🌍 Multi-Language Support
|
|
363
|
+
|
|
364
|
+
CCJK speaks your language:
|
|
365
|
+
|
|
366
|
+
```bash
|
|
367
|
+
# English (default)
|
|
368
|
+
ccjk init --lang en
|
|
369
|
+
|
|
370
|
+
# 简体中文 (Simplified Chinese)
|
|
371
|
+
ccjk init --lang zh-CN
|
|
372
|
+
|
|
373
|
+
# 日本語 (Japanese)
|
|
374
|
+
ccjk init --lang ja
|
|
375
|
+
|
|
376
|
+
# 한국어 (Korean)
|
|
377
|
+
ccjk init --lang ko
|
|
378
|
+
|
|
379
|
+
# Set ALL languages at once (UI + Config + AI Output)
|
|
380
|
+
ccjk init --all-lang zh-CN
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
---
|
|
384
|
+
|
|
385
|
+
## 📊 Why Choose CCJK?
|
|
386
|
+
|
|
387
|
+
| Feature | CCJK | Cursor | Copilot | Other Tools |
|
|
388
|
+
|---------|:----:|:------:|:-------:|:-----------:|
|
|
389
|
+
| AI Agents | **11+** | 2 | 1 | 0-2 |
|
|
390
|
+
| Skills Automation | ✅ | ❌ | ❌ | ❌ |
|
|
391
|
+
| Plugin System | ✅ | ❌ | ❌ | ❌ |
|
|
392
|
+
| LLM Code Audit | ✅ | ❌ | ❌ | ❌ |
|
|
393
|
+
| Multi-Provider | **13+** | 1 | 1 | 1-3 |
|
|
394
|
+
| Zero Config | ✅ | ❌ | ❌ | ❌ |
|
|
395
|
+
| Open Source | ✅ | ❌ | ❌ | Varies |
|
|
396
|
+
| Free | ✅ | ❌ | ❌ | Varies |
|
|
397
|
+
|
|
398
|
+
---
|
|
399
|
+
|
|
400
|
+
## 💻 Platform Support
|
|
401
|
+
|
|
402
|
+
| Platform | Status | Notes |
|
|
403
|
+
|----------|:------:|-------|
|
|
404
|
+
| **macOS** | ✅ Full Support | Intel & Apple Silicon |
|
|
405
|
+
| **Linux** | ✅ Full Support | All major distros |
|
|
406
|
+
| **Windows** | ✅ Full Support | Windows 10/11, WSL2 |
|
|
407
|
+
| **Termux** | ✅ Full Support | Android terminal |
|
|
408
|
+
|
|
409
|
+
---
|
|
410
|
+
|
|
411
|
+
## ❓ Frequently Asked Questions
|
|
412
|
+
|
|
413
|
+
<details>
|
|
414
|
+
<summary><b>Do I need an API key?</b></summary>
|
|
415
|
+
|
|
416
|
+
You need an API key from one of our 13+ supported providers. Some providers offer free tiers:
|
|
417
|
+
- **Groq** - Free tier available
|
|
418
|
+
- **Gemini** - Free tier available
|
|
419
|
+
- **DeepSeek** - Very affordable
|
|
420
|
+
- **Ollama** - Run locally, completely free
|
|
421
|
+
|
|
422
|
+
</details>
|
|
423
|
+
|
|
424
|
+
<details>
|
|
425
|
+
<summary><b>Is CCJK free?</b></summary>
|
|
426
|
+
|
|
427
|
+
Yes! CCJK is 100% free and open source (MIT license). You only pay for API usage to your chosen provider.
|
|
428
|
+
|
|
429
|
+
</details>
|
|
430
|
+
|
|
431
|
+
<details>
|
|
432
|
+
<summary><b>Does it work with Claude Code?</b></summary>
|
|
433
|
+
|
|
434
|
+
Yes! CCJK is designed specifically to enhance Claude Code. It also supports Codex, Aider, Continue, Cline, and Cursor.
|
|
435
|
+
|
|
436
|
+
</details>
|
|
437
|
+
|
|
438
|
+
<details>
|
|
439
|
+
<summary><b>Can I use it in my company?</b></summary>
|
|
440
|
+
|
|
441
|
+
Absolutely! The MIT license allows commercial use. Many teams use CCJK for:
|
|
442
|
+
- Standardizing AI coding practices
|
|
443
|
+
- Faster developer onboarding
|
|
444
|
+
- Automated code reviews
|
|
445
|
+
- Security compliance
|
|
446
|
+
|
|
447
|
+
</details>
|
|
448
|
+
|
|
449
|
+
<details>
|
|
450
|
+
<summary><b>Something isn't working. What do I do?</b></summary>
|
|
451
|
+
|
|
452
|
+
Run the health check:
|
|
453
|
+
```bash
|
|
454
|
+
ccjk doctor
|
|
455
|
+
```
|
|
456
|
+
This will diagnose common issues and suggest fixes.
|
|
457
|
+
|
|
458
|
+
</details>
|
|
459
|
+
|
|
460
|
+
---
|
|
461
|
+
|
|
462
|
+
## 💬 Community & Support
|
|
463
|
+
|
|
464
|
+
<div align="center">
|
|
465
|
+
|
|
466
|
+
[](https://github.com/miounet11/ccjk/discussions)
|
|
467
|
+
[](https://t.me/ccjk_community)
|
|
468
|
+
[](https://discord.gg/ccjk)
|
|
469
|
+
[](https://twitter.com/ccjk_dev)
|
|
470
|
+
|
|
471
|
+
</div>
|
|
472
|
+
|
|
473
|
+
- 🐛 **Bug Reports**: [GitHub Issues](https://github.com/miounet11/ccjk/issues)
|
|
474
|
+
- 💡 **Feature Requests**: [GitHub Discussions](https://github.com/miounet11/ccjk/discussions)
|
|
475
|
+
- 📖 **Documentation**: [docs.ccjk.dev](https://docs.ccjk.dev)
|
|
476
|
+
|
|
477
|
+
---
|
|
478
|
+
|
|
479
|
+
## 🤝 Contributing
|
|
480
|
+
|
|
481
|
+
We welcome contributions! Here's how to get started:
|
|
482
|
+
|
|
483
|
+
```bash
|
|
484
|
+
# Clone the repo
|
|
485
|
+
git clone https://github.com/miounet11/ccjk.git
|
|
486
|
+
cd ccjk
|
|
487
|
+
|
|
488
|
+
# Install dependencies
|
|
489
|
+
pnpm install
|
|
490
|
+
|
|
491
|
+
# Run in development mode
|
|
492
|
+
pnpm dev
|
|
493
|
+
|
|
494
|
+
# Run tests
|
|
495
|
+
pnpm test
|
|
496
|
+
|
|
497
|
+
# Build
|
|
498
|
+
pnpm build
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
See our [Contributing Guide](CONTRIBUTING.md) for more details.
|
|
502
|
+
|
|
503
|
+
---
|
|
504
|
+
|
|
505
|
+
## 🙏 Acknowledgments
|
|
506
|
+
|
|
507
|
+
CCJK is built on the shoulders of giants:
|
|
508
|
+
|
|
509
|
+
- [Claude Code](https://claude.ai/code) - The powerful AI coding foundation
|
|
510
|
+
- [ZCF](https://github.com/UfoMiao/zcf) - Original inspiration
|
|
511
|
+
- [Claude Code Router](https://github.com/musistudio/claude-code-router) - API routing
|
|
512
|
+
- [BMad Method](https://github.com/bmad-code-org/BMAD-METHOD) - Workflow patterns
|
|
513
|
+
|
|
514
|
+
---
|
|
515
|
+
|
|
516
|
+
## 📄 License
|
|
517
|
+
|
|
518
|
+
MIT © [CCJK Team](https://github.com/miounet11/ccjk)
|
|
519
|
+
|
|
520
|
+
---
|
|
521
|
+
|
|
522
|
+
<div align="center">
|
|
523
|
+
|
|
524
|
+
## ⭐ Star Us on GitHub
|
|
525
|
+
|
|
526
|
+
If CCJK helps you code better, please give us a star! It helps others discover the project.
|
|
527
|
+
|
|
528
|
+
[](https://star-history.com/#miounet11/ccjk&Date)
|
|
529
|
+
|
|
530
|
+
<br/>
|
|
531
|
+
|
|
532
|
+
**Made with ❤️ by developers, for developers**
|
|
533
|
+
|
|
534
|
+
<br/>
|
|
535
|
+
|
|
536
|
+
### 🔍 Search Keywords
|
|
537
|
+
|
|
538
|
+
`claude-code` `ai-coding-assistant` `code-review-ai` `ai-developer-tools` `claude-ai` `anthropic` `llm-coding` `ai-agents` `code-automation` `devops-ai` `security-audit` `performance-optimization` `typescript` `python` `javascript` `react` `vue` `nodejs` `docker` `kubernetes` `github-actions` `ci-cd` `code-quality` `best-practices` `clean-code` `copilot-alternative` `cursor-alternative` `free-ai-coding` `open-source-ai`
|
|
539
|
+
|
|
540
|
+
</div>
|
|
541
|
+
|
|
542
|
+
<!-- Badge Links -->
|
|
543
|
+
[npm-version-src]: https://img.shields.io/npm/v/ccjk?style=flat&colorA=18181B&colorB=28CF8D
|
|
544
|
+
[npm-version-href]: https://npmjs.com/package/ccjk
|
|
545
|
+
[npm-downloads-src]: https://img.shields.io/npm/dm/ccjk?style=flat&colorA=18181B&colorB=28CF8D
|
|
546
|
+
[npm-downloads-href]: https://npmjs.com/package/ccjk
|
|
547
|
+
[license-src]: https://img.shields.io/github/license/miounet11/ccjk?style=flat&colorA=18181B&colorB=28CF8D
|
|
548
|
+
[license-href]: https://github.com/miounet11/ccjk/blob/main/LICENSE
|
|
549
|
+
[stars-src]: https://img.shields.io/github/stars/miounet11/ccjk?style=flat&colorA=18181B&colorB=28CF8D
|
|
550
|
+
[stars-href]: https://github.com/miounet11/ccjk/stargazers
|