# Ferrox Onboard

> You have an existing codebase and want Ferrox on it. Maps, ingests docs, sets up planning

- Skill: `ferroxlabs/ferrox-onboard` (Agent Skill)
- Install (CLI): `npx skillmds@latest add ferroxlabs/ferrox-onboard`
- Raw SKILL.md: https://api.skillmd.com/api/skills/ferroxlabs/ferrox-onboard/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: FerroxLabs (https://skillmd.com/u/ferroxlabs)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/ferroxlabs/ferrox-onboard

---


<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 Ferrox primitives in the safe order: codebase map → docs ingest → project initialization → onboarding summary.

**Creates or confirms:**
- `.planning/codebase/` — evidence-backed codebase map from `/ferrox-map-codebase`
- `.planning/PROJECT.md`, `REQUIREMENTS.md`, `ROADMAP.md`, `STATE.md` — project setup from `/ferrox-new-project` or `/ferrox-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/ferrox-core/workflows/onboard.md
@~/.claude/ferrox-core/references/ui-brand.md
@~/.claude/ferrox-core/references/gate-prompts.md
</execution_context>

<context>
Arguments: $ARGUMENTS

Flags:
- `--fast` — prefer `/ferrox-map-codebase --fast` for the mapping handoff; the complete map is still required before `/ferrox-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>