quickstart.md

Generate your first client

← JavaScript

Use Node.js 22 or newer and an OpenAPI document named openapi.yaml.

1. Install

npm install -D @relevate/poolster@alpha @relevate/poolster-plugin-typescript@alpha

2. Configure

Create poolster.config.mjs:

import { defineConfig } from '@relevate/poolster';
import { pluginTypeScript } from '@relevate/poolster-plugin-typescript';

export default defineConfig({
  name: 'Example API',
  version: '1.0.0',
  input: './openapi.yaml',
  output: './generated',
  plugins: [pluginTypeScript({ path: 'client', name: '@example/client' })],
});

3. Generate

Create generate.mjs:

import { generate, loadConfig } from '@relevate/poolster';

const result = await generate(await loadConfig('./poolster.config.mjs'));
console.log(result.changes);

node generate.mjs

The package appears in generated/client. Build it using its generated package.json, then import the compiled exports. Generated TypeScript compiles into JavaScript; your application can use either language.

Next: Add plugins or configure another package.

The optional poolster CLI is a separate npm package. This quickstart uses only the Node API and does not require the CLI.