Personalized 7-phase onboarding wizard that scans the codebase, detects tech stack, recommends skills and MCP servers, and generates an improvement plan with readiness score. Includes safety checks and project-scoped configuration. Use when setting up OrchestKit for a new project or rescanning after major changes.
Instrucciones de origen · Vista previa de solo lectura
name
setup
license
MIT
compatibility
Claude Code 2.1.220+.
description
Personalized 7-phase onboarding wizard that scans the codebase, detects tech stack, recommends skills and MCP servers, and generates an improvement plan with readiness score. Includes safety checks and project-scoped configuration. Use when setting up OrchestKit for a new project or rescanning after major changes.
{"keywords":["setup","onboarding","configure","just installed","get orchestkit working","set up orchestkit","set up ork","readiness score","wizard"],"examples":["set up orchestkit for this project","run the onboarding wizard","i just installed orchestkit, what do i do first"],"anti-triggers":["doctor","help","explore","implement","fix"]}
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 --rescan to track improvement
Enterprise users who need safe, user-scoped install confirmation
Quick Start
/ork:setup # Full 7-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 --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 7-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")
TaskUpdate(taskId=, addBlockedBy=[])
TaskUpdate(taskId=, addBlockedBy=[])
TaskUpdate(taskId=, addBlockedBy=[])
TaskUpdate(taskId=, status=)
TaskUpdate(taskId=, status=)
Load details: Read("${CLAUDE_PLUGIN_ROOT}/skills/setup/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_PLUGIN_ROOT}/skills/setup/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
Phase 3: Safety Check
Load details: Read("${CLAUDE_PLUGIN_ROOT}/skills/setup/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 --console instead 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-onboarding generates 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=bundled to 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=1 to 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 fullscreen for flicker-free rendering during long sessions. Pair with autoScrollEnabled: false in /config for manual scroll control during brainstorm/implement output review. The /focus command provides a condensed view (prompt + one-line tool summaries + final response).
Plugin install (CC 2.1.157+): Plugins in .claude/skills auto-load without a marketplace — for local/dev installs, placing a plugin there is enough. claude plugin init <name> scaffolds a new plugin skeleton in .claude/skills.
--dangerously-skip-permissions policy (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 in src/hooks/README.md instead — 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_PLUGIN_ROOT}/skills/setup/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_PLUGIN_ROOT}/skills/setup/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_PLUGIN_ROOT}/skills/setup/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_PLUGIN_ROOT}/skills/setup/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_PLUGIN_ROOT}/skills/setup/references/claude-md-health.md") for analysis steps, thresholds, @import syntax, and .claude/rules/ path-scoped rules.
If CLAUDE.md > 200 lines and no .claude/rules/ exist, recommend splitting. Show the output template from the reference doc.
Post-Setup
Tip (CC 2.1.69+): After setup completes, run /reload-plugins to activate all plugin changes without restarting your session.
Tip (CC 2.1.90+): New to Claude Code? Try /powerup for 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_PLUGIN_ROOT}/skills/setup/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_TOKEN env var
Phase 10: Optional Integrations
Load details: Read("${CLAUDE_PLUGIN_ROOT}/skills/setup/references/integrations.md") for setup steps.
Covers 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:
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):
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.
One-Off Plugin Loading from .zip (CC 2.1.128 / 2.1.129)
For evaluating a plugin without committing to a marketplace install — useful for trialing a coworker's branch build, a CI-produced PR artifact, or an OrchestKit pre-release .zip before it's published:
--plugin-dir <path-to-zip> (CC 2.1.128+): load a local .zip archive as a plugin for the session. Same flag that previously only accepted directories, now also accepts archives.
claude --plugin-dir ./vendor/some-plugin.zip
--plugin-url <url> (CC 2.1.129+): fetch a .zip from a URL and load it for the current session only. The plugin is discarded when CC exits — nothing is written to ~/.claude/plugins/.
claude --plugin-url https://example.com/some-plugin.zip
Both are session-scoped trial paths; for permanent install, use the standard /plugin install flow against a marketplace. See ${CLAUDE_PLUGIN_ROOT}/skills/configure/references/cc-version-settings.md § CC 2.1.128/2.1.129 for the full notes.
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)
--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:
--channels (per-org notification channel routing) now works under console (API key) authentication, not just OAuth — but the org must have channelsEnabled: true set via the admin API. If the user runs claude --channels=... with API-key auth and the org config lacks the flag, the channel selection is silently ignored. Setup wizard surfaces this when API-key auth is detected and any channel-routing skill or agent is selected for install.
Related Skills
ork:doctor — Health diagnostics (wizard uses its checks)
