---
title: Reference
description: Look up RELKIT API signatures, types, errors, examples, and CLI commands generated from source.
pagination: false
search:
  exclude: true
sidebar:
  icon: braces
---

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](/docs/api/app#defineapp) connects your environment, server settings, and providers in `relkit.config.ts`. This is RELKIT's current application configuration API; `defineConfig` is no longer exported.
- [defineEnv](/docs/api/config#defineenv) declares typed environment values. Use the [env builders](/docs/api/config#env) to select their types, defaults, and secret handling.

For a walkthrough, read [Application configuration](/docs/learn/concepts/application) and [Environment contracts](/docs/learn/concepts/environment).

## API reference

Browse [all public APIs and import paths](/docs/api/public), 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.

{/* Generated by apps/docs/scripts/generate.ts. Do not edit. */}

### Core packages

| Reference                                      | Package                       | Common APIs                                                                                                                                                                      |
| ---------------------------------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Application](/docs/api/app)                   | `@relkit/app`                 | [defineApp](/docs/api/app#defineapp)                                                                                                                                             |
| [Configuration](/docs/api/config)              | `@relkit/config`              | [defineEnv](/docs/api/config#defineenv)                                                                                                                                          |
| [Provider authoring](/docs/api/provider)       | `@relkit/provider`            | See package reference                                                                                                                                                            |
| [Local providers](/docs/api/providers-local)   | `@relkit/providers-local`     | See package reference                                                                                                                                                            |
| [Local history](/docs/api/observability-local) | `@relkit/observability-local` | See package reference                                                                                                                                                            |
| [CLI automation](/docs/api/cli-api)            | `@relkit/cli`                 | See package reference                                                                                                                                                            |
| [Project generator](/docs/api/create-relkit)   | `create-relkit`               | See package reference                                                                                                                                                            |
| [CLI launcher](/docs/api/relkit)               | `relkit`                      | See package reference                                                                                                                                                            |
| [Schema](/docs/api/schema)                     | `@relkit/schema`              | [z](/docs/api/schema#z), [validate](/docs/api/schema#validate)                                                                                                                   |
| [Functions](/docs/api/functions)               | `@relkit/functions`           | [defineFunction](/docs/api/functions#definefunction), [defineError](/docs/api/functions#defineerror)                                                                             |
| [Services](/docs/api/services)                 | `@relkit/services`            | [defineService](/docs/api/services#defineservice)                                                                                                                                |
| [Drizzle](/docs/api/drizzle)                   | `@relkit/drizzle`             | [defineDrizzleService](/docs/api/drizzle#definedrizzleservice), [defineModel](/docs/api/drizzle#definemodel), [activateDrizzleService](/docs/api/drizzle#activatedrizzleservice) |
| [Better Auth](/docs/api/better-auth)           | `@relkit/better-auth`         | [defineBetterAuthService](/docs/api/better-auth#definebetterauthservice)                                                                                                         |
| [Routes](/docs/api/routes)                     | `@relkit/routes`              | [defineRoute](/docs/api/routes#defineroute), [defineMiddleware](/docs/api/routes#definemiddleware)                                                                               |
| [Events](/docs/api/events)                     | `@relkit/events`              | [defineEvent](/docs/api/events#defineevent), [defineEventFunction](/docs/api/events#defineeventfunction)                                                                         |
| [Jobs](/docs/api/jobs)                         | `@relkit/jobs`                | [defineTask](/docs/api/jobs#definetask), [defineJob](/docs/api/jobs#definejob)                                                                                                   |
| [Buckets](/docs/api/buckets)                   | `@relkit/buckets`             | [defineBucket](/docs/api/buckets#definebucket)                                                                                                                                   |
| [Cache](/docs/api/cache)                       | `@relkit/cache`               | [defineCache](/docs/api/cache#definecache)                                                                                                                                       |
| [Tools](/docs/api/tools)                       | `@relkit/tools`               | [defineTool](/docs/api/tools#definetool)                                                                                                                                         |
| [Agents](/docs/api/agents)                     | `@relkit/agents`              | [approveApproval](/docs/api/agents#approveapproval), [denyApproval](/docs/api/agents#denyapproval), [defineAgent](/docs/api/agents#defineagent)                                  |
| [Client](/docs/api/client)                     | `@relkit/client`              | [createClient](/docs/api/client#createclient)                                                                                                                                    |
| [Realtime](/docs/api/realtime)                 | `@relkit/realtime`            | [defineChannel](/docs/api/realtime#definechannel)                                                                                                                                |
| [Testing](/docs/api/testing)                   | `@relkit/testing`             | [invokeFunction](/docs/api/testing#invokefunction), [createTestApplication](/docs/api/testing#createtestapplication)                                                             |
| [Standalone Inspector](/docs/api/inspector)    | `@relkit/inspector`           | See package reference                                                                                                                                                            |

### Integrations

| Reference                                             | Package                | Common APIs                                                                                              |
| ----------------------------------------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------- |
| [LangChain](/docs/api/integrations/langchain)         | `@relkit/langchain`    | See package reference                                                                                    |
| [AWS](/docs/api/integrations/aws)                     | `@relkit/aws`          | [aws](/docs/api/integrations/aws#aws)                                                                    |
| [Integration catalog](/docs/api/integrations/catalog) | `@relkit/integrations` | See package reference                                                                                    |
| [Cloudflare](/docs/api/integrations/cloudflare)       | `@relkit/cloudflare`   | See package reference                                                                                    |
| [Docker](/docs/api/integrations/docker)               | `@relkit/docker`       | [docker](/docs/api/integrations/docker#docker)                                                           |
| [Local](/docs/api/integrations/local)                 | `@relkit/local`        | [localEvent](/docs/api/integrations/local#localevent), [localJob](/docs/api/integrations/local#localjob) |
| [OTLP](/docs/api/integrations/otlp)                   | `@relkit/otlp`         | See package reference                                                                                    |
| [Pulumi](/docs/api/integrations/pulumi)               | `@relkit/pulumi`       | See package reference                                                                                    |
| [Redis](/docs/api/integrations/redis)                 | `@relkit/redis`        | See package reference                                                                                    |
| [S3](/docs/api/integrations/s3)                       | `@relkit/s3`           | See package reference                                                                                    |
| [Sentry](/docs/api/integrations/sentry)               | `@relkit/sentry`       | See package reference                                                                                    |
| [Inngest](/docs/api/integrations/inngest)             | `@relkit/inngest`      | See package reference                                                                                    |
| [Trigger.dev](/docs/api/integrations/trigger)         | `@relkit/trigger`      | See package reference                                                                                    |
| [Effect MQ](/docs/api/integrations/effect-mq)         | `@relkit/effect-mq`    | See package reference                                                                                    |

## CLI reference

Look up commands, arguments, options, and examples in the [CLI reference](/docs/api/cli).

New to the commands? Start with the [CLI module](/docs/modules/cli) and its [create-to-build walkthrough](/guides/cli/create-and-build-an-api).

For configuration and explanations, choose a [module](/docs/modules). For a complete workflow, choose a [guide](/guides).
