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 a project with the supported bootstrap command:
bunx create-relkit@latest my-app
cd my-app
bun run devRun the CLI directly through its unscoped npm package:
bunx relkit --help
bunx relkit@latest create my-apprelkit delegates to the same release of @relkit/cli, which remains the CLI
dependency in generated applications.
For an existing Bun project, install the primary authoring API:
bun add @relkit/appApplication code can import the root API or focused typed paths:
relkit/schemarelkit/configrelkit/routesrelkit/functionsrelkit/eventsrelkit/agentsrelkit/jobsrelkit/cacherelkit/toolsrelkit/bucketsrelkit/services
Optional integrations such as @relkit/client, @relkit/drizzle,
@relkit/better-auth, @relkit/langchain, providers, testing, the Inspector and CLI remain separate so the
core API does not install the full AWS, Pulumi, Next.js, or testing stack.
Follow the selected capability's installation guide
before copying source. Native SDKs and declaration repairs remain application-owned;
relkit add normally installs the requirements it selects, while --no-install
leaves explicit install/check next steps. All RelKit packages share one version.
Install the application skill and deployment skill in an application repository with the Skills CLI:
npx skills add rel-kit/relkit --skill relkit-app relkit-deployThe application skill covers RelKit code placement, public APIs, and verification.
The deployment skill covers AWS/Pulumi checks, preview, apply, and post-deploy
verification. Both skills are also available directly in this repository under
.agents/skills/.
Coding agents can read the documentation index or the full documentation as one file.
RelKit is pre-1.0. Every feature is Core or Labs: Core and Labs
lists which, and Labs can change in any release. From 1.0, Core follows semantic versioning.
Versioning and upgrades states the deprecation window, how
relkit migrate carries you across breaking changes, the 1.0 criteria and the target date.
The repository requires Bun 1.3.10.
bun install --frozen-lockfile
bun run typecheck
bun run check
bun run verifyThe root package scripts cover focused type, package, integration-package, unit, compiler, contract, integration, restart, inspector, generator, deployment, container, security, and browser layers. Run the local fail-fast sequence with:
bun run test:alltest:all skips cloud mutation by default. Set
RELKIT_TEST_ALL_CLOUD=1, RELKIT_AWS_INTEGRATION_REGION, and
RELKIT_AWS_INTEGRATION_IMAGE only when an AWS acceptance run is explicitly
authorized. bun run test:local-docker runs the Redis/MinIO lifecycle acceptance
against a local Docker daemon. bun run build builds the workspace and bun run verify checks package tests, boundaries, scope, declarations, generated
artifacts, and release invariants.
For fast local checks before pushing:
bun run prepushIt mirrors the focused merge-blocking CI gate. For complete local acceptance,
run bun run prepush:full with Docker available; it runs verify followed by
container, Redis/MinIO, local deployment, Inspector browser, and end-to-end
checks. Real AWS acceptance is opt-in locally and is not run by GitHub Actions.
To exercise the current checkout without publishing packages, use the local
launcher. It quietly syncs framework packages, links the generated project's
@relkit/* dependencies to this checkout, and restarts local development after
successful framework changes:
bun run relkit:local -- create my-app --cloud none --deploy noneapps/docsis the searchable Blume/Astro documentation application on port3001.apps/inspectoris the private Next.js UI packaged by the independently installed@relkit/inspectortool, whose UI defaults to port3210.examples/commerceis the canonical executable, cross-feature example.integrations/packagescontains independently publishable standalone integrations; the creator bundles their catalog.packages/contains the public authoring APIs, compiler, graph, engine, runtime, inspector API, providers, CLI, generator, and Pulumi deployment packages.templates/default/v1contains theminimal,api,agent,fullstackandtasksproject templates.tests/andscripts/contain the focused test layers and verification tooling.
Run bunx turbo run dev --filter=@relkit/docs for documentation development and
bun run test:docs for generated-reference, doctest, link, and search checks.
Create a cloud-free application:
bunx create-relkit@latest my-app
cd my-app
bun run devCloud and deployment both default to none. bun run dev starts the generated
backend on http://localhost:3000; source saves keep the last-known-good backend active.
Inspection is disabled unless the application selects inspector: { enabled: true }.
That selection starts an authenticated development bridge on 127.0.0.1 with an
automatically allocated port. Install and run @relkit/inspector separately for
the UI and persistent local history. See the standalone launch guide
for runtime requirements, current candidate availability and separate process commands.
The example route is:
curl http://localhost:3000/hello\?name=RelKitCI has not tested creation with --cloud aws --deploy pulumi yet, so it prints a
RELKIT_CREATE_UNTESTED warning and continues; pass --strict to refuse untested combinations.
Deployment is described in docs/deployment.md and still requires explicit authorization.
Useful generated commands are bun run test, bun run check, bun run typecheck, bun run build, and bun run start after a build. Stop a dev or
start process with Ctrl-C. Generated graph, manifest, build, state, and
observability files live under .relkit/ and should not be edited by hand.
AWS deployment uses Pulumi as its engine and requires explicit credentials and
authorization; local deployment tests use mocks. Production internal runtime
endpoints are disabled unless RELKIT_INTERNAL_ENDPOINTS=1 is set. Rich Inspector
registration is excluded from production even when inspection was selected for
development. The CLI owns no Inspector UI, history database or database worker.
All RelKit packages share one version, and each release is tagged with it. Repository pull
requests that change publishable paths receive an automatic patch Changeset;
forks and minor or major releases use bun run changeset. Automation opens the
release pull request, auto-merges it after CI Gate, and publishes through a
separate GitHub release workflow using npm trusted publishing. Documentation
and internal chores outside release paths merge without a release.
relkit, create-relkit, and the explicitly documented optional
integrations are supported public entry points. Packages described as
unsupported internals are published only so workspace dependencies remain
resolvable; application code should not depend on them directly.
See CONTRIBUTING.md, SECURITY.md, and the MIT license.