# Yellowhammer

- [Introduction](https://yellowhammer.dev/docs/index.md): Understand what Yellowhammer does and where to begin.
- [Requirements](https://yellowhammer.dev/docs/start/requirements.md): Check the Mac, services, and accounts a Project needs.
- [Your first Night](https://yellowhammer.dev/docs/quickstart.md): Follow the learning path from prerequisites to reviewing a Night result.
- [Set up your Project](https://yellowhammer.dev/docs/setup/overview.md): Prepare the integrations, repositories, and specification for one product.
- [Connect Linear](https://yellowhammer.dev/docs/setup/connect-linear.md): Understand the Linear connection and Project board used by Yellowhammer.
- [Connect GitHub](https://yellowhammer.dev/docs/setup/connect-github.md): Prepare GitHub access for pull requests across a Project’s repositories.
- [Connect Orca and agent CLIs](https://yellowhammer.dev/docs/setup/connect-orca-and-agent-clis.md): Prepare local worktree execution and the coding agents you already use.
- [Add a Project and repositories](https://yellowhammer.dev/docs/setup/add-project-and-repositories.md): Define the product scope and repositories that a Night may touch.
- [Prepare your specification](https://yellowhammer.dev/docs/setup/prepare-specification.md): Make product intent and completion criteria clear enough for a Night.
- [Run Nights](https://yellowhammer.dev/docs/run/overview.md): Choose how a Project rehearses, schedules, and bounds unattended work.
- [Rehearse before scheduling](https://yellowhammer.dev/docs/run/rehearse-before-scheduling.md): Learn what a rehearsal Night can reveal before unattended runs.
- [Configure the schedule](https://yellowhammer.dev/docs/run/configure-the-schedule.md): Understand the scheduling choices for local unattended Nights.
- [Choose agents and routes](https://yellowhammer.dev/docs/run/choose-agents-and-routes.md): Understand how an agent CLI, model, and effort form a Route.
- [Set limits and protected paths](https://yellowhammer.dev/docs/run/set-limits-and-protected-paths.md): Review the Project limits and repository paths that constrain execution.
- [Review the morning](https://yellowhammer.dev/docs/review/overview.md): Use Linear to understand each Night and decide what needs your attention.
- [Read the Night Summary](https://yellowhammer.dev/docs/review/read-the-night-summary.md): Interpret what a Night completed, blocked, or left for you.
- [Understand the Pulse and Inspector](https://yellowhammer.dev/docs/review/understand-pulse-and-inspector.md): Use Pulse and Inspector to navigate Project activity and inspect records.
- [Answer questions and unblock work](https://yellowhammer.dev/docs/review/answer-questions-and-unblock-work.md): Find Work Cards that need a human answer and understand their next state.
- [Review pull requests and Partial Landings](https://yellowhammer.dev/docs/review/pull-requests-and-partial-landings.md): Assess the pull requests a Night opens and decide whether to merge them.
- [Understand Yellowhammer](https://yellowhammer.dev/docs/concepts/overview.md): Build a mental model of Projects, Nights, Features, and Work Cards.
- [Projects, Features, and Work Cards](https://yellowhammer.dev/docs/concepts/projects-features-and-work-cards.md): Understand how product scope and pieces of work relate in Linear.
- [The lifecycle of a Night](https://yellowhammer.dev/docs/concepts/lifecycle-of-a-night.md): Follow a Feature from selection through execution, verification, and review.
- [Verification and Definition of Done](https://yellowhammer.dev/docs/concepts/verification-and-definition-of-done.md): Understand how completion criteria connect to the specification and evidence.
- [Local execution and credentials](https://yellowhammer.dev/docs/concepts/local-execution-and-credentials.md): Understand where code, tools, and credentials are used during a Night.
- [Reference and troubleshooting](https://yellowhammer.dev/docs/reference/overview.md): Look up settings, statuses, commands, and recovery guidance.
- [Settings](https://yellowhammer.dev/docs/reference/settings.md): Find the settings that shape Project setup and Night behavior.
- [yh command line](https://yellowhammer.dev/docs/reference/yh-command-line.md): Understand the role and lookup path for the yh command-line tool.
- [Statuses and glossary](https://yellowhammer.dev/docs/reference/statuses-and-glossary.md): Look up authoritative Yellowhammer terms and Work Card statuses.
- [Troubleshoot setup and connections](https://yellowhammer.dev/docs/reference/troubleshoot-setup-and-connections.md): Diagnose common problems while preparing a Project and its integrations.
- [Troubleshoot Nights and missing results](https://yellowhammer.dev/docs/reference/troubleshoot-nights-and-missing-results.md): Investigate a Night that did not run or produced an unexpected result.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.