# Onyx

- [Overview](https://www.onyxresearch.ai/docs/index.md): Onyx is a git-native auto research platform for hardware teams and AI agents.
- [Installation](https://www.onyxresearch.ai/docs/installation.md): Install the Onyx CLI and connect it to your team.
- [Quickstart](https://www.onyxresearch.ai/docs/quickstart.md): Start an agent-first Onyx research loop from an existing repository.
- [Start from a Repository](https://www.onyxresearch.ai/docs/tutorials/link-repository.md): Start an Onyx campaign from an existing git repository.
- [Your First Agent Experiment](https://www.onyxresearch.ai/docs/tutorials/first-experiment.md): Understand what happens after you prompt an Onyx agent to start auto research.
- [Understand setup workflows and tools](https://www.onyxresearch.ai/docs/tutorials/eval-check-scripts.md): Learn how the Onyx agent creates, uses, and validates repo-side setup workflows.
- [Use Onyx with Agents](https://www.onyxresearch.ai/docs/tutorials/agents.md): Start, steer, and extend Onyx auto research with slash-command prompts.
- [Monorepos and Project Paths](https://www.onyxresearch.ai/docs/tutorials/monorepos.md): Scope Onyx to a subdirectory while keeping git history in the full repository.
- [Windows via WSL2](https://www.onyxresearch.ai/docs/tutorials/windows-wsl2.md): Run the Onyx 0.1.20 Windows via WSL2 preview with Linux-local repositories and tools.
- [Projects, Campaigns, and Experiments](https://www.onyxresearch.ai/docs/concepts/projects-campaigns-experiments.md): Understand the core Onyx research model.
- [Git and Immutable Experiment Refs](https://www.onyxresearch.ai/docs/concepts/git-history.md): How Onyx uses git commits and refs as the durable research record.
- [Metrics](https://www.onyxresearch.ai/docs/concepts/metrics.md): Design campaign metrics that help agents make good research decisions.
- [The onyx Directory](https://www.onyxresearch.ai/docs/concepts/onyx-directory.md): The repo-side research surface the Onyx agent creates and uses.
- [Remote-First Runtime State](https://www.onyxresearch.ai/docs/concepts/runtime-state.md): How Onyx separates server-owned research state from local runtime files.
- [Platform Overview](https://www.onyxresearch.ai/docs/platform/overview.md): Review projects, campaigns, experiments, files, and diffs in the Onyx app.
- [GitHub App Access](https://www.onyxresearch.ai/docs/platform/github-app.md): Use the Onyx GitHub App to grant repository access for campaigns and code review.
- [Review Graphs, Timelines, Files, and Diffs](https://www.onyxresearch.ai/docs/platform/review.md): Understand the product review surfaces for research history.
- [Teams and Members](https://www.onyxresearch.ai/docs/platform/teams.md): Create teams, invite members, manage roles, and switch between teams.
- [Settings and API Keys](https://www.onyxresearch.ai/docs/platform/settings-api-keys.md): Manage team-scoped API access for automation and SDKs.
- [CLI Reference](https://www.onyxresearch.ai/docs/reference/cli.md): Commands supported by the onyx research workflow CLI.
- [CLI Analytics and Privacy](https://www.onyxresearch.ai/docs/reference/telemetry.md): What the Onyx CLI collects, what it excludes, and how to opt out.
- [API Overview](https://www.onyxresearch.ai/docs/reference/api-overview.md): Authentication, response envelopes, and endpoint groups for /api/v1.
- [API Endpoints](https://www.onyxresearch.ai/docs/reference/api-endpoints.md): Generated endpoint index for the Onyx Research API.
- [Docs Maintenance](https://www.onyxresearch.ai/docs/reference/docs-maintenance.md): Keep Onyx docs aligned with onyx-research and onyx-agent changes.

## OpenAPI Specs

- [openapi](/docs/reference/openapi.json)

## Optional

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