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

Installation

A zero-config edge runtime for typed jobs, queues, and cron — wired straight to your terminal. 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 @nullroute/core

Configuration

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

client.tstypescript
1import { createClient } from "@nullroute/core"
2 
3const client = createClient({
4 apiKey: process.env.API_KEY,
5 region: "us-east",
6 timeout: 5000,
7})
8 
9const { data } = await client.query("projects")

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 Nullroute.

Boot a worker

Spin up a typed worker, bind a queue, and tail its logs live — no Dockerfile, no YAML, just one declared handler.

Read guide

Schedule with cron

Pin any function to a cron expression. Runs are sandboxed per-region with deterministic retries and dead-letter capture.

Read guide

Stream the logs

Pipe structured run output back to your shell over a single socket. Filter by level, job id, or region in real time.

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

A zero-config edge runtime for typed jobs, queues, and cron — wired straight to your terminal.

DocsQuickstartGuidesAPI referenceExamples
ResourcesChangelogStatusRoadmapDiscord
CompanyBlogCareersSecurityContact
© 2026 Nullroute — an original demo built in the Terminal style for staqd. Not a real product. v2.4.0 · build 8fa2c3e · node 20.11