<!-- markdownlint-disable-file MD041 -->

**roar** automatically tracks the reproducible lineage of your work by observing your commands as they run — without requiring you to define a pipeline or write extra configuration.

When paired with **GLaaS** (Global Lineage-as-a-Service), this observation approach scales to a global registry: search for any artifact by its hash, navigate the connections between jobs, and reproduce results on other machines.

## Get Started

The on-ramp for new readers — install roar, run your first traced command, understand the pitch.

- [Documentation Overview](/docs/overview) — this page.
- [Installation](/docs/installation) — install roar and verify your environment.
- [Quick Start](/docs) — install roar and run your first traced command in five minutes.
- [Why roar + GLaaS?](/docs/why-roar-glaas) — the design philosophy behind implicit observation.
- [Compared to Logs and Trackers](/docs/compared-to-logs-and-trackers) — what GLaaS gives you that logs, experiment trackers, and storage conventions do not.

## Guides

Hands-on walkthroughs and the conceptual model. Read these in order if you're new; come back when working through new patterns.

- [Core Concepts](/docs/core-concepts) — jobs, artifacts, sessions, DAGs.
- [roar Guide](/docs/roar-guide) — the full CLI reference.
- [Benchmarks](/docs/benchmarks) — performance numbers for tracers, proxy, and hashing.
- [Use Cases](/docs/use-cases) — common workflows for real questions.
- [TReqs Actions](/docs/treqs) — View Training Request and Run in TReqs from GLaaS.

## Reference

Deep dives and lookup material.

- [Tracers](/docs/tracers) — eBPF / preload / ptrace, comparison, cloud-platform compatibility.
- [Hashes](/docs/hashes) — content-addressable identity, blake3 vs sha256, multi-algo storage.
- [Composite Artifacts](/docs/composite-artifacts) — datasets as single artifacts; Bloom-filter membership for large composites.
- [Authentication](/docs/authentication) — access control and token management.
- [Scopes](/docs/scopes) — privacy and visibility model for registered lineage.
- [Labels](/docs/labels) — metadata attached to sessions, jobs, and artifacts; search on glaas.ai.
- [Glossary](/docs/glossary) — definitions of key terms.

## Integrations

- [Cloud Storage Proxy](/docs/proxy) — the S3 proxy that captures cloud-storage lineage.
- [Ray](/docs/ray) — multi-node Ray integration; per-task lineage and fragment streaming.
- [Experiment Tracking](/docs/experiment-tracking) — W&B / MLflow / Neptune integration, not replacement.

## Appendix

- [Troubleshooting](/docs/troubleshooting) — symptom-indexed fixes for common errors.
- [Telemetry](/docs/telemetry) — anonymous product telemetry; opt-out controls and full payload allowlist.
- [FAQ](/docs/faq) — implementation details and "why does it work this way" questions.

## Examples

- [End-to-End Introduction](/examples/end-to-end-intro) — a six-step walkthrough that generates and combines small binary artifacts with `roar run`, inspects the inferred DAG, registers the final artifact with GLaaS, and reproduces it in a fresh directory from its hash.
