# onboard

onboard — a command that prepares an agent to work on a project. It explores the codebase, asks clarifying questions, and records context for the next session.

- command · `type=command` · Claude Code, Codex, GitHub Copilot, Gemini CLI · ★ 6091 repo stars
- Author: ChrisWiles
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/ChrisWiles/claude-code-showcase/tree/HEAD/.claude/commands/onboard.md
- Updated: 2026-01-06
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/commands/chriswiles-onboard

## What it does

The command triggers extended thinking and guides the agent through project exploration before starting work. The agent studies code structure, understands architecture, asks questions when needed, and writes everything to `.claude/tasks/[TASK_ID]/onboarding.md`. This file then speeds up context recovery in future sessions.

Available in Claude Code and other platforms via configuration files. The agent is expected to spend as much time preparing as needed—thoroughness matters more than rushing through the overview.

## Install

### Claude Code (native platform)

**Manually: put the files in place**
- File: `.claude/commands/onboard.md` — Call it with /onboard. For all projects use ~/.claude/commands/

### Codex

**Manually: put the files in place**
- File: `~/.codex/prompts/onboard.md` — Call it with /prompts:onboard. Codex marks this format deprecated in favour of skills

### GitHub Copilot

**Manually: put the files in place**
- File: `.github/prompts/onboard.prompt.md`

### Gemini CLI

**Manually: put the files in place**
- File: `.gemini/commands/onboard.toml` — Gemini stores commands as TOML: the prompt text goes into the prompt field

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/ChrisWiles/claude-code-showcase/tree/HEAD/.claude/commands/onboard.md

## When to use it
- restore task context in a new session without re-analyzing code
- prepare an agent to work on an unfamiliar project
- document architecture and requirements before coding starts
- catch gaps in understanding the task before implementation begins

## Example prompts
- Run `/onboard` to prepare yourself for this task
- Before you start, explore the project with `/onboard`
- Set up the task context: `/onboard`

## Similar
- [understand-onboard](https://affpapa.org/en/nevibecode/skills/understand-onboard.md) — skill · 4400 installs
- [groove-utilities-onboard](https://affpapa.org/en/nevibecode/skills/groove-utilities-onboard.md) — skill · 506 installs
- [initref](https://affpapa.org/en/nevibecode/commands/initref.md) — command · 186 installs
- [dev-docs-update](https://affpapa.org/en/nevibecode/commands/dev-docs-update.md) — command · ★ 10055 repo stars
- [cleanup-context](https://affpapa.org/en/nevibecode/commands/cleanup-context.md) — command · ★ 2744 repo stars
- [setup-matt-pocock-skills](https://affpapa.org/en/nevibecode/skills/setup-matt-pocock-skills.md) — skill · 1052851 installs

## Other versions with the same name
- [onboard · wshobson](https://affpapa.org/en/nevibecode/commands/seth-hobson-onboard.md) — ★ 42780 repo stars
- [onboard · composio-community](https://affpapa.org/en/nevibecode/commands/composio-community-onboard.md) — ★ 2003 repo stars
- [onboard · microsoft](https://affpapa.org/en/nevibecode/commands/onboard.md) — ★ 3232 repo stars

From the same set: [chriswiles/claude-code-showcase](https://affpapa.org/en/nevibecode/by/chriswiles/claude-code-showcase.md) — 11 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
