Skip to content
Development
Command

/onboard

Guide existing codebase onboarding through mapping, doc ingest, and planning setup

From plugin
gsd-core
8k71 skills34 agents71 commands7 hooks
Install
> /plugin marketplace add open-gsd/gsd-core
> /plugin install gsd-core@gsd-core

How it fires

How this command gets triggered: by you, by Claude, or both.

  • Fires itselfClaude auto-loads it when your prompt matches the work.
  • You can call itInvoke it directly when you want it.
  • Slash command/onboard

Context preview

What this command does when you run it.

Guide existing codebase onboarding through mapping, doc ingest, and planning setup

Command definition

onboard.md
name: gsd:onboard
description: Guide existing codebase onboarding through mapping, doc ingest, and planning setup
argument-hint: "[--fast] [--text]"
allowed-tools:
  - Read
  - Bash
  - Write
  - Glob
  - Grep
  - Agent
  - AskUserQuestion
requires: [config, new-project, map-codebase, ingest-docs, manager]

<runtime_note> **Copilot (VS Code):** Use `vscode_askquestions` wherever this workflow calls `AskUserQuestion`. They are equivalent — `vscode_askquestions` is the VS Code Copilot implementation of the same interactive question API. </runtime_note>

<objective> Guide brownfield onboarding for an existing codebase by routing through the existing GSD primitives in the safe order: codebase map → docs ingest → project initialization → onboarding summary.

**Creates or confirms:**

  • `.planning/codebase/` — evidence-backed codebase map from `/gsd:map-codebase`
  • `.planning/PROJECT.md`, `REQUIREMENTS.md`, `ROADMAP.md`, `STATE.md` — project setup from `/gsd:new-project` or `/gsd:ingest-docs`
  • `.planning/onboarding/SUMMARY.md` — lightweight index of what was learned and the next command

**Non-goals:** This command does not execute phases, ship work, or overwrite existing planning artifacts without an explicit gate. </objective>

<execution_context> @~/.claude/gsd-core/workflows/onboard.md @~/.claude/gsd-core/references/ui-brand.md @~/.claude/gsd-core/references/gate-prompts.md </execution_context>

<context> Arguments: $ARGUMENTS

Flags:

  • `--fast` — prefer `/gsd:map-codebase --fast` for the mapping handoff; the complete map is still required before `/gsd:new-project`.
  • `--text` — use plain-text numbered lists instead of TUI menus.

</context>

<process> Execute the onboard workflow end-to-end. Preserve all safety gates, text-mode fallbacks, idempotency checks, and top-level handoff rules for nested interactive commands. </process>

Read more
Ships withgsd-core

Git. Ship. Done. A light-weight meta-prompting, context engineering, and spec-driven development system for Claude Code, OpenCode, Antigravity CLI, Kimi CLI, Kilo, Codex, Copilot, Cursor, Windsurf, and more.

Get the whole plugin