configure
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseOrchestKit Configuration
OrchestKit 配置
Interactive setup for customizing your OrchestKit installation.
用于自定义OrchestKit安装的交互式设置。
Quick Start
快速开始
bash
/ork:configurebash
/ork:configureStep 1: Choose Preset
步骤1:选择预设方案
Use AskUserQuestion:
| Preset | Skills | Agents | Hooks | Description |
|---|---|---|---|---|
| Complete | 78 | 20 | 92 | Everything |
| Standard | 78 | 0 | 92 | Skills, no agents |
| Lite | 10 | 0 | 92 | Essential only |
| Hooks-only | 0 | 0 | 92 | Just safety |
| Monorepo | 78 | 20 | 92 | Complete + monorepo detection |
使用AskUserQuestion:
| 预设方案 | 技能数量 | Agent数量 | Hooks数量 | 描述 |
|---|---|---|---|---|
| 完整版 | 78 | 20 | 92 | 包含全部功能 |
| 标准版 | 78 | 0 | 92 | 包含技能,无Agent |
| 轻量版 | 10 | 0 | 92 | 仅包含核心功能 |
| 仅Hooks | 0 | 0 | 92 | 仅包含安全相关Hooks |
| 单体仓库版 | 78 | 20 | 92 | 完整版 + 单体仓库检测 |
Step 2: Customize Skill Categories
步骤2:自定义技能分类
Categories available:
- AI/ML (26 skills)
- Backend (15 skills)
- Frontend (8 skills)
- Testing (13 skills)
- Security (7 skills)
- DevOps (4 skills)
- Planning (6 skills)
可用分类:
- AI/ML(26个技能)
- 后端(15个技能)
- 前端(8个技能)
- 测试(13个技能)
- 安全(7个技能)
- DevOps(4个技能)
- 规划(6个技能)
Step 3: Customize Agents
步骤3:自定义Agent
Product Agents (6):
- market-intelligence
- product-strategist
- requirements-translator
- ux-researcher
- prioritization-analyst
- business-case-builder
Technical Agents (14):
- backend-system-architect
- frontend-ui-developer
- database-engineer
- llm-integrator
- workflow-architect
- data-pipeline-engineer
- test-generator
- code-quality-reviewer
- security-auditor
- security-layer-auditor
- debug-investigator
- metrics-architect
- rapid-ui-designer
- system-design-reviewer
产品类Agent(6个):
- market-intelligence
- product-strategist
- requirements-translator
- ux-researcher
- prioritization-analyst
- business-case-builder
技术类Agent(14个):
- backend-system-architect
- frontend-ui-developer
- database-engineer
- llm-integrator
- workflow-architect
- data-pipeline-engineer
- test-generator
- code-quality-reviewer
- security-auditor
- security-layer-auditor
- debug-investigator
- metrics-architect
- rapid-ui-designer
- system-design-reviewer
Step 4: Configure Hooks
步骤4:配置Hooks
Safety Hooks (Always On):
- git-branch-protection
- file-guard
- redact-secrets
Toggleable Hooks:
- Productivity (auto-approve, logging)
- Quality Gates (coverage, patterns)
- Team Coordination (locks, conflicts)
- Notifications (desktop, sound)
CC 2.1.49 Managed Settings: OrchestKit ships pluginwith default hook permissions. These are managed defaults — users can override them in project or user settings. Enterprise admins can lock managed settings via managed profiles.settings.json
安全Hooks(始终启用):
- git-branch-protection
- file-guard
- redact-secrets
可切换Hooks:
- 生产力(自动批准、日志记录)
- 质量门禁(覆盖率、模式检查)
- 团队协作(锁定、冲突处理)
- 通知(桌面通知、声音提示)
CC 2.1.49 托管设置: OrchestKit 附带默认Hook权限的插件文件。这些是托管默认值——用户可在项目或用户设置中覆盖它们。企业管理员可通过托管配置文件锁定托管设置。settings.json
Step 5: Configure MCPs (Optional)
步骤5:配置MCP(可选)
All 5 MCPs ship enabled by default. Tavily requires an API key; agentation requires a local package install.
| MCP | Purpose | Default | Requires |
|---|---|---|---|
| context7 | Library documentation | enabled | Nothing |
| memory | Cross-session persistence | enabled | Nothing |
| sequential-thinking | Structured reasoning for subagents | enabled | Nothing |
| tavily | Web search + extraction | enabled | API key (free tier: app.tavily.com) |
| agentation | UI annotation tool | enabled | |
Why all enabled? OrchestKit ships 30+ Sonnet/Haiku subagents. While Opus 4.6 has native extended thinking, Sonnet and Haiku do not — they benefit from sequential-thinking. Tavily and agentation are used by specific agents (seein agent frontmatter). CC's MCPSearch auto-defers schemas when overhead exceeds 10% of context, so token cost is managed automatically.mcpServers
Background agents: MCP tools are NOT available in background subagents (hard CC platform limitation). Agents that need MCP tools must run in the foreground.
Already have these MCPs installed globally? If Tavily or memory are already in your , skip enabling them here to avoid duplicate entries. OrchestKit agents will use whichever instance Claude Code resolves first.
~/.claude/mcp.json所有5个MCP默认启用。Tavily需要API密钥;agentation需要安装本地包。
| MCP | 用途 | 默认状态 | 依赖要求 |
|---|---|---|---|
| context7 | 库文档查询 | 已启用 | 无 |
| memory | 跨会话持久化 | 已启用 | 无 |
| sequential-thinking | 子Agent结构化推理 | 已启用 | 无 |
| tavily | 网页搜索+内容提取 | 已启用 | API密钥(免费 tier:app.tavily.com) |
| agentation | UI标注工具 | 已启用 | |
为何全部启用? OrchestKit 附带30多个Sonnet/Haiku子Agent。虽然Opus 4.6原生支持扩展思维,但Sonnet和Haiku不支持——它们可从sequential-thinking中获益。Tavily和agentation由特定Agent使用(详见Agent前置元数据中的)。CC的MCPSearch会在开销超过上下文的10%时自动延迟模式,因此令牌成本会被自动管理。mcpServers
后台Agent限制: MCP工具无法在后台子Agent中使用(CC平台的硬性限制)。需要MCP工具的Agent必须在前台运行。
已全局安装这些MCP? 如果Tavily或memory已在你的中,可跳过在此处启用它们,避免重复条目。OrchestKit Agent会使用Claude Code优先解析的实例。
~/.claude/mcp.jsonStep 6: CC 2.1.7 Settings (New)
步骤6:CC 2.1.7 设置(新增)
Configure CC 2.1.7-specific features:
配置CC 2.1.7专属功能:
Turn Duration Display
轮次时长显示
Enable turn duration in statusline? [y/N]: yAdds to settings.json:
json
{
"statusline": {
"showTurnDuration": true
}
}是否在状态栏显示轮次时长? [y/N]: y会添加到settings.json:
json
{
"statusline": {
"showTurnDuration": true
}
}MCP Auto-Deferral Threshold
MCP自动延迟阈值
MCP deferral threshold (default 10%): 10Adds to config.json:
json
{
"cc217": {
"mcp_defer_threshold": 0.10,
"use_effective_window": true
}
}MCP延迟阈值(默认10%):10会添加到config.json:
json
{
"cc217": {
"mcp_defer_threshold": 0.10,
"use_effective_window": true
}
}Effective Context Window Mode
有效上下文窗口模式
Use effective context window for calculations? [Y/n]: yWhen enabled:
- Statusline shows
context_window.effective_percentage - Compression triggers use effective window
- MCP deferral more accurate
是否使用有效上下文窗口进行计算? [Y/n]: y启用后:
- 状态栏显示
context_window.effective_percentage - 压缩触发使用有效窗口
- MCP延迟更准确
Step 7: CC 2.1.20 Settings
步骤7:CC 2.1.20 设置
Configure CC 2.1.20-specific features:
配置CC 2.1.20专属功能:
Task Deletion Support
任务删除支持
Enable task deletion (status: "deleted")? [Y/n]: yEnables orphan detection and automatic cleanup of blocked tasks.
启用任务删除(状态:"deleted")? [Y/n]: y启用孤立任务检测和阻塞任务的自动清理。
PR Status Enrichment
PR状态增强
Enable PR status enrichment at session start? [Y/n]: yDetects open PRs on current branch and sets / env vars.
ORCHESTKIT_PR_URLORCHESTKIT_PR_STATE在会话启动时启用PR状态增强? [Y/n]: y检测当前分支的开放PR,并设置 / 环境变量。
ORCHESTKIT_PR_URLORCHESTKIT_PR_STATEBackground Agent Permission Pre-Mapping
后台Agent权限预映射
Enable permission profile suggestions for agents? [Y/n]: yShows recommended permission profiles when spawning agents.
启用Agent权限配置文件建议? [Y/n]: y在生成Agent时显示推荐的权限配置文件。
Monorepo Multi-Directory Detection
单体仓库多目录检测
Enable monorepo detection? [Y/n]: yDetects monorepo indicators and suggests usage.
--add-dirCC 2.1.47: Whenare already active, the monorepo detector automatically skips theadded_dirssuggestion. The--add-dirfield is now available in hook inputs for multi-directory awareness.added_dirs
启用单体仓库检测? [Y/n]: y检测单体仓库标识并建议使用。
--add-dirCC 2.1.47:当已激活时,单体仓库检测器会自动跳过added_dirs建议。--add-dir字段现已在Hook输入中可用,以支持多目录感知。added_dirs
Team Plugin Distribution (CC 2.1.45+)
团队插件分发(CC 2.1.45+)
Share OrchestKit across a team using a shared directory:
bash
undefined使用共享目录在团队中共享OrchestKit:
bash
undefinedCreate shared plugin directory
创建共享插件目录
mkdir -p /shared/team/plugins/orchestkit
mkdir -p /shared/team/plugins/orchestkit
Copy plugin files
复制插件文件
cp -r plugins/ork/* /shared/team/plugins/orchestkit/
cp -r plugins/ork/* /shared/team/plugins/orchestkit/
Team members use --add-dir to pick up the shared plugin
团队成员使用--add-dir加载共享插件
claude --add-dir /shared/team/plugins
CC 2.1.45+ supports `plugin_hot_reload` — team members get updates without restarting their sessions.
> **`enabledPlugins` vs `added_dirs`**: `enabledPlugins` is a CC-internal concept and is NOT exposed to hooks. The hook-accessible field for multi-directory awareness is `added_dirs` (available in `HookInput` since CC 2.1.47). Hooks can read `input.added_dirs` to detect which additional directories are active — useful for adapting behavior in multi-repo workspaces.claude --add-dir /shared/team/plugins
CC 2.1.45+支持`plugin_hot_reload`——团队成员无需重启会话即可获取更新。
> **`enabledPlugins` vs `added_dirs`**:`enabledPlugins`是CC内部概念,**不会**暴露给Hooks。Hook可访问的多目录感知字段是`added_dirs`(自CC 2.1.47起在`HookInput`中可用)。Hooks可读取`input.added_dirs`来检测哪些额外目录处于激活状态——这在多仓库工作区中调整行为很有用。Monorepo Package Context (CC 2.1.49)
单体仓库包上下文(CC 2.1.49)
When are active, OrchestKit's monorepo detector surfaces package names from each directory as session context. This helps agents understand which packages are in scope:
added_dirsMulti-directory context active (3 dirs)
Packages: @myapp/api, @myapp/web, @myapp/shared
Each directory may have its own CLAUDE.md with targeted instructions.Use to include specific packages.
claude --add-dir ./packages/api --add-dir ./packages/web当激活时,OrchestKit的单体仓库检测器会将每个目录的包名称作为会话上下文展示。这有助于Agent了解哪些包在范围内:
added_dirs多目录上下文已激活(3个目录)
包:@myapp/api, @myapp/web, @myapp/shared
每个目录可能有自己的CLAUDE.md文件,包含针对性指令。使用来包含特定包。
claude --add-dir ./packages/api --add-dir ./packages/webStep 8: CC 2.1.23 Settings
步骤8:CC 2.1.23 设置
Configure CC 2.1.23-specific features:
配置CC 2.1.23专属功能:
Spinner Verbs Customization
加载动画动词自定义
Replace default Claude Code spinner verbs ("Thinking", "Working", etc.) with custom branding:
Customize spinner verbs? [Y/n]: yAdds to :
.claude/settings.jsonjson
{
"spinnerVerbs": {
"mode": "replace",
"verbs": [
"Orchestrating",
"Coordinating",
"Synthesizing",
"Analyzing",
"Reasoning",
"Crafting",
"Architecting",
"Validating",
"Dispatching",
"Assembling",
"Engineering",
"Composing"
]
}
}Options:
- - Use only your custom verbs
mode: "replace" - - Add your verbs to the defaults
mode: "append"
OrchestKit-themed verbs focus on orchestration, architecture, and engineering actions.
替换默认Claude Code加载动画动词("Thinking"、"Working"等)为自定义品牌动词:
自定义加载动画动词? [Y/n]: y会添加到:
.claude/settings.jsonjson
{
"spinnerVerbs": {
"mode": "replace",
"verbs": [
"Orchestrating",
"Coordinating",
"Synthesizing",
"Analyzing",
"Reasoning",
"Crafting",
"Architecting",
"Validating",
"Dispatching",
"Assembling",
"Engineering",
"Composing"
]
}
}选项:
- - 仅使用自定义动词
mode: "replace" - - 将自定义动词添加到默认列表中
mode: "append"
OrchestKit主题动词专注于编排、架构和工程相关动作。
Step 9: Optional Integrations
步骤9:可选集成
Use AskUserQuestion to offer optional third-party integrations:
使用AskUserQuestion提供可选第三方集成:
Agentation (UI Annotation Tool)
Agentation(UI标注工具)
Enable Agentation UI annotation tool? [y/N]: yAgentation lets you annotate your app's UI in the browser and have Claude pick up the feedback automatically.
When enabled, perform these steps (idempotent — skip any step already done):
-
Install dependencies (checkfirst):
package.jsonbashnpm install -D agentation agentation-mcp -
Add MCP server to(skip if
.mcp.jsonkey already exists):agentationjson{ "mcpServers": { "agentation": { "command": "npx", "args": ["-y", "agentation-mcp", "server"], "disabled": false } } } -
Enable MCP server in Claude Code settings — addto the
"agentation"array inenabledMcpjsonServers(create file if missing, skip if already listed):.claude/settings.local.jsonjson{ "enabledMcpjsonServers": ["agentation"] } -
Scaffold wrapper component — create a dev-only client component (skip if file already exists). Use the project's component directory (e.g.,
src/components/, orcomponents/):app/components/tsx// agentation-wrapper.tsx "use client"; import { Agentation } from "agentation"; export function AgentationWrapper() { if (process.env.NODE_ENV !== "development") return null; return <Agentation endpoint="http://localhost:4747" webhookUrl="http://localhost:4747" />; }Then instruct the user to addto their root layout.<AgentationWrapper /> -
CSP update (only if the project has a Content-Security-Policy): addto the
http://localhost:4747directive for development mode only.connect-src
启用Agentation UI标注工具? [y/N]: yAgentation允许你在浏览器中标注应用UI,Claude会自动获取反馈。
启用后,请执行以下步骤(幂等——跳过已完成的步骤):
-
安装依赖(先检查):
package.jsonbashnpm install -D agentation agentation-mcp -
将MCP服务器添加到(如果
.mcp.json键已存在则跳过):agentationjson{ "mcpServers": { "agentation": { "command": "npx", "args": ["-y", "agentation-mcp", "server"], "disabled": false } } } -
在Claude Code设置中启用MCP服务器——在的
.claude/settings.local.json数组中添加enabledMcpjsonServers(如果文件不存在则创建,已存在则跳过):"agentation"json{ "enabledMcpjsonServers": ["agentation"] } -
生成包装器组件——创建一个仅开发环境的客户端组件(如果文件已存在则跳过)。使用项目的组件目录(如、
src/components/或components/):app/components/tsx// agentation-wrapper.tsx "use client"; import { Agentation } from "agentation"; export function AgentationWrapper() { if (process.env.NODE_ENV !== "development") return null; return <Agentation endpoint="http://localhost:4747" webhookUrl="http://localhost:4747" />; }然后指导用户将添加到根布局中。<AgentationWrapper /> -
CSP更新(仅当项目有内容安全策略时):在开发模式下,将添加到
http://localhost:4747指令中。connect-src
Step 10: Preview & Save
步骤10:预览并保存
Save to:
~/.claude/plugins/orchestkit/config.jsonjson
{
"version": "1.0.0",
"preset": "complete",
"skills": { "ai_ml": true, "backend": true, ... },
"agents": { "product": true, "technical": true },
"hooks": { "safety": true, "productivity": true, ... },
"mcps": { "context7": false, ... }
}保存到:
~/.claude/plugins/orchestkit/config.jsonjson
{
"version": "1.0.0",
"preset": "complete",
"skills": { "ai_ml": true, "backend": true, ... },
"agents": { "product": true, "technical": true },
"hooks": { "safety": true, "productivity": true, ... },
"mcps": { "context7": false, ... }
}Related Skills
相关技能
- : Diagnose configuration issues
ork:doctor
- : 诊断配置问题
ork:doctor
References
参考资料
- Presets
- MCP Configuration
- 预设方案
- MCP配置",