HomeUpdatesGitHub
Docs/Commands/Onboard

Onboard

Tune a fresh Blueprint overlay to the real application, commands, checks, and workflow choices.

Commandscommandonboardsetup

When to use it

Run $onboard in Codex or /onboard in Claude Code immediately after installing Blueprint into a new or early application. In GitHub Copilot or OpenCode, ask the agent to run the onboard skill.

What it inspects

  • Framework, language, package manager, and project layout
  • Existing build, development, lint, and test commands
  • Existing Verify commands, GitHub workflows, and other automatic checks
  • Coding and styling conventions
  • Existing blueprint/config.json settings and validity
  • Adapter folders and ignore rules
  • Whether workflow files should be committed or kept local

What it writes

Onboarding can update AGENTS.md, the Claude project title, coding standards, AI interaction rules, selected project configuration values, ignore rules, project README cleanup, and adapter recommendations. It asks before changing workflow preferences and tells you what remains to fill in before overview.

Codex, GitHub Copilot, and OpenCode share .agents/. Claude Code uses .claude/. When all four tools are installed, adapter cleanup choices name Keep all adapters, Claude Code only, or Codex, GitHub Copilot, and OpenCode only instead of treating four tools as two.

It reports the existing test gate and CI state. When equivalent automatic checks are missing, it points to $ci or /ci as an optional follow-up. Onboarding does not create CI itself.

What it never does

It does not scaffold the application, invent the product plan, implement features, commit, or publish.

Next step

Review the setup. Run $ci or /ci if you want one shared Verify command and matching GitHub checks. Then fill in project-plan.md and build-plan.md directly or through any AI conversation and run $overview or /overview.

Review Project Configuration when you want to change review cadence, branch prefixes, verification requirements, automatic quality gates, or Continuous Mode limits.

If you want a guided deep planning conversation, you may run $discovery or /discovery first. It is optional and never runs as part of onboarding.

Documentation

Search AI Blueprint

Start typing to search the documentation.