Build with Cuitty.
Every page on this site is also available as raw Markdown
(/docs/<slug>.md)
and structured JSON
(/docs/<slug>.json).
Coding agents read the same docs your team does.
Getting Started
Install
- InstallInstall with DockerDeploy Cuitty on a single VM using Docker Compose. Recommended for solo developers and small teams.
- InstallInstall on KubernetesDeploy Cuitty to a Kubernetes cluster using the Helm chart, suitable for production workloads.
- InstallInstall on bare metalRun Cuitty as a single Bun binary on a Linux VM, with systemd-managed services for production durability.
- InstallInstall on cloud providersDeploy Cuitty on AWS, GCP, Azure, or Cuitty Cloud using infrastructure-as-code templates.
Code
- CodeCuitty Code AppsInstallable, permission-scoped apps for Cuitty Code.
- CodeApp ManifestReference for the .cuitty/app.toml manifest used by Cuitty Code Apps.
- CodeApp PermissionsHow Cuitty Code Apps request, receive, and use granular permissions.
- CodeCode App MarketPublish, share, install, and manage Cuitty Code Apps.
- CodeAuthorization with SpiceDBRelationship-based authorization for Cuitty Code repositories, apps, and Registry integration.
- CodeApp execution with AirflowRun Cuitty Code Apps through Airflow DAGs and reconcile callbacks.
- CodeOrganizationsCreate organizations, invite members, and share Code Apps and packages.
- CodeSlugs and ProfilesUser and organization slugs, follows, and markdown-customizable profile pages.
- CodeOwnership TransferMove repositories, apps, registry namespaces, and packages between users and organizations.
- CodeCode Apps operator runbookOperate Cuitty Code Apps, the App Market, SpiceDB, and Airflow in self-hosted deployments.
Registry
- RegistryCuitty RegistrySelf-host npm, Cargo, PyPI, Docker, and OCI artifacts with Cuitty Registry.
- RegistrySelf-hosted RegistryRun Cuitty Registry as a standalone service backed by Cuitty Store.
- Registrynpm packagesPublish and install npm packages with Cuitty Registry.
- RegistryCargo cratesPublish and install Rust crates with Cuitty Registry.
- RegistryPyPI packagesUpload Python wheels and sdists with Cuitty Registry.
- RegistryOCI and Docker imagesPush and pull container images and OCI artifacts with Cuitty Registry.
- RegistryRegistry authorizationNamespace, package, token, and visibility authorization in Cuitty Registry.
- RegistryCode integrationHow Cuitty Code integrates with the standalone Cuitty Registry service.
- RegistryRegistry operator runbookOperate Cuitty Registry in local, self-hosted, and production deployments.
Safe
- SafeSafe QuickstartCreate a local Cuitty Safe, replace env values with references, and resolve them at runtime.
- SafeSafe ReferencesThe canonical account/safe/secret model and accepted reference syntaxes for Cuitty Safe.
- SafeSafe Storage ModesCompare local vaults, inline encrypted text, Store-backed Safes, and 1Password pass-through.
- Safe1Password ConnectorUse 1Password as the source of truth while keeping Cuitty Safe references stable.
- SafeStore AdapterConfigure the alpha Cuitty Store adapter for Safe records with mandatory E2EE guardrails.
- SafeSafe CI/CDResolve Safe references in CI/CD jobs without leaking values into scripts, logs, or process metadata.
- SafeSafe SDKThe @cuitty/safe package shape, client and server halves, and framework subpaths.
- SafeSafe DesktopHow the planned Safe desktop app manages vaults, connector setup, reveal controls, and local audit review.
- SafeSafe SecuritySecurity rules for references, encryption, redaction, audit metadata, connectors, and sharing stubs.
Store
- StoreStore QuickstartInstall the Store SDK and create your first store in under a minute.
- StoreStorage AdaptersConfigure SQLite, Postgres, S3, and P2P adapters for Store stores.
- StoreSync & Conflict ResolutionConfigure automatic sync strategies and conflict resolution for Store stores.
- StoreEnd-to-End EncryptionEnable P2P encryption and zero-knowledge data protection in Store stores.
- StorePersist to Store MigrationMove from legacy Cuitty Persist names to the canonical Cuitty Store SDK, DSL, CLI, and docs paths.
Pilot
- PilotPilot QuickstartRecord and replay your first provider dashboard workflow in five minutes.
- PilotPlaybook ReferenceComplete YAML schema for Cuitty Pilot playbooks — inputs, steps, actions, assertions, and captures.
- PilotExecutorsPilot executor reference — Browser, Terraform, Git, Store, Shell, HTTP, and Composite.
- PilotPilot JavaScript SDKPilotClient for TypeScript and Node.js — run playbooks, manage runs, and stream events programmatically.
- PilotPilot React SDKReact hooks and components for Cuitty Pilot — manage playbooks, runs, and real-time events in React apps.
- PilotPilot SolidJS SDKSolidJS primitives and components for Cuitty Pilot — reactive playbook management, run control, and real-time event streaming.
- PilotPilot Rust SDKAsync Rust client for the Cuitty Pilot API — manage playbooks, runs, and providers with reqwest and serde.
- PilotPilot Go SDKGo client for the Cuitty Pilot API — manage playbooks, runs, and providers with idiomatic Go error handling.
- PilotPilot Python SDKAsync and sync Python clients for the Cuitty Pilot API — manage playbooks, runs, and providers with httpx.
DSL
- DSLDSL quickstartStart authoring Cuitty product workflows with .cuitty files.
- DSLDSL referenceCanonical Cuitty DSL blocks and adapter targets.
- DSLDSL playgroundUse the local and hosted Cuitty DSL playgrounds.
- DSLDSL migrationMigrate .ctest, Video YAML, and Pilot YAML into the unified Cuitty DSL.
Video
- VideoVideo quickstartCreate, preview, render, and inspect a Cuitty Video composition.
- VideoVideo referenceComposition model, SDK surfaces, DSL fields, and renderer options for Cuitty Video.
- VideoVideo CLICommands and options for the Cuitty Video command-line workflow.
- VideoVideo E2E visibilityRun local end-to-end video generation and inspect the inputs, IR, frames, FFmpeg logs, and output video.
SDK
- SDKTypeScript SDKThe @cuitty/sdk package — a fail-silent, batched HTTP client for TypeScript and Node.js applications.
- SDKPython SDKSend Cuitty events from Python — sync or async, with built-in batching and HMAC signing.
- SDKGo SDKSend Cuitty events from Go services with a context-aware client.
- SDKRust SDKSend Cuitty events from Rust with an async tokio-friendly client.
- SDKSDK Parity & DivergenceIntentional API differences across the four Cuitty SDKs.
- SDKcURL examplesSend Cuitty events from any shell with a single curl invocation.
- SDKProtocol overviewHow the wire protocol, SDKs, and ingest endpoint fit together.
Reference
Modules
- ModulesAudit moduleTamper-evident audit logging for every administrative action with before/after diffs.
- ModulesCosts moduleTrack cloud spend across GCP, AWS, Azure, and DigitalOcean with budgets and alerts.
- ModulesDeploys moduleTrack every deployment across environments with health checks and rollback metadata.
- ModulesLogs moduleAggregate structured logs from your services with search, filters, and tail.
- ModulesConfigs moduleConfiguration change tracking with diffs, attribution, and rollback hooks.
- ModulesRepository moduleGit metadata and code analysis events from GitHub, GitLab, and self-hosted repos.
- ModulesPerformance moduleRuntime process metrics — CPU, memory, event loop, and GC for instrumented services.
- ModulesTraces moduleDistributed tracing for OpenTelemetry-style spans, service maps, and request waterfalls.
- ModulesErrors moduleException capture, fingerprinting, grouping, and triage for Cuitty services.
- ModulesFeature Flags moduleControl-plane feature flags with groups, self-overrides, permissions, and SDK-side local evaluation.
- ModulesWebhooks moduleSigned outgoing webhook delivery with retries, secret rotation, and delivery history.
- ModulesTenants moduleProject and tenant administration for multi-tenant Cuitty installs.
- ModulesPlaintext Secrets modulePolyglot source code scanner that detects hardcoded secrets, API keys, and credentials across all your projects.
- ModulesVideo moduleBrowser-session recording jobs driven by natural-language prompts and explicit workflow steps.
Tests
Toolbar
Apps
- AppsAuth appIdentity, sessions, and authorization boundaries used by Cuitty apps.
- AppsPortal appThe browser UI for projects, modules, keys, and operational review.
- AppsAdmin appOperator-only maintenance flows for migrations, verification, and install health.
- AppsForge appWorkspace creation and repository setup flows for generated project ideas.
- AppsSite appPublic marketing and documentation surface for Cuitty.