---
url: /docs/5.x/getting-started/introduction.md
description: >-
  Kubb is the meta framework for code generation. A plugin-based system that
  turns any API specification into TypeScript types, API clients, hooks,
  validators, and mocks.
---

# Introduction

Kubb is a meta framework for code generation. It runs a plugin-based pipeline on top of any API specification. An [adapter](/adapters) reads your spec. [Parsers](/parsers) turn the [AST](/docs/5.x/guide/concepts/ast) into source files. [Plugins](/plugins) generate the output. The pipeline writes, formats, and lints the result, all from a single config file.

The default adapter reads [OpenAPI](https://www.openapis.org/) 2.0, 3.0, and 3.1. From there Kubb generates TypeScript types, React Query hooks, Zod validators, MSW mocks, or a custom output. You stop hand-maintaining generated code, and the output is deterministic: the same spec always produces the same result.

## Features

* Generate [TypeScript types](/plugins/plugin-ts/), [React Query](/plugins/plugin-react-query/) and [Vue Query](/plugins/plugin-vue-query/) hooks, [SWR](/plugins/plugin-swr/) hooks, [Zod](/plugins/plugin-zod/) validators, [Faker](/plugins/plugin-faker/) mocks, and [MSW](/plugins/plugin-msw/) handlers, each from its own plugin.
* Generate a typed [Axios](/plugins/plugin-axios/) or [Fetch](/plugins/plugin-fetch/) client with status-keyed results, auth, validation, file uploads, [server-sent events](/plugins/plugin-fetch/guide/server-sent-events), [interceptors](/plugins/plugin-fetch/guide/interceptors), and a [swappable transport](/plugins/plugin-fetch/guide/transport).
* Read any OpenAPI 2.0, 3.0, or 3.1 spec through the [OpenAPI adapter](/adapters/adapter-oas/), or add your own [adapter](/docs/5.x/guide/concepts/adapters).
* Shape the output by grouping files by tag or path, including or excluding operations, and writing to disk, memory, or a [custom storage backend](/docs/5.x/guide/concepts/storage).
* Generate [Cypress](/plugins/plugin-cypress/) tests and a [Model Context Protocol server](/plugins/plugin-mcp/), or [write your own plugin](/docs/5.x/guide/going-further/creating-plugins).
* Run generation in [Vite](/docs/5.x/guide/integrations/vite), [Nuxt](/docs/5.x/guide/integrations/nuxt), and other bundlers with `unplugin-kubb`, or from [AI assistants](/docs/5.x/ai/mcp) and [Claude Code](/docs/5.x/ai/claude).

Read [Installation](./installation) and [Basic Usage](./basic-usage) next, then reach for [Configuration](/docs/5.x/reference/configuration), [Recipes](/docs/5.x/guide/recipes), and [Integrations](/docs/5.x/guide/integrations/) when you need them.

## See it work

Watch the pipeline drain a spec like a work queue. Every schema and operation is its own unit of work: the adapter turns each one into an AST node, and every plugin turns that node into its own file. The run below uses this config:

::: details Expand kubb.config.ts

```typescript twoslash [kubb.config.ts]
import { defineConfig } from 'kubb/config'
import { pluginTs } from '@kubb/plugin-ts'
import { pluginZod } from '@kubb/plugin-zod'

export default defineConfig({
  input: './petStore.yaml',
  output: { path: './src/gen' },
  plugins: [pluginTs(), pluginZod()],
})
```

:::

The [architecture guide](/docs/5.x/guide/concepts/architecture) covers each layer in depth.

Try the same loop yourself. Install Kubb together with the two plugins from that config:

```shell [Terminal]
npm install -D kubb @kubb/plugin-ts @kubb/plugin-zod
```

Write the config above next to your spec and run the generator:

```shell [Terminal]
kubb generate
```

Kubb writes one file per schema per plugin into `./src/gen`. Import a type and the editor knows your API:

```typescript
// @filename: src/gen/types/Pet.ts
export type Pet = { id: number; name: string }
// @filename: src/app.ts
// ---cut---
import type { Pet } from './gen/types/Pet'

const pet: Pet = { id: 1, name: 'Cat' }
```

That is the full cycle. Change the spec, run `kubb generate` again, and the types follow.

## Community

Join the [Discord server](https://discord.gg/shfBFeczrm), file an issue on [GitHub](https://github.com/kubb-labs/kubb/issues), or sponsor the project on [GitHub Sponsors](https://github.com/sponsors/stijnvanhulle) or [Open Collective](https://opencollective.com/kubb).