Documentation · 82 pages
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
- Install with DockerDeploy Cuitty on a single VM using Docker Compose. Recommended for solo developers and small teams.
- Install on KubernetesDeploy Cuitty to a Kubernetes cluster using the Helm chart, suitable for production workloads.
- Install on bare metalRun Cuitty as a single Bun binary on a Linux VM, with systemd-managed services for production durability.
- Install on cloud providersDeploy Cuitty on AWS, GCP, Azure, or Cuitty Cloud using infrastructure-as-code templates.
Code
- Cuitty Code AppsInstallable, permission-scoped apps for Cuitty Code.
- App ManifestReference for the .cuitty/app.toml manifest used by Cuitty Code Apps.
- App PermissionsHow Cuitty Code Apps request, receive, and use granular permissions.
- Code App MarketPublish, share, install, and manage Cuitty Code Apps.
- Authorization with SpiceDBRelationship-based authorization for Cuitty Code Apps and Registry.
- App execution with AirflowRun Cuitty Code Apps through Airflow DAGs and reconcile callbacks.
- Code RegistryUse Cuitty Code Registry for npm, Cargo, OCI, and PyPI packages.
- npm PackagesPublish npm packages safely with Cuitty Code Registry.
- Cargo CratesPublish Rust crates with Cuitty Code Registry.
- OCI and Docker ImagesPush and pull OCI artifacts through Cuitty Code Registry.
- PyPI PackagesUpload Python packages to Cuitty Code Registry.
- OrganizationsCreate organizations, invite members, and share Code Apps and packages.
- Slugs and ProfilesUser and organization slugs, follows, and markdown-customizable profile pages.
- Ownership TransferMove repositories, apps, registry namespaces, and packages between users and organizations.
- Self-Hosted RegistryRun Cuitty Code Registry and Code App Market on your own infrastructure.
- Code Apps and Registry operator runbookOperate Cuitty Code Apps, Registry, SpiceDB, and Airflow in self-hosted deployments.
Safe
- Safe QuickstartCreate a local Cuitty Safe, replace env values with references, and resolve them at runtime.
- Safe ReferencesThe canonical account/safe/secret model and accepted reference syntaxes for Cuitty Safe.
- Safe Storage ModesCompare local vaults, inline encrypted text, Persist-backed Safes, and 1Password pass-through.
- 1Password ConnectorUse 1Password as the source of truth while keeping Cuitty Safe references stable.
- Persist AdapterConfigure the alpha Cuitty Persist adapter for Safe records with mandatory E2EE guardrails.
- Safe CI/CDResolve Safe references in CI/CD jobs without leaking values into scripts, logs, or process metadata.
- Safe SDKThe @cuitty/safe package shape, client and server halves, and framework subpaths.
- Safe DesktopHow the planned Safe desktop app manages vaults, connector setup, reveal controls, and local audit review.
- Safe SecuritySecurity rules for references, encryption, redaction, audit metadata, connectors, and sharing stubs.
Pilot
- Pilot QuickstartRecord and replay your first provider dashboard workflow in five minutes.
- Playbook ReferenceComplete YAML schema for Cuitty Pilot playbooks — inputs, steps, actions, assertions, and captures.
- ExecutorsPilot executor reference — Browser, Terraform, Git, Persist, Shell, HTTP, and Composite.
- Pilot JavaScript SDKPilotClient for TypeScript and Node.js — run playbooks, manage runs, and stream events programmatically.
- Pilot React SDKReact hooks and components for Cuitty Pilot — manage playbooks, runs, and real-time events in React apps.
- Pilot SolidJS SDKSolidJS primitives and components for Cuitty Pilot — reactive playbook management, run control, and real-time event streaming.
- Pilot Rust SDKAsync Rust client for the Cuitty Pilot API — manage playbooks, runs, and providers with reqwest and serde.
- Pilot Go SDKGo client for the Cuitty Pilot API — manage playbooks, runs, and providers with idiomatic Go error handling.
- Pilot Python SDKAsync and sync Python clients for the Cuitty Pilot API — manage playbooks, runs, and providers with httpx.
DSL
Video
- Video quickstartCreate, preview, render, and inspect a Cuitty Video composition.
- Video referenceComposition model, SDK surfaces, DSL fields, and renderer options for Cuitty Video.
- Video CLICommands and options for the Cuitty Video command-line workflow.
- Video E2E visibilityRun local end-to-end video generation and inspect the inputs, IR, frames, FFmpeg logs, and output video.
SDK
- TypeScript SDKThe @cuitty/sdk package — a fail-silent, batched HTTP client for TypeScript and Node.js applications.
- Python SDKSend Cuitty events from Python — sync or async, with built-in batching and HMAC signing.
- Go SDKSend Cuitty events from Go services with a context-aware client.
- Rust SDKSend Cuitty events from Rust with an async tokio-friendly client.
- SDK Parity & DivergenceIntentional API differences across the four Cuitty SDKs.
- cURL examplesSend Cuitty events from any shell with a single curl invocation.
- Protocol overviewHow the wire protocol, SDKs, and ingest endpoint fit together.
Reference
Modules
- Audit moduleTamper-evident audit logging for every administrative action with before/after diffs.
- Costs moduleTrack cloud spend across GCP, AWS, Azure, and DigitalOcean with budgets and alerts.
- Deploys moduleTrack every deployment across environments with health checks and rollback metadata.
- Logs moduleAggregate structured logs from your services with search, filters, and tail.
- Configs moduleConfiguration change tracking with diffs, attribution, and rollback hooks.
- Repository moduleGit metadata and code analysis events from GitHub, GitLab, and self-hosted repos.
- Performance moduleRuntime process metrics — CPU, memory, event loop, and GC for instrumented services.
- Traces moduleDistributed tracing for OpenTelemetry-style spans, service maps, and request waterfalls.
- Errors moduleException capture, fingerprinting, grouping, and triage for Cuitty services.
- Feature Flags moduleControl-plane feature flags with groups, self-overrides, permissions, and SDK-side local evaluation.
- Webhooks moduleSigned outgoing webhook delivery with retries, secret rotation, and delivery history.
- Tenants moduleProject and tenant administration for multi-tenant Cuitty installs.
- Plaintext Secrets modulePolyglot source code scanner that detects hardcoded secrets, API keys, and credentials across all your projects.
- Video moduleBrowser-session recording jobs driven by natural-language prompts and explicit workflow steps.
Apps
- Auth appIdentity, sessions, and authorization boundaries used by Cuitty apps.
- Portal appThe browser UI for projects, modules, keys, and operational review.
- Admin appOperator-only maintenance flows for migrations, verification, and install health.
- Forge appWorkspace creation and repository setup flows for generated project ideas.
- Site appPublic marketing and documentation surface for Cuitty.
Store
- Store QuickstartInstall the Store SDK and create your first store in under a minute.
- Storage AdaptersConfigure SQLite, Postgres, S3, and P2P adapters for Store stores.
- Sync & Conflict ResolutionConfigure automatic sync strategies and conflict resolution for Store stores.
- End-to-End EncryptionEnable P2P encryption and zero-knowledge data protection in Store stores.