# 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 Cuitty Cloud using infrastructure-as-code templates.

## Code
- [Cuitty Code Apps](https://cuitty.com/docs/code/apps.md): Installable, permission-scoped apps for Cuitty Code.
- [App Manifest](https://cuitty.com/docs/code/app-manifest.md): Reference for the .cuitty/app.toml manifest used by Cuitty Code Apps.
- [App Permissions](https://cuitty.com/docs/code/app-permissions.md): How Cuitty Code Apps request, receive, and use granular permissions.
- [Code App Market](https://cuitty.com/docs/code/app-market.md): Publish, share, install, and manage Cuitty Code Apps.
- [Authorization with SpiceDB](https://cuitty.com/docs/code/authz-spicedb.md): Relationship-based authorization for Cuitty Code Apps and Registry.
- [App execution with Airflow](https://cuitty.com/docs/code/app-execution-airflow.md): Run Cuitty Code Apps through Airflow DAGs and reconcile callbacks.
- [Code Registry](https://cuitty.com/docs/code/registry.md): Use Cuitty Code Registry for npm, Cargo, OCI, and PyPI packages.
- [npm Packages](https://cuitty.com/docs/code/npm.md): Publish npm packages safely with Cuitty Code Registry.
- [Cargo Crates](https://cuitty.com/docs/code/cargo.md): Publish Rust crates with Cuitty Code Registry.
- [OCI and Docker Images](https://cuitty.com/docs/code/oci.md): Push and pull OCI artifacts through Cuitty Code Registry.
- [PyPI Packages](https://cuitty.com/docs/code/pypi.md): Upload Python packages to Cuitty Code Registry.
- [Organizations](https://cuitty.com/docs/code/organizations.md): Create organizations, invite members, and share Code Apps and packages.
- [Slugs and Profiles](https://cuitty.com/docs/code/slugs-and-profiles.md): User and organization slugs, follows, and markdown-customizable profile pages.
- [Ownership Transfer](https://cuitty.com/docs/code/ownership-transfer.md): Move repositories, apps, registry namespaces, and packages between users and organizations.
- [Self-Hosted Registry](https://cuitty.com/docs/code/self-hosted-registry.md): Run Cuitty Code Registry and Code App Market on your own infrastructure.
- [Code Apps and Registry operator runbook](https://cuitty.com/docs/code/operator-runbook.md): Operate Cuitty Code Apps, Registry, SpiceDB, and Airflow in self-hosted deployments.

## Safe
- [Safe Quickstart](https://cuitty.com/docs/safe/quickstart.md): Create a local Cuitty Safe, replace env values with references, and resolve them at runtime.
- [Safe References](https://cuitty.com/docs/safe/references.md): The canonical account/safe/secret model and accepted reference syntaxes for Cuitty Safe.
- [Safe Storage Modes](https://cuitty.com/docs/safe/storage-modes.md): Compare local vaults, inline encrypted text, Persist-backed Safes, and 1Password pass-through.
- [1Password Connector](https://cuitty.com/docs/safe/onepassword.md): Use 1Password as the source of truth while keeping Cuitty Safe references stable.
- [Persist Adapter](https://cuitty.com/docs/safe/persist-adapter.md): Configure the alpha Cuitty Persist adapter for Safe records with mandatory E2EE guardrails.
- [Safe CI/CD](https://cuitty.com/docs/safe/ci-cd.md): Resolve Safe references in CI/CD jobs without leaking values into scripts, logs, or process metadata.
- [Safe SDK](https://cuitty.com/docs/safe/sdk.md): The @cuitty/safe package shape, client and server halves, and framework subpaths.
- [Safe Desktop](https://cuitty.com/docs/safe/desktop.md): How the planned Safe desktop app manages vaults, connector setup, reveal controls, and local audit review.
- [Safe Security](https://cuitty.com/docs/safe/security.md): Security rules for references, encryption, redaction, audit metadata, connectors, and sharing stubs.

## Pilot
- [Pilot Quickstart](https://cuitty.com/docs/pilot/quickstart.md): Record and replay your first provider dashboard workflow in five minutes.
- [Playbook Reference](https://cuitty.com/docs/pilot/playbook-reference.md): Complete YAML schema for Cuitty Pilot playbooks — inputs, steps, actions, assertions, and captures.
- [Executors](https://cuitty.com/docs/pilot/executors.md): Pilot executor reference — Browser, Terraform, Git, Persist, Shell, HTTP, and Composite.
- [Pilot JavaScript SDK](https://cuitty.com/docs/pilot/sdk/javascript.md): PilotClient for TypeScript and Node.js — run playbooks, manage runs, and stream events programmatically.
- [Pilot React SDK](https://cuitty.com/docs/pilot/sdk/react.md): React hooks and components for Cuitty Pilot — manage playbooks, runs, and real-time events in React apps.
- [Pilot SolidJS SDK](https://cuitty.com/docs/pilot/sdk/solid.md): SolidJS primitives and components for Cuitty Pilot — reactive playbook management, run control, and real-time event streaming.
- [Pilot Rust SDK](https://cuitty.com/docs/pilot/sdk/rust.md): Async Rust client for the Cuitty Pilot API — manage playbooks, runs, and providers with reqwest and serde.
- [Pilot Go SDK](https://cuitty.com/docs/pilot/sdk/go.md): Go client for the Cuitty Pilot API — manage playbooks, runs, and providers with idiomatic Go error handling.
- [Pilot Python SDK](https://cuitty.com/docs/pilot/sdk/python.md): Async and sync Python clients for the Cuitty Pilot API — manage playbooks, runs, and providers with httpx.

## DSL
- [DSL quickstart](https://cuitty.com/docs/dsl/quickstart.md): Start authoring Cuitty product workflows with .cuitty files.
- [DSL reference](https://cuitty.com/docs/dsl/reference.md): Canonical Cuitty DSL blocks and adapter targets.
- [DSL playground](https://cuitty.com/docs/dsl/playground.md): Use the local and hosted Cuitty DSL playgrounds.
- [DSL migration](https://cuitty.com/docs/dsl/migration.md): Migrate .ctest, Video YAML, and Pilot YAML into the unified Cuitty DSL.

## Video
- [Video quickstart](https://cuitty.com/docs/video/quickstart.md): Create, preview, render, and inspect a Cuitty Video composition.
- [Video reference](https://cuitty.com/docs/video/reference.md): Composition model, SDK surfaces, DSL fields, and renderer options for Cuitty Video.
- [Video CLI](https://cuitty.com/docs/video/cli.md): Commands and options for the Cuitty Video command-line workflow.
- [Video E2E visibility](https://cuitty.com/docs/video/e2e.md): Run local end-to-end video generation and inspect the inputs, IR, frames, FFmpeg logs, and output video.

## 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): Control-plane feature flags with groups, self-overrides, permissions, 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.

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

## Tests
- [Tests Quickstart](https://cuitty.com/docs/tests/quickstart.md): Write and run your first Cuitty test suite in five minutes.

## Toolbar
- [Toolbar Quickstart](https://cuitty.com/docs/toolbar/quickstart.md): Embed the Cuitty Toolbar in your app in under a minute.

## 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)