<!-- SPDX-FileCopyrightText: 2026 Apoorv Garg <apoorvgarg.21@gmail.com> -->
<!-- SPDX-FileCopyrightText: 2026 tsitu0 <tomsitu0102@gmail.com> -->
<!-- SPDX-License-Identifier: AGPL-3.0-only -->

# Summary

* [Welcome](README.md)

## Getting Started

* [Installation](getting-started/installation.md)
* [Quickstart](getting-started/quickstart.md)
* [Core Concepts](getting-started/core-concepts.md)

## Use Cases

* [Overview](use-cases/README.md)
* [Observe MCP traffic](use-cases/observe-mcp-traffic.md)
* [Share agent configs across IDEs](use-cases/share-agent-configs.md)
* [Debug agent failures](use-cases/debug-agent-failures.md)
* [Run a team-wide agent registry](use-cases/team-registry.md)

## CLI Reference

* [Overview](cli/README.md)
* [observal auth](cli/auth.md)
* [observal config](cli/config.md)
* [observal scan](cli/scan.md)
* [observal agent pull](cli/pull.md)
* [observal registry](cli/registry.md)
* [observal component](cli/component.md)
* [observal models](cli/models.md)
* [observal agent](cli/agent.md)
* [observal ops](cli/ops.md)
* [observal admin](cli/admin.md)
* [observal doctor](cli/doctor.md)
* [observal profile](cli/profile.md)
* [observal self](cli/self.md)
* [observal prompt](cli/prompt.md)
* [observal server](cli/server.md)
* [observal uninstall](cli/uninstall.md)

## Self-Hosting

* [Overview](self-hosting/README.md)
* [Requirements](self-hosting/requirements.md)
* [Docker Compose setup](self-hosting/docker-compose.md)
* [AWS deployment with Terraform](self-hosting/aws-terraform.md)
* [Configuration](self-hosting/configuration.md)
* [Ports and volumes](self-hosting/ports-and-volumes.md)
* [Databases](self-hosting/databases.md)
* [Authentication and SSO](self-hosting/authentication.md)
* [Telemetry pipeline](self-hosting/telemetry-pipeline.md)
* [Upgrades](self-hosting/upgrades.md)
* [Backup and restore](self-hosting/backup-and-restore.md)
* [Troubleshooting](self-hosting/troubleshooting.md)

## Reference

* [Environment variables](reference/environment-variables.md)
* [API endpoints](reference/api-endpoints.md)
* [Hooks specification](reference/hooks-spec.md)
* [Config files](reference/config-files.md)

## Contributing

* [Contributing Guide](../CONTRIBUTING.md)
* [Development Guide](DEVELOPMENT_GUIDE.md)
* [AI Policy](../AI_POLICY.md)
