Documentation
How your application runs here, what it costs, and the handful of things that are different from a server you rent by the month.
For users
From your first project through services, workflows, hosted agents, updates, and billing.
Getting started · Backend services · Workflows · Hosted Agent · Apps and updates · Billing & limits
For developers
Deploying code, configuring runtime services, operating workflows, and giving coding agents the platform contract.
Getting started · Deploying · Backend services · Workflows · Operations · Application integrations
Search everything
- Configure an AI model providerFor users
Add an organization model credential, understand which coding harness runs, and rotate or revoke it safely.
- Work with Agent sandboxesFor users
Understand isolated workspaces, preview ports, disposable database branches, pushed changes, and cleanup.
- Distribute an Android appFor developers
Build an unsigned APK, let SproutOS protect the signing key, publish releases, and verify installs and updates.
- Backend servicesFor users
Create Postgres, Valkey, OpenSearch, or object storage as a standalone resource or attach it to a project.
- Background workers and open connectionsFor developers
Return after each batch so idle connections do not keep consuming compute.
- Understand billingFor users
Read service usage, credit, overhead, and queue residency without hidden rounding.
- Use the SproutOS CLIFor users
Install the latest production-approved CLI, sign in, create projects, configure services, and deploy.
- Install the coding-agent skillFor developers
Give Codex, Claude Code, or another repository agent the SproutOS CLI and platform operating contract.
- Connect to servicesFor developers
Use tenant-scoped credentials for Postgres, Valkey, search, and object storage.
- Run database migrationsFor developers
Run production migrations from GitHub Actions before deploying every project that depends on them.
- Deploy an applicationFor developers
Choose a build preset, publish a finished artifact, distinguish preview from production, and verify the release.
- Domains and rollbacksFor developers
Verify a generated hostname, activate a custom domain, and move production traffic to a known ready release.
- Configure environment variablesFor developers
Store secrets and public values in production, preview, development, or all targets without leaking them into source.
- Deploy from GitHub or your local agentFor developers
Use the same sprout deployment contract from GitHub Actions, a terminal, or a coding-agent harness.
- LimitsFor users
Function duration, request size, memory, and concurrency.
- Navigate SproutOSFor users
Where repositories, deployable projects, workflows, services, and usage live.
- Build a SproutOS OAuth applicationFor developers
Authorization Code with PKCE, optional database access, tokens, and revocation.
- Use object storageFor developers
Connect ordinary S3 SDKs to mutable application storage through the SproutOS storage proxy.
- Observe and troubleshoot applicationsFor developers
Use deployment states, runtime logs, request identifiers, workflow runs, and usage records to verify real behavior.
- Use OpenSearchFor users
Attach tenant-scoped search and keep index names, credentials, and application data isolated.
- Organizations and accessFor users
Understand the ownership boundary for projects, services, billing, credentials, and team permissions.
- Use PostgresFor users
Attach a tenant-scoped Postgres database, manage connection credentials, and create disposable branches.
- Projects and groupsFor users
Map one repository or monorepo to deployable projects, workflow workers, branches, and a primary domain.
- Start hereFor users
Create an organization, connect GitHub, deploy a project, attach a backend service, and verify the result.
- Build repository workflowsFor developers
Create a BullMQ TypeScript, BullMQ Rust, or Celery Python project for interval and webhook work.
- Runtimes and framework presetsFor developers
Choose a project runtime, understand deployment overrides, and prepare arm64-compatible artifacts.
- Install apps and receive upstream updatesFor users
Create a repository-backed copy from a reviewed listing, complete setup inputs, and review maintenance pull requests.
- Use Valkey and queuesFor users
Connect caches and BullMQ workers through the tenant proxy without leaving idle invocations running.
- Use the visual workflow editorFor users
Create a definition through the API, connect one trigger to actions and controls, save versions, and inspect runs.
- Choose a workflow modelFor users
Decide between a repository-backed BullMQ or Celery worker and a versioned visual workflow definition.