# Cuitty

> The self-hosted, multi-module dashboard platform for DevOps and platform teams.

Cuitty is open at the wire-protocol layer. Any language can integrate by POSTing
signed JSON to /api/ingest. Modules: audit, configs, costs, deploys, logs,
performance, repository, secrets, video, forge.

## Getting Started
- [Quickstart](https://cuitty.com/docs/quickstart.md): Get a self-hosted Cuitty up and running in five minutes with Docker Compose.

## Install
- [Install with Docker](https://cuitty.com/docs/install/docker.md): Deploy Cuitty on a single VM using Docker Compose. Recommended for solo developers and small teams.
- [Install on Kubernetes](https://cuitty.com/docs/install/kubernetes.md): Deploy Cuitty to a Kubernetes cluster using the Helm chart, suitable for production workloads.
- [Install on bare metal](https://cuitty.com/docs/install/bare-metal.md): Run Cuitty as a single Bun binary on a Linux VM, with systemd-managed services for production durability.
- [Install on cloud providers](https://cuitty.com/docs/install/cloud.md): Deploy Cuitty on AWS, GCP, Azure, or Fly.io using infrastructure-as-code templates.

## SDK
- [TypeScript SDK](https://cuitty.com/docs/sdk/typescript.md): The @cuitty/sdk package — a fail-silent, batched HTTP client for TypeScript and Node.js applications.
- [Python SDK](https://cuitty.com/docs/sdk/python.md): Send Cuitty events from Python — sync or async, with built-in batching and HMAC signing.
- [Go SDK](https://cuitty.com/docs/sdk/go.md): Send Cuitty events from Go services with a context-aware client.
- [Rust SDK](https://cuitty.com/docs/sdk/rust.md): Send Cuitty events from Rust with an async tokio-friendly client.
- [SDK Parity & Divergence](https://cuitty.com/docs/sdk/parity.md): Intentional API differences across the four Cuitty SDKs.
- [cURL examples](https://cuitty.com/docs/sdk/curl.md): Send Cuitty events from any shell with a single curl invocation.
- [Protocol overview](https://cuitty.com/docs/sdk/protocol.md): How the wire protocol, SDKs, and ingest endpoint fit together.

## Reference
- [Wire protocol](https://cuitty.com/docs/reference/wire-protocol.md): The canonical contract for sending events to a Cuitty portal — request, signature, and response.
- [API reference](https://cuitty.com/docs/reference/api.md): HTTP endpoints exposed by the Cuitty portal beyond the ingest path.
- [CLI reference](https://cuitty.com/docs/reference/cli.md): The cui binary — operate Cuitty installs from the terminal.

## Modules
- [Audit module](https://cuitty.com/docs/modules/audit.md): Tamper-evident audit logging for every administrative action with before/after diffs.
- [Costs module](https://cuitty.com/docs/modules/costs.md): Track cloud spend across GCP, AWS, Azure, and DigitalOcean with budgets and alerts.
- [Deploys module](https://cuitty.com/docs/modules/deploys.md): Track every deployment across environments with health checks and rollback metadata.
- [Logs module](https://cuitty.com/docs/modules/logs.md): Aggregate structured logs from your services with search, filters, and tail.
- [Configs module](https://cuitty.com/docs/modules/configs.md): Configuration change tracking with diffs, attribution, and rollback hooks.
- [Repository module](https://cuitty.com/docs/modules/repository.md): Git metadata and code analysis events from GitHub, GitLab, and self-hosted repos.
- [Performance module](https://cuitty.com/docs/modules/performance.md): Runtime process metrics — CPU, memory, event loop, and GC for instrumented services.
- [Traces module](https://cuitty.com/docs/modules/traces.md): Distributed tracing for OpenTelemetry-style spans, service maps, and request waterfalls.
- [Errors module](https://cuitty.com/docs/modules/errors.md): Exception capture, fingerprinting, grouping, and triage for Cuitty services.
- [Feature Flags module](https://cuitty.com/docs/modules/feature-flags.md): Rollout rules, cohort targeting, kill switches, and SDK-side local evaluation.
- [Webhooks module](https://cuitty.com/docs/modules/webhooks.md): Signed outgoing webhook delivery with retries, secret rotation, and delivery history.
- [Tenants module](https://cuitty.com/docs/modules/tenants.md): Project and tenant administration for multi-tenant Cuitty installs.
- [Plaintext Secrets module](https://cuitty.com/docs/modules/plaintext-secrets.md): Polyglot source code scanner that detects hardcoded secrets, API keys, and credentials across all your projects.
- [Video module](https://cuitty.com/docs/modules/video.md): Browser-session recording jobs driven by natural-language prompts and explicit workflow steps.

## Apps
- [Auth app](https://cuitty.com/docs/apps/auth.md): Identity, sessions, and authorization boundaries used by Cuitty apps.
- [Portal app](https://cuitty.com/docs/apps/portal.md): The browser UI for projects, modules, keys, and operational review.
- [Admin app](https://cuitty.com/docs/apps/admin.md): Operator-only maintenance flows for migrations, verification, and install health.
- [Forge app](https://cuitty.com/docs/apps/forge.md): Workspace creation and repository setup flows for generated project ideas.
- [Site app](https://cuitty.com/docs/apps/site.md): Public marketing and documentation surface for Cuitty.

## Persist
- [Persist Quickstart](https://cuitty.com/docs/persist/quickstart.md): Install the Persist SDK and create your first store in under a minute.
- [Storage Adapters](https://cuitty.com/docs/persist/adapters.md): Configure SQLite, Postgres, S3, and P2P adapters for Persist stores.
- [Sync & Conflict Resolution](https://cuitty.com/docs/persist/sync.md): Configure automatic sync strategies and conflict resolution for Persist stores.
- [End-to-End Encryption](https://cuitty.com/docs/persist/encryption.md): Enable P2P encryption and zero-knowledge data protection in Persist stores.

## Indexes
- [Docs index (JSON)](https://cuitty.com/api/docs.json)
- [Full corpus](https://cuitty.com/llms-full.txt)

## Optional
- [Architecture](https://cuitty.com/product/architecture)
- [Security model](https://cuitty.com/product/security)