---
title: "Reference"
description: "How the reference is organized: configuration, the Nuxt app surface, package entrypoints, the CLI, and the generated API reference."
canonical_url: "https://nuxt-backend.dev/docs/reference"
---
# Reference

> How the reference is organized: configuration, the Nuxt app surface, package entrypoints, the CLI, and the generated API reference.

The reference follows the shape of the package. Configuration covers the `backend` module options, runtime config and every environment variable, and the Nuxt app pages give full signatures for what the module registers in your app: composables and components, server utilities, the imperative client and the `#backend` import aliases. Entrypoints maps every `nuxt-backend/…` import path, Ecosystem says where each community package stands, and the CLI page lists every command, flag and `doctor` finding. The [API reference](https://nuxt-backend.dev/docs/reference/api) is generated from the package's TypeScript source and covers every public import path and auto-imported composable.

The hand-written pages below are grouped by the part of the package they describe: the package as a whole, its configuration, the Nuxt app and the CLI. The generated pages follow the exports map instead, with one page per TypeScript import path plus pages for the auto-imported composables.

## Package and ecosystem

<card-group>
<card icon="i-lucide-layers" title="Ecosystem" to="https://nuxt-backend.dev/docs/reference/ecosystem">

Which Nuxt modules, Convex components and agent tools the package ships, supports or leaves out, and why.

</card>

<card icon="i-lucide-package" title="Package Entrypoints" to="https://nuxt-backend.dev/docs/reference/entrypoints">

The exports map and the import tree: what you import explicitly, what the module auto-imports, and where each one runs.

</card>
</card-group>

## Configuration

<card-group>
<card icon="i-lucide-settings-2" title="Configuration" to="https://nuxt-backend.dev/docs/reference/configuration">

Where each setting lives: module options, environment variables, the app config.

</card>

<card icon="i-lucide-settings" title="Module options" to="https://nuxt-backend.dev/docs/reference/configuration/module-options">

Every `backend` option with its default, the runtime config, and the `ModuleOptions` interface.

</card>

<card icon="i-lucide-key-round" title="Environment variables" to="https://nuxt-backend.dev/docs/reference/configuration/environment-variables">

What `.env.local` holds, the variables the deployment declares, and how to set them.

</card>
</card-group>

## Nuxt app

<card-group>
<card icon="i-lucide-function-square" title="Composables" to="https://nuxt-backend.dev/docs/reference/nuxt/composables">

Full signatures for every composable the package registers, and the props, emits and slots of its components.

</card>

<card icon="i-lucide-terminal" title="Server Utilities" to="https://nuxt-backend.dev/docs/reference/nuxt/server-utilities">

The auto-imported Nitro helpers: fetch and preload, `backendAuth`, and the agent-tool utilities.

</card>

<card icon="i-lucide-plug-zap" title="Backend client" to="https://nuxt-backend.dev/docs/reference/nuxt/client">

The imperative client behind `useBackendClient()` and `$convex`, for one-off calls outside the composables.

</card>

<card icon="i-lucide-folder-symlink" title="Import Aliases" to="https://nuxt-backend.dev/docs/reference/nuxt/import-aliases">

The `#backend` aliases for your Convex functions directory and its generated files, in Vite and Nitro.

</card>
</card-group>

## Backend component

<card-group>
<card icon="i-lucide-box" title="Component API" to="https://nuxt-backend.dev/docs/reference/backend/component">

The functions `components.backend` exposes, module by module, and the helper that wraps each.

</card>

<card icon="i-lucide-octagon-alert" title="Errors" to="https://nuxt-backend.dev/docs/reference/backend/errors">

Every code the package refuses with, its fields, label and status.

</card>
</card-group>

## CLI

<card-group>
<card icon="i-lucide-square-terminal" title="CLI" to="https://nuxt-backend.dev/docs/reference/cli">

`init`, `dev`, `doctor`, `env push` and `billing sync`, with every flag and every `doctor` finding.

</card>
</card-group>

## API (generated)

<card-group>
<card icon="i-lucide-boxes" title="API reference" to="https://nuxt-backend.dev/docs/reference/api">

Generated TypeScript reference for every public import path and auto-imported composable.

</card>
</card-group>


## Sitemap

See the full [sitemap](https://nuxt-backend.dev/sitemap.md) for all pages.
