# Onyx

## Docs

- [Git and Append-Only History](https://onyxresearch.ai/docs/concepts/git-history.md): How Onyx uses git branches and commits as the durable research record.
- [Metrics](https://onyxresearch.ai/docs/concepts/metrics.md): Design branch metrics that help agents make good research decisions.
- [Offline Outbox and Sync](https://onyxresearch.ai/docs/concepts/offline-sync.md): How the CLI records local work and reconciles it with the Onyx app.
- [The onyx Directory](https://onyxresearch.ai/docs/concepts/onyx-directory.md): The repo-side research surface the Onyx agent creates and uses.
- [Projects, Branches, and Experiments](https://onyxresearch.ai/docs/concepts/projects-branches-experiments.md): Understand the core Onyx research model.
- [Overview](https://onyxresearch.ai/docs/index.md): Onyx is a git-native auto research platform for hardware teams and AI agents.
- [Installation](https://onyxresearch.ai/docs/installation.md): Install the Onyx CLI and connect it to your team.
- [GitHub App Access](https://onyxresearch.ai/docs/platform/github-app.md): Use the Onyx GitHub App to grant repository access for branches and code review.
- [Platform Overview](https://onyxresearch.ai/docs/platform/overview.md): Review projects, branches, experiments, files, and diffs in the Onyx app.
- [Review Graphs, Timelines, Files, and Diffs](https://onyxresearch.ai/docs/platform/review.md): Understand the product review surfaces for research history.
- [Settings and API Keys](https://onyxresearch.ai/docs/platform/settings-api-keys.md): Manage team-scoped API access and CLI profiles.
- [Quickstart](https://onyxresearch.ai/docs/quickstart.md): Start an agent-first Onyx research loop from an existing repository.
- [API Endpoints](https://onyxresearch.ai/docs/reference/api-endpoints.md): Generated endpoint index for the Onyx Research API.
- [API Overview](https://onyxresearch.ai/docs/reference/api-overview.md): Authentication, response envelopes, and endpoint groups for /api/v1.
- [CLI Reference](https://onyxresearch.ai/docs/reference/cli.md): Commands supported by the onyx research workflow CLI.
- [Docs Maintenance](https://onyxresearch.ai/docs/reference/docs-maintenance.md): Keep Onyx docs aligned with onyx-research and onyx-agent changes.
- [Use Onyx with Agents](https://onyxresearch.ai/docs/tutorials/agents.md): Start, steer, and resume Onyx auto research with slash-command prompts.
- [Understand onyx.md and eval.sh](https://onyxresearch.ai/docs/tutorials/eval-check-scripts.md): Learn how the Onyx agent creates, uses, and updates the repo-side research files.
- [Your First Agent Experiment](https://onyxresearch.ai/docs/tutorials/first-experiment.md): Understand what happens after you prompt an Onyx agent to start auto research.
- [Start from a Repository](https://onyxresearch.ai/docs/tutorials/link-repository.md): Start an Onyx branch from an existing git repository.
- [Monorepos and Project Paths](https://onyxresearch.ai/docs/tutorials/monorepos.md): Scope Onyx to a subdirectory while keeping git history in the full repository.

## OpenAPI Specs

- [openapi](https://onyxresearch.ai/docs/reference/openapi.json)

## Optional

- [Landing Page](https://onyxresearch.ai)
- [Platform](https://app.onyxresearch.ai)
- [GitHub](https://github.com/onyx-robotics)