# Sproutboat

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

## Docs

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

## Bindings

- [Overview](https://sproutboat.com/docs/bindings): Every binding kind Sproutboat exposes on env, and how binding calls reach the broker.
- [Analytics Engine](https://sproutboat.com/docs/bindings/analytics-engine): Write event data points with env.NAME.writeDataPoint and read the latest back.
- [Cron](https://sproutboat.com/docs/bindings/cron): Scheduled triggers delivered to a scheduled(event) handler.
- [D1-compatible SQLite](https://sproutboat.com/docs/bindings/d1): A SQLite database bound to env.NAME, with the D1 prepared-statement API and online backups.
- [Durable Objects](https://sproutboat.com/docs/bindings/durable-objects): Per-id serialized state and alarms, backed by synchronous storage calls.
- [KV](https://sproutboat.com/docs/bindings/kv): A key-value store bound to env.NAME.
- [Outbound fetch](https://sproutboat.com/docs/bindings/outbound-fetch): fetch() reaches any public address, and never a private one.
- [Queues](https://sproutboat.com/docs/bindings/queues): Send messages with env.NAME.send, consume them with a queue handler.
- [R2-compatible object storage](https://sproutboat.com/docs/bindings/r2): Object storage bound to env.NAME, with the R2 binding API, multipart uploads and direct transfer URLs.
- [Rate limiting](https://sproutboat.com/docs/bindings/rate-limiting): A fixed-window limiter, counted per key per binding.
- [Secrets](https://sproutboat.com/docs/bindings/secrets): Values set with the CLI, never in sproutboat.jsonc, read as a plain string.
- [Service bindings](https://sproutboat.com/docs/bindings/service-bindings): Call another of your projects on the same server over loopback.
- [Static assets](https://sproutboat.com/docs/bindings/static-assets): Serve files from the edge, with your handler owning only the paths it wants.
- [Vars](https://sproutboat.com/docs/bindings/vars): Plain-string constants baked into the binary at build time.
- [Version metadata](https://sproutboat.com/docs/bindings/version-metadata): The running build's id, project name and build time, baked into the binary.

## Concepts

- [Architecture](https://sproutboat.com/docs/concepts/architecture): How the CLI builds a native sprout and how the platform routes requests, bindings, and triggers.
- [Generated types](https://sproutboat.com/docs/concepts/types): sproutboat types writes sproutboat-env.d.ts so env and the handler are fully typed.
- [How it works](https://sproutboat.com/docs/concepts/how-it-works): The build and deploy pipeline: from a JavaScript file to a running sprout behind Caddy.
- [Runtime compatibility](https://sproutboat.com/docs/concepts/compatibility): Which JavaScript APIs and npm packages have been tested in Sproutboat handlers.
- [sproutboat.jsonc](https://sproutboat.com/docs/concepts/configuration): The full configuration file: name, entry point, bindings, vars, secrets, triggers, and assets.
- [The handler](https://sproutboat.com/docs/concepts/handler): The fetch handler contract, and what JavaScript actually runs in production.

## Get Started

- [Quickstart](https://sproutboat.com/docs/get-started): Install the CLI, scaffold a project and deploy it.
- [Install the platform](https://sproutboat.com/docs/get-started/install): Run the installer on a Linux server to get the control plane, edge, dashboard and automatic TLS.
- [Get access](https://sproutboat.com/docs/get-started/access): How accounts, dashboard sign-in, CLI tokens, and headless agent access relate to each other.
- [Standalone binaries](https://sproutboat.com/docs/get-started/standalone): Run Sproutboat without a platform: one executable with its bindings compiled in.

## Platform

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

## Reference

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

## Storage

- [Storage resources](https://sproutboat.com/docs/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://sproutboat.com/docs/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://sproutboat.com/docs/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://sproutboat.com/docs/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://sproutboat.com/docs/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://sproutboat.com/docs/openapi.json.
- [API catalog](https://sproutboat.com/docs/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [agent-readability.json](https://sproutboat.com/docs/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://sproutboat.com/docs/sitemap.xml): Every indexable page URL with its last-modified date.