> ## Documentation Index
> Fetch the complete documentation index at: https://yellowhammer.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Understand what Yellowhammer does and where to begin.

Yellowhammer runs unattended engineering [Nights](https://yellowhammer.dev/docs/reference/statuses-and-glossary.md#night) on your Mac. It turns your specification into [Features](https://yellowhammer.dev/docs/reference/statuses-and-glossary.md#feature) and Work Cards, coordinates coding agents across a [Project](https://yellowhammer.dev/docs/reference/statuses-and-glossary.md#project)'s repositories, and opens pull requests for your review.

## Start here

> [card] [Requirements](https://yellowhammer.dev/docs/start/requirements.md)
>
> Check your Mac, services, and coding agents before setup.

> [card] [Your first Night](https://yellowhammer.dev/docs/quickstart.md)
>
> Connect a Project, check readiness, and review its results.

## How it fits together

Linear holds your Features, Work Cards, questions, and Night Summary. Orca ADE creates the Worktrees where your local agent CLIs work. GitHub holds the resulting pull requests. You make decisions in Linear and choose what to merge in GitHub.

Each Project has its own repositories, specification source, schedule, and limits. A Night can progress through multiple Features as work finishes, subject to those limits. Work Cards for the same repository run in order; different repositories can advance independently.

Planned relationship diagram

**Yellowhammer product map**

Show how a Project connects its specification, Linear, repositories, local agent CLIs, and the Night Summary.

Planned visual: one Project feeds a local Night; its results return to Linear and GitHub for your review.

## Run locally, review when ready

Scheduled jobs run on your Mac even when the Yellowhammer window is closed or the app is quit. Keep the Mac available during the Night window and set up the local tools before leaving it unattended. The [Pulse](https://yellowhammer.dev/docs/review/understand-pulse-and-inspector.md) lets you inspect activity and follow links to Linear.

Start with the [setup overview](https://yellowhammer.dev/docs/setup/overview.md), then learn how to [run Nights](https://yellowhammer.dev/docs/run/overview.md) and [review the morning](https://yellowhammer.dev/docs/review/overview.md).

## Next steps

[Set up your Project](https://yellowhammer.dev/docs/setup/overview.md) · [Projects, Features, and Work Cards](https://yellowhammer.dev/docs/concepts/projects-features-and-work-cards.md)


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