Skip to content
RelKit
Esc
↑↓navigate↵open⌘Jpreview

RelKit documentation

Build your first TypeScript API.

The TypeScript backend framework where you write the business logic. RelKit wires the APIs, jobs, events, agents and typed client, and gives you, and your coding agent, a live map of the app.

Create an application and send your first request. Continue with the same Orders application through persistence, authentication, testing, and production builds. New to RelKit? Read Why RelKit first.

From a new app to the cloud

  1. Create an app with bunx create-relkit (or npx create-relkit).
  2. Run it locally with relkit dev. The Inspector shows the live app.
  3. Write the deploy files with relkit deploy init railway. Use vercel or cloudflare instead to deploy to those platforms.
  4. Deploy with the generated workflow. The deployment overview compares the targets, and the metrics page shows how each release measures up.

Coding agents can work on the running app through relkit mcp, an MCP server that gives them the live graph, diagnostics and traces.

Find what you need

You’ll need basic TypeScript and Bun 1.3.10 or later for the first tutorial. Each later chapter names any additional requirements.

Already have an application?

Choose a module to configure, or a guide for the task you want to complete. For example, Buckets explains storage configuration, while Upload product images builds an HTTP upload endpoint.

The Inspector is an optional, separately installed tool. You can complete the tutorial and verify responses from your terminal.

For terminal workflows, start with the CLI module. It connects project creation, scaffolding, development, and production builds to the command reference.

Documentation and source

Examples come from maintained repository sources. API reference comes from TypeScript, and CLI reference comes from the command’s help model.

If a step doesn’t work, report the command and its diagnostic, together with your package versions and a small reproduction.