# Sproutboat

> Build and deploy Sproutboat apps: CLI reference, config, bindings, and platform limits.

## Docs

- [Overview](https://docs.sproutboat.com/): Sproutboat turns one JavaScript fetch handler into a static native binary you deploy and run yourself.

## Bindings

- [Overview](https://docs.sproutboat.com/bindings): Every binding kind Sproutboat exposes on env, and how binding calls reach the broker.
- [Cron](https://docs.sproutboat.com/bindings/cron): Scheduled triggers, run on timers in-process and delivered to a scheduled(event) handler.
- [D1 (SQLite)](https://docs.sproutboat.com/bindings/d1): A per-project SQLite database bound to env.NAME, with prepared statements and online backups.
- [Durable Objects](https://docs.sproutboat.com/bindings/durable-objects): Per-id serialized state and alarms, backed by synchronous storage calls.
- [KV](https://docs.sproutboat.com/bindings/kv): A key-value store bound to env.NAME, backed by a single SQLite table.
- [Outbound fetch](https://docs.sproutboat.com/bindings/outbound-fetch): fetch() only reaches hosts explicitly listed in the outbound allowlist.
- [Queues](https://docs.sproutboat.com/bindings/queues): Send messages with env.NAME.send, consume them with a queue handler.
- [R2 (object storage)](https://docs.sproutboat.com/bindings/r2): Object storage bound to env.NAME. Bytes live in their own file, never inline in a database row.
- [Rate limiting](https://docs.sproutboat.com/bindings/rate-limiting): A fixed-window limiter, counted per key per binding, on one node.
- [Secrets](https://docs.sproutboat.com/bindings/secrets): Values set out of band with the CLI, never in sproutboat.jsonc, read as a plain string.
- [Service bindings](https://docs.sproutboat.com/bindings/service-bindings): Call another deployment on the same node over loopback, without going over the public internet.
- [Static assets](https://docs.sproutboat.com/bindings/static-assets): Serve files from the edge, with your handler owning only the paths it wants.
- [Vars](https://docs.sproutboat.com/bindings/vars): Plain-string constants baked into the binary at build time.

## Concepts

- [Generated types](https://docs.sproutboat.com/concepts/types): sproutboat types writes sproutboat-env.d.ts so env and the handler are fully typed.
- [How it works](https://docs.sproutboat.com/concepts/how-it-works): The build and deploy pipeline: from a JavaScript file to a running sprout behind Caddy.
- [sproutboat.jsonc](https://docs.sproutboat.com/concepts/configuration): The full configuration file: name, entry point, bindings, vars, secrets, triggers, and assets.
- [The handler](https://docs.sproutboat.com/concepts/handler): The fetch handler contract, and what JavaScript actually runs in production.

## Get Started

- [Quickstart](https://docs.sproutboat.com/get-started): Go from nothing to a deployed Sproutboat app in four commands.
- [Get access](https://docs.sproutboat.com/get-started/access): How accounts, dashboard sign-in, CLI tokens, and headless agent access relate to each other.
- [Standalone binaries](https://docs.sproutboat.com/get-started/standalone): Run Sproutboat without a control plane: one executable, its own bindings, no broker required.

## Platform

- [Custom domains](https://docs.sproutboat.com/platform/custom-domains): Attach your own hostname to a deployment: the DNS records, verification, and TLS issuance.
- [Deploy lifecycle](https://docs.sproutboat.com/platform/deploy-lifecycle): Versions, no-op detection, and how to watch a running sprout.
- [Errors](https://docs.sproutboat.com/platform/errors): Common CLI and build error messages, their cause, and the fix.
- [Limits](https://docs.sproutboat.com/platform/limits): Capability profile, concurrency, upload caps, request/response body sizes, and account quotas.

## Reference

- [CLI reference](https://docs.sproutboat.com/reference/cli): Every sproutboat command, grouped by task, plus every environment variable it reads.

## Storage

- [Storage resources](https://docs.sproutboat.com/storage): How KV, D1, R2, and queue stores get their stable ids, and the three ways to attach one.
- [Manage and export KV data](https://docs.sproutboat.com/storage/manage-kv-data): List, inspect, and bulk-edit KV entries from the CLI, plus a restorable export format.

## Agent resources

- [llms-full.txt](https://docs.sproutboat.com/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://docs.sproutboat.com/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://docs.sproutboat.com/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://docs.sproutboat.com/openapi.json.
- [API catalog](https://docs.sproutboat.com/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [agent-readability.json](https://docs.sproutboat.com/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://docs.sproutboat.com/sitemap.xml): Every indexable page URL with its last-modified date.