beads/website/versioned_docs/version-1.0.4/cli-reference/onboard.md
Eugene Brevdo 5d33b4c891
init: run Codex project setup by default
Run Codex project setup during `bd init` using the existing setup installer, and stage generated Codex project files in the bootstrap commit.

Also refresh the generated setup/init docs for the new default behavior.

Co-authored-by: Eugene Brevdo <ebrevdo@gmail.com>

_codex-gpt-5.5-medium on behalf of CI Bot_
2026-05-26 13:03:37 -07:00

934 B

id title slug sidebar_position
onboard bd onboard /cli-reference/onboard 999

Generated from bd help --doc onboard

bd onboard

Display a minimal snippet to add to your agent instructions file for bd integration.

By default, the agent instructions file is AGENTS.md. Use 'bd init --agents-file' to configure a different filename (e.g. BEADS.md).

This outputs a small (~10 line) snippet that points to 'bd prime' for full workflow context. This is the same minimal profile that 'bd init' generates by default. This approach:

• Keeps your agent file lean (doesn't bloat with instructions) • bd prime provides dynamic, always-current workflow details • Hooks auto-inject bd prime at session start

For agents or environments that do not auto-inject hook output, use 'bd init --agents-profile=full' to embed the complete command reference.

bd onboard