setup
This skill uses Claude hooks which can execute code automatically in response to events. Review carefully before installing.
OrchestKit Setup Wizard
Personalized onboarding that scans your codebase, detects your stack, recommends skills and MCPs, and generates an actionable improvement plan.
When to Use
- First time after installing OrchestKit (
/plugin install ork) - Joining a new project and want OrchestKit tuned for it
- Periodically with
--rescanto track improvement - Enterprise users who need safe, user-scoped install confirmation
Quick Start
/ork:setup # Full 8-phase wizard
/ork:setup --rescan # Re-scan after changes (skip safety phase)
/ork:setup --score-only # Just show readiness score
/ork:setup --plan-only # Just show improvement plan
/ork:setup --channel # Just show release channel
/ork:setup --configure # Jump directly to Phase 3.5: project configuration wizard
Argument Resolution
FLAG = "$ARGUMENTS[0]" # First token: --rescan, --score-only, --plan-only, --channel
# If no arguments, run full 8-phase wizard.
# $ARGUMENTS is the full string (CC 2.1.59 indexed access)
CRITICAL: Task Management is MANDATORY (CC 2.1.16)
BEFORE doing ANYTHING else, create tasks to track progress:
# 1. Create main task IMMEDIATELY
TaskCreate(
subject="Setup: onboarding wizard",
description="Personalized setup scanning codebase and configuring OrchestKit",
activeForm="Running setup wizard"
)
# 2. Create subtasks for key phase groups
TaskCreate(subject="Scan & detect stack", activeForm="Scanning codebase and detecting stack")
TaskCreate(subject="Safety & configure", activeForm="Checking config and running configuration wizard")
TaskCreate(subject="Recommend skills & MCPs", activeForm="Matching stack to skills and MCPs")
TaskCreate(subject="Score & plan", activeForm="Computing readiness score and improvement plan")
# 3. Set dependencies for sequential phases
TaskUpdate(taskId="3", addBlockedBy=["2"])
TaskUpdate(taskId="4", addBlockedBy=["3"])
TaskUpdate(taskId="5", addBlockedBy=["4"])
# 4. Before starting each task, verify it's unblocked
task = TaskGet(taskId="2") # Verify blockedBy is empty
# 5. Update status as you progress
TaskUpdate(taskId="2", status="in_progress") # When starting
TaskUpdate(taskId="2", status="completed") # When done
The Nine Phases
| Phase | What | Tools Used | Output |
|---|---|---|---|
| 1. Scan | Detect languages, frameworks, infra, existing config | Glob, Grep, Read | Raw scan data |
| 2. Stack | Classify detected stack, confidence levels | — | Stack profile |
| 3. Safety | Check existing config, confirm scope (user/project) | Read, AskUserQuestion | Install confirmation |
| 3.5. Configure | Interactive project configuration wizard → writes env block to per-project settings | Read, Write, AskUserQuestion | Configured settings file |
| 4. Skills | Match stack to skills, suggest custom skills | Grep, Glob | Skill recommendations |
| 5. MCPs | Recommend MCPs based on stack and gaps | Read, Bash | MCP recommendations |
| 6. Score | Compute readiness score (0-10, 6 dimensions) | All above data | Readiness score |
| 7. Plan | Prioritized improvements with runnable commands | — | Action plan |
| 8. Keys | Install recommended keyboard shortcuts | Read, Bash, AskUserQuestion | Keybindings |
Phase 1: Scan
Load details: Read("${CLAUDE_SKILL_DIR}/references/scan-phase.md") for full scan commands (20 parallel Glob probes + dependency file reads + pattern detection counts).
Scans for package manifests (package.json, pyproject.toml, go.mod, Cargo.toml, etc.), infrastructure (Docker, GitHub Actions, Terraform, K8s), and existing CC configuration. Pattern detection counts API routes, React components, models, and tests for custom skill suggestions.
Phase 2: Stack Detection
Classify scan results into a stack profile and present to user (languages, frameworks, database, infra, testing, existing CC config).
Load Read("${CLAUDE_SKILL_DIR}/references/stack-skill-mapping.md") for the full stack-to-skill mapping table, MCP recommendation matrix, and custom skill suggestion patterns.
Phase 2b: Channel Detection
Detect release channel from manifests/ork.json version string. Classification: X.Y.Z = stable, X.Y.Z-beta.* = beta, X.Y.Z-alpha.* = alpha. Display alongside stack profile. Use --channel flag to show only channel detection.
Phase 3: Safety Check
Load details: Read("${CLAUDE_SKILL_DIR}/references/safety-check.md") for the full AskUserQuestion prompt and conflict detection logic.
Offers three install scopes: User-only (recommended, invisible to teammates), Project-wide (committed to repo), or Already installed (skip to configure). Checks for existing OrchestKit installs and conflicting plugins.
Console auth (CC 2.1.79+): Users authenticating via Anthropic Console (API billing) can run
claude auth login --consoleinstead of the default OAuth flow. Useful for teams on usage-based API billing rather than Pro/Team subscriptions.
Team onboarding (CC 2.1.101+):
/team-onboardinggenerates a teammate ramp-up guide from your local CC usage patterns. Suggest running it after setup to create onboarding docs for new team members.
Enterprise TLS (CC 2.1.101+): OS CA certificate store is trusted by default — enterprise TLS proxies work without extra setup. Set
CLAUDE_CODE_CERT_STORE=bundledto use only bundled CAs if needed.
Prompt caching (CC 2.1.108+): For API-key, Bedrock, Vertex, or Foundry users, recommend setting
ENABLE_PROMPT_CACHING_1H=1to extend the prompt cache TTL from 5 minutes to 1 hour. This significantly reduces token costs for long OrchestKit sessions (brainstorm, implement, cover chains). Session recap is enabled by default since CC 2.1.110 (even with telemetry disabled).
TUI mode (CC 2.1.110+): Recommend
/tui fullscreenfor flicker-free rendering during long sessions. Pair withautoScrollEnabled: falsein/configfor manual scroll control during brainstorm/implement output review. The/focuscommand provides a condensed view (prompt + one-line tool summaries + final response).
--dangerously-skip-permissionspolicy (CC 2.1.121 + 2.1.126, #1583): the flag's scope expanded substantially. As of 2.1.126 it bypasses prompts for writes to.claude/,.git/,.vscode/, shell config files (~/.bashrc,~/.zshrc, etc.), and "other previously-protected paths" — on top of.claude/skills/,.claude/agents/,.claude/commands/already bypassed since 2.1.121. Only catastrophic removal commands (e.g.,rm -rf /) still prompt. Recommend against this flag for shared workstations, CI runners, and onboarding sessions. Suggest the auto-approve permission hooks insrc/hooks/README.mdinstead — they offer fine-grained allow-listing without disabling the safety net wholesale. The setup wizard should warn (not block) if the user enables this flag during configure.
Phase 3.5: Project Configuration Wizard
Load details: Read("${CLAUDE_SKILL_DIR}/references/configure-wizard.md") for the full 6-step interactive configuration flow (branch strategy, commit scope, localhost browser, perf telemetry, log verbosity, webhook telemetry) and env var reference.
Also reachable directly via
/ork:setup --configure— skips phases 1-3.
Phase 4: Skill Recommendations
Present skill categories using AskUserQuestion with 4 focus options (Full-stack, Backend, Frontend, DevOps) with multiSelect: true. Load Read("${CLAUDE_SKILL_DIR}/references/stack-skill-mapping.md") for mapping tables and custom skill suggestions.
Phase 5: MCP Recommendations
Check installed vs recommended MCPs by reading .mcp.json and ~/.claude/settings.json. Load Read("${CLAUDE_SKILL_DIR}/references/stack-skill-mapping.md") for the MCP recommendation matrix. Present as toggles with install commands.
CC 2.1.121+ tip (#1541): for the universally-needed T2 trio (memory, context7, sequential-thinking), recommend setting "alwaysLoad": true in their .mcp.json entries. This skips per-skill ToolSearch probes and shaves ~150ms off cold starts. The key is silently ignored on older CC, so it's safe to add eagerly.
Plugin lifecycle cleanup (CC 2.1.121+, #1544): mention claude plugin uninstall <name> --prune in the cleanup section — it cascades and removes auto-installed deps that became orphaned. Standalone claude plugin prune runs the same cleanup without uninstalling anything; /ork:dream runs it weekly.
Phase 6: Readiness Score
Compute a composite score (0-10) from 6 dimensions. Load Read("${CLAUDE_SKILL_DIR}/references/readiness-scoring.md") for dimension weights, score presentation template, memory integration, and improvement plan template.
Phase 7: Improvement Plan
Generate prioritized, runnable recommendations in P0/P1/P2 tiers. See readiness-scoring.md for the template and memory persistence pattern.
Phase 7b: CLAUDE.md Health Check
After the improvement plan, check if the user's CLAUDE.md could benefit from CC 2.1.59+ modular structure.
Load details: Read("${CLAUDE_SKILL_DIR}/references/claude-md-health.md") for analysis steps, thresholds, @import syntax, and .claude/rules/ path-scoped rules.
# Quick check
Bash(command="wc -l CLAUDE.md 2>/dev/null | awk '{print $1}'")
Glob(pattern=".claude/rules/*.md")
If CLAUDE.md > 200 lines and no .claude/rules/ exist, recommend splitting. Show the output template from the reference doc.
Phase 8: Keybindings
Load details: Read("${CLAUDE_SKILL_DIR}/references/keybindings.md") for the full keybinding prompt, default shortcuts, and merge logic.
Offers 5 recommended shortcuts (commit, verify, implement, explore, review-pr). Merges with existing ~/.claude/keybindings.json without overwriting user-defined bindings.
Post-Setup
Tip (CC 2.1.69+): After setup completes, run
/reload-pluginsto activate all plugin changes without restarting your session.Tip (CC 2.1.90+): New to Claude Code? Try
/powerupfor interactive lessons with animated demos teaching core features.
Phase 9: Telemetry & Webhooks
Previously in
/ork:configure. Now part of setup for single entry point.
Load details: Read("${CLAUDE_SKILL_DIR}/references/telemetry-setup.md") for the full configuration flow.
Ask user preference with AskUserQuestion:
| Mode | Events | Auth | Overhead |
|---|---|---|---|
| Full streaming | All 18 CC events via HTTP hooks | Bearer token | Near-zero |
| Summary only | SessionEnd + worktree events | HMAC auth | None |
| Skip | No telemetry | — | None |
If streaming selected:
- Ask for webhook URL
- Run
npm run generate:http-hooks -- <url> --write - Save to
.claude/orchestration/config.json - Remind about
ORCHESTKIT_HOOK_TOKENenv var
Phase 10: Optional Integrations
Load details: Read("${CLAUDE_SKILL_DIR}/references/integrations.md") for setup steps.
Covers Agentation UI annotation tool, CC version-specific settings (CC 2.1.7 MCP deferral, CC 2.1.20 task deletion, CC 2.1.23 spinner verbs, CC 2.1.79 turn duration display), and monorepo worktree optimization.
Monorepo Sparse Paths (CC 2.1.76+)
If Phase 1 scan detected a monorepo (pnpm-workspace.yaml, nx.json, lerna.json, turbo.json, or package.json workspaces), suggest configuring worktree.sparsePaths in .claude/settings.json:
{
"worktree": {
"sparsePaths": ["src/", "packages/core/", "tests/", "scripts/"]
}
}
This makes --worktree and agent isolation: worktree check out only the listed directories via git sparse-checkout — significantly faster in large monorepos.
Multi-Directory Plugin Seeding (CC 2.1.79+)
CLAUDE_CODE_PLUGIN_SEED_DIR now supports multiple directories separated by the platform path delimiter (: on Unix, ; on Windows):
export CLAUDE_CODE_PLUGIN_SEED_DIR="/shared/team/plugins:/shared/org/plugins"
This is useful for teams with multiple plugin sources — e.g., a shared org-wide plugin directory alongside a team-specific one. Claude Code scans all listed directories for plugin definitions at startup.
CLI Flags
| Flag | Behavior |
|---|---|
| (none) | Full wizard (phases 1-10) |
--rescan |
Re-run scan + score, skip safety phase |
--configure |
Jump directly to Phase 3.5: project configuration wizard |
--score-only |
Show current readiness score (Phase 6 only) |
--plan-only |
Show improvement plan (Phase 7 only) |
--channel |
Show detected release channel only |
--telemetry |
Jump to Phase 9: telemetry/webhook setup |
--preset |
Apply a preset (complete/standard/lite/hooks-only/monorepo) |
Presets (via --preset)
Apply a preset to quickly configure OrchestKit without the full wizard:
| Preset | Skills | Agents | Hooks | Best For |
|---|---|---|---|---|
| complete | 91 | 31 | 96 | Full power — everything enabled |
| standard | 91 | 0 | 96 | Skills + hooks, no agents |
| lite | 10 | 0 | 96 | Essential workflow skills only |
| hooks-only | 0 | 0 | 96 | Just safety hooks |
| monorepo | 91 | 31 | 96 | Complete + monorepo workspace detection |
Load preset details: Read("${CLAUDE_SKILL_DIR}/references/presets.md")
References
Load on demand with Read("${CLAUDE_SKILL_DIR}/references/<file>"):
| File | Content |
|---|---|
scan-phase.md |
Phase 1: 20 parallel Glob probes + pattern detection |
safety-check.md |
Phase 3: Install scope and conflict detection |
configure-wizard.md |
Phase 3.5: 6-step interactive project config |
claude-md-health.md |
Phase 7b: CLAUDE.md modular structure analysis |
keybindings.md |
Phase 8: Keyboard shortcut recommendations |
telemetry-setup.md |
Phase 9: Webhook/telemetry configuration |
integrations.md |
Phase 10: Agentation + CC version settings |
presets.md |
Preset definitions and skill/agent matrices |
Related Skills
ork:doctor— Health diagnostics (wizard uses its checks)ork:configure— Internal configuration (called by wizard phases 3.5, 9, 10)ork:remember— Knowledge persistence (wizard seeds initial patterns)ork:explore— Deep codebase analysis (wizard links for follow-up)ork:help— Skill directory (wizard surfaces relevant subset)
More from yonatangross/orchestkit
responsive-patterns
Responsive design with Container Queries, fluid typography, cqi/cqb units, subgrid, intrinsic layouts, foldable devices, and mobile-first patterns for React applications. Use when building responsive layouts or container queries.
464ui-components
UI component library patterns for shadcn/ui and Radix Primitives. Use when building accessible component libraries, customizing shadcn components, using Radix unstyled primitives, or creating design system foundations.
443devops-deployment
Use when setting up CI/CD pipelines, containerizing applications, deploying to Kubernetes, or writing infrastructure as code. DevOps & Deployment covers GitHub Actions, Docker, Helm, and Terraform patterns.
401rag-retrieval
Retrieval-Augmented Generation patterns for grounded LLM responses. Use when building RAG pipelines, embedding documents, implementing hybrid search, contextual retrieval, HyDE, agentic RAG, multimodal RAG, query decomposition, reranking, or pgvector search.
340architecture-decision-record
Use this skill when documenting significant architectural decisions. Provides ADR templates following the Nygard format with sections for context, decision, consequences, and alternatives. Use when writing ADRs, recording decisions, or evaluating options.
326domain-driven-design
DDD tactical patterns for complex business modeling including entities, value objects, aggregates, domain services, repositories, specifications, and bounded contexts. Python dataclass implementations with TypeScript alternatives. Use when building rich domain models, enforcing invariants, or separating domain logic from infrastructure.
326