SproutOS
← Documentation

For users

From your first project through services, workflows, hosted agents, updates, and billing.

Getting started

  • Start here

    Create an organization, connect GitHub, deploy a project, attach a backend service, and verify the result.

  • Navigate SproutOS

    Where repositories, deployable projects, workflows, services, and usage live.

  • Use the SproutOS CLI

    Install the latest production-approved CLI, sign in, create projects, configure services, and deploy.

  • Organizations and access

    Understand the ownership boundary for projects, services, billing, credentials, and team permissions.

  • Projects and groups

    Map one repository or monorepo to deployable projects, workflow workers, branches, and a primary domain.

Backend services

  • Backend services

    Create Postgres, Valkey, OpenSearch, or object storage as a standalone resource or attach it to a project.

  • Use Postgres

    Attach a tenant-scoped Postgres database, manage connection credentials, and create disposable branches.

  • Use Valkey and queues

    Connect caches and BullMQ workers through the tenant proxy without leaving idle invocations running.

  • Use OpenSearch

    Attach tenant-scoped search and keep index names, credentials, and application data isolated.

Workflows

  • Choose a workflow model

    Decide between a repository-backed BullMQ or Celery worker and a versioned visual workflow definition.

  • Use the visual workflow editor

    Create a definition through the API, connect one trigger to actions and controls, save versions, and inspect runs.

Hosted Agent

Apps and updates

Billing & limits

  • Understand billing

    Read service usage, credit, overhead, and queue residency without hidden rounding.

  • Limits

    Function duration, request size, memory, and concurrency.