Reference
Look up RELKIT API signatures, types, errors, examples, and CLI commands generated from source.
Use this section when you know which API or command you need. Package pages contain signatures, types, source links, and checked examples. The CLI page comes from the same command model as terminal help.
Application configuration
- defineApp connects your environment, server settings, and providers in
relkit.config.ts. This is RELKIT’s current application configuration API;defineConfigis no longer exported. - defineEnv declares typed environment values. Use the env builders to select their types, defaults, and secret handling.
For a walkthrough, read Application configuration and Environment contracts.
API reference
Browse all public APIs and import paths, including React hooks, testing helpers, provider authoring, integration runtimes, and CLI automation. Each package has an All exported APIs table linking values, types, and aliases to their complete contracts.
Core packages
| Reference | Package | Common APIs |
|---|---|---|
| Application | @relkit/app |
defineApp |
| Configuration | @relkit/config |
defineEnv |
| Provider authoring | @relkit/provider |
See package reference |
| Local providers | @relkit/providers-local |
See package reference |
| Local history | @relkit/observability-local |
See package reference |
| CLI automation | @relkit/cli |
See package reference |
| Project generator | create-relkit |
See package reference |
| CLI launcher | relkit |
See package reference |
| Schema | @relkit/schema |
z, validate |
| Functions | @relkit/functions |
defineFunction, defineError |
| Services | @relkit/services |
defineService |
| Drizzle | @relkit/drizzle |
defineDrizzleService, defineModel, activateDrizzleService |
| Better Auth | @relkit/better-auth |
defineBetterAuthService |
| Routes | @relkit/routes |
defineRoute, defineMiddleware |
| Events | @relkit/events |
defineEvent, defineEventFunction |
| Jobs | @relkit/jobs |
defineTask, defineJob |
| Buckets | @relkit/buckets |
defineBucket |
| Cache | @relkit/cache |
defineCache |
| Tools | @relkit/tools |
defineTool |
| Agents | @relkit/agents |
approveApproval, denyApproval, defineAgent |
| Client | @relkit/client |
createClient |
| Realtime | @relkit/realtime |
defineChannel |
| Testing | @relkit/testing |
invokeFunction, createTestApplication |
| Standalone Inspector | @relkit/inspector |
See package reference |
Integrations
| Reference | Package | Common APIs |
|---|---|---|
| LangChain | @relkit/langchain |
See package reference |
| AWS | @relkit/aws |
aws |
| Integration catalog | @relkit/integrations |
See package reference |
| Cloudflare | @relkit/cloudflare |
See package reference |
| Docker | @relkit/docker |
docker |
| Local | @relkit/local |
localEvent, localJob |
| OTLP | @relkit/otlp |
See package reference |
| Pulumi | @relkit/pulumi |
See package reference |
| Redis | @relkit/redis |
See package reference |
| S3 | @relkit/s3 |
See package reference |
| Sentry | @relkit/sentry |
See package reference |
| Inngest | @relkit/inngest |
See package reference |
| Trigger.dev | @relkit/trigger |
See package reference |
| Effect MQ | @relkit/effect-mq |
See package reference |
CLI reference
Look up commands, arguments, options, and examples in the CLI reference.
New to the commands? Start with the CLI module and its create-to-build walkthrough.
For configuration and explanations, choose a module. For a complete workflow, choose a guide.