> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/vercel/workflow/llms.txt
> Use this file to discover all available pages before exploring further.

# @workflow/nuxt

> Nuxt module for Workflow DevKit

## Installation

```bash theme={null}
npm install @workflow/nuxt
```

## Usage

Add the workflow module to your Nuxt configuration:

```typescript nuxt.config.ts theme={null}
export default defineNuxtConfig({
  modules: ['@workflow/nuxt'],
});
```

## API

### Module Options

Configure the module via the `workflow` key in your Nuxt config:

```typescript nuxt.config.ts theme={null}
export default defineNuxtConfig({
  modules: ['@workflow/nuxt'],
  workflow: {
    typescriptPlugin: true,
  },
});
```

<ParamField path="workflow.typescriptPlugin" type="boolean">
  Enable TypeScript plugin for workflow.

  **Default:** `true`
</ParamField>

## Configuration Examples

### Basic Configuration

```typescript nuxt.config.ts theme={null}
export default defineNuxtConfig({
  modules: ['@workflow/nuxt'],
});
```

### Disable TypeScript Plugin

```typescript nuxt.config.ts theme={null}
export default defineNuxtConfig({
  modules: ['@workflow/nuxt'],
  workflow: {
    typescriptPlugin: false,
  },
});
```

## How It Works

The Nuxt module acts as a wrapper around the Nitro module (`@workflow/nitro`):

1. **Module Setup**: Adds `@workflow/nitro` to `nuxt.options.nitro.modules`
2. **Option Passthrough**: Forwards `typescriptPlugin` option to Nitro configuration
3. **Nitro Integration**: All workflow functionality is provided by the underlying Nitro module

Since Nuxt uses Nitro as its server engine, this module simply ensures the Nitro workflow module is properly configured.

## Module Configuration

The module is defined with:

* **Name**: `workflow`
* **Config Key**: `workflow`
* **Documentation**: [https://useworkflow.dev/installation/nuxt](https://useworkflow.dev/installation/nuxt)

## Nitro Integration

All workflow functionality comes from `@workflow/nitro`, including:

* Workflow discovery and building
* Route handler generation
* Development HMR
* Vercel deployment support

Refer to the [@workflow/nitro documentation](/api-reference/integrations/nitro) for details on:

* Additional options (via `nuxt.options.nitro.workflow`)
* Generated routes
* Build process
* Deployment

## Advanced Configuration

You can access Nitro-specific options directly:

```typescript nuxt.config.ts theme={null}
export default defineNuxtConfig({
  modules: ['@workflow/nuxt'],
  workflow: {
    typescriptPlugin: true,
  },
  nitro: {
    workflow: {
      dirs: ['server/workflows'],
      runtime: 'nodejs22.x',
    },
  },
});
```

Available Nitro workflow options:

* `dirs` - Directories to scan for workflows
* `typescriptPlugin` - Enable TypeScript plugin
* `runtime` - Node.js runtime version for Vercel

See [@workflow/nitro ModuleOptions](/api-reference/integrations/nitro#module-options) for full details.

## Generated Routes

The module inherits all routes from `@workflow/nitro`:

* `POST /.well-known/workflow/v1/flow`
* `POST /.well-known/workflow/v1/step`
* `POST /.well-known/workflow/v1/webhook/:token`
* `GET /.well-known/workflow/v1/manifest.json` (when `WORKFLOW_PUBLIC_MANIFEST=1`)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.