Sproutdocs
Search the docs…⌘K
v2.4 12.3k
DocsGetting startedInstallation

Installation

The one-file backend you ship on a weekend and bill for on Monday. Install the client, configure a single object, and start making fully-typed requests. Everything below is copy-paste ready — no scaffolding required.

Requires Node 18+

The runtime ships native ESM and the Fetch API. For older environments, pull in a polyfill before importing the client.

npmpnpmyarnbun
terminalbash
1$ npm install @sprout/core

Configuration

Create a client once and reuse it across your app. The configuration object is fully typed; your editor will autocomplete every field.

sprout.config.tstypescript
1import { sprout, meter } from "@sprout/core"
2 
3export default sprout({
4 db: "sqlite",
5 auth: ["email", "github"],
6 bill: meter({ per: "request", cents: 2 }),
7})

Parameters

NameTypeDefaultDescription
apiKeystringSecret key used to authenticate every request.
region"us-east" | "eu""us-east"Edge region the client routes traffic through.
timeoutnumber10000Per-request timeout in milliseconds.
retriesnumber2Automatic retry count for idempotent calls.
cachebooleantrueEnable the in-memory response cache.

Response shape

Every successful call resolves to a discriminated union you can narrow safely:

response.jsonjson
1{
2 "ok": true,
3 "count": 3,
4 "data": [
5 { "id": "prj_8fa2", "name": "Atlas" }
6 ]
7}
Keep going

Guides

Hand-written walkthroughs for the most common things you’ll build with Sprout.

Ship in an afternoon

Scaffold auth, a typed database, and billing from a single config. Skip the boilerplate and get to the part you actually want to build.

Read guide

Money from day one

Wire Stripe to a usage meter in three lines. Every endpoint can charge, throttle, or gate on plan without a billing service to babysit.

Read guide

Stay in the green

Built-in metrics for latency, error rate, and revenue per route. Watch the numbers move the moment you push, no dashboard wiring required.

Read guide
sprout — zsh
$sprout init my-app
✓ scaffolding project
✓ installing dependencies
ready · http://localhost:3000
$sprout deploy --prod
› building 4 routes
deployed in 8.2s → atlas.app
$
Sprout

The one-file backend you ship on a weekend and bill for on Monday.

DocsQuickstartGuidesAPI referenceExamples
ResourcesChangelogStatusRoadmapDiscord
CompanyBlogCareersSecurityContact
© 2026 Sprout — an original demo built in the Hatch style for staqd. Ship it. v2.4.0 · build 8fa2c3e · node 20.11