Openapi Sync Mcp

[NPM Version] [License] [Tests]

OpenAPI Sync

OpenAPI Sync is a powerful developer tool that automates the synchronization of your API documentation with your codebase using OpenAPI (formerly Swagger) specifications. It generates TypeScript types, fully-typed API clients (Fetch, Next.js Fetch, Axios, React Query, SWR, RTK Query), endpoint definitions, runtime validation schemas (Zod, Yup, Joi), and comprehensive documentation from your OpenAPI schema—ensuring type safety from API specification through client implementation to runtime validation.

📘 Full documentation available at openapi-sync.com

Core Features

• ⚡ Zero-Config Presets - 10 pre-configured framework presets (React Query, SWR, Axios, Fetch, RTK Query, Next.js, Python) for instant setup
• 🔄 Real-time API Synchronization - Automatically syncs OpenAPI specs from remote URLs with configurable intervals
• 📝 Automatic Type Generation - Generates TypeScript interfaces for all endpoints with full nested support
• 🔐 Runtime Validation - Generate Zod, Yup, or Joi schemas from OpenAPI specs with all constraints preserved
• 🎯 Interactive Setup Wizard - Streamlined configuration with auto-enabled tag-based folder splitting
• 🛡️ Enterprise Ready - Error handling, validation, state persistence, and custom code preservation
• 📦 Folder Splitting - Organize code by tags or custom logic with aggregator files for easy imports
• 📚 Rich Documentation - JSDoc comments with cURL examples and inline usage guides
• 🤖 Agent-Ready Endpoints - Browse endpoints with pagination and path filtering, inspect deep endpoint details, and read generated types without reloading the spec
• 🩺 Diagnostic Doctor - Diagnostic health checks for config validity, spec accessibility, peer dependencies, cache, and folder write permissions
• 🧹 Stale File Purge - Manifest-based stale code detection and cleanup with dry-run support to prevent orphaned code
• 🔄 Custom Code Injection - Preserve your custom code between regenerations with protected sections

View all features →

Installation

npm install openapi-sync# ornpm install -g openapi-sync# or use directlynpx openapi-sync

⚠️ macOS Big Sur Users: If you encounter an esbuild error (Symbol not found: _SecTrustCopyCertificateChain), install [email protected] first. See Troubleshooting for details.

🤖 Using with AI Agents

All CLI commands and programmatic APIs are agent-safe — no interactive prompts, fully non-blocking. Use --json for machine-readable output and --silent to suppress logs.

Full agent reference: llms.txt — a structured discovery file for LLMs, Copilots, and MCP tools.

Agent Quick-Start (no prompts)

# 1. Create config (all settings as flags — no stdin required)npx openapi-sync init --no-interactive \  --api-name petstore \  --api-url https://petstore3.swagger.io/api/v3/openapi.json \  --output-folder ./src/api \  --client-type react-query \  --validation-library zod \  --config-format typescript \  --json
# Or for protected specs, configure auth directly on init:npx openapi-sync init --no-interactive \  --api-name backend \  --api-url https://api.example.com/openapi.json \  --auth-type bearer \  --auth-token '${env.SPEC_TOKEN}' \  --preset react-query-zod \  --json
# 2. Validate config + specs before writing any filesnpx openapi-sync validate --json
# 3. Sync — generate types, endpoints, and schemasnpx openapi-sync --json
# 4. Generate a typed API clientnpx openapi-sync generate-client --type react-query --json

Machine-Readable Output (--json)

Every command emits a single, pure JSON object to stdout when --json is passed, making it safe to pipe directly into jq or consume from automated agents. All human-readable progress logs are suppressed or directed to stderr.

$ npx openapi-sync --json{  "success": true,  "apis": ["petstore"],  "filesWritten": ["src/api/petstore/types.ts", "src/api/petstore/endpoints.ts"],  "endpointCount": 20,  "warnings": [],  "errors": [],  "phases": {    "sync": { "filesWritten": ["src/api/petstore/types.ts", "src/api/petstore/endpoints.ts"], "endpointCount": 20 },    "client": { "filesWritten": [], "endpointCount": 20 }  }}

$ npx openapi-sync validate --json{  "valid": true,  "apis": { "petstore": { "valid": true, "endpointCount": 20 } },  "configErrors": []}

$ npx openapi-sync list-endpoints --json{  "petstore": [    { "name": "getPetById", "method": "GET", "path": "/pet/{petId}", "tags": ["pet"], "summary": "Find pet by ID" },    { "name": "addPet", "method": "POST", "path": "/pet", "tags": ["pet"], "summary": "Add a new pet" }  ]}

$ npx openapi-sync list-endpoints --api petstore --path-contains pet --limit 2 --offset 0 --json

$ npx openapi-sync get-endpoint --api petstore --operation-id getPetById --json

$ npx openapi-sync read-type --api petstore --type-name Pet --json

Dry Run (preview without writing files)

Compact, fast previews of planned files:

npx openapi-sync --dry-run --jsonnpx openapi-sync generate-client --type fetch --dry-run --json

Layouts & Output Directories

• Flat Mode (Default): When folderSplit is omitted or empty ({}), files are placed directly in the API folder (endpoints.ts, types/index.ts, types/shared.ts).
• Tag-Split Mode: Setting folderSplit: { byTags: true } organizes endpoints into tag subfolders (e.g. {tag}/endpoints.ts, {tag}/types.ts, shared.ts).
• Custom Client Directory: clientGeneration.outputDir (or CLI --output) is fully supported in both flat and folder-split layouts. In flat mode, clients are placed directly in {outputDir}/clients.ts (or api.ts), while in folder-split mode clients are placed in {outputDir}/{tag}/client.ts and aggregated at {outputDir}/clients.ts, with relative imports resolving back to your generated types and endpoints.

Programmatic API (TypeScript)

import {  ValidateConfig,  Init,  GenerateClient,  ListEndpoints,  GetEndpointDetails,  ReadGeneratedType,  Doctor,  Purge,} from "openapi-sync";
// Pre-flight check — no files writtenconst validation = await ValidateConfig({ silent: true });if (!validation.valid) throw new Error(JSON.stringify(validation));
// Diagnostic health check on config, specs, peer dependencies, and directoriesconst health = await Doctor({ silent: true });console.log("Health check:", health.healthy ? "All checks passed" : "Issues detected");
// Inspect API surface with pagination and filteringconst endpoints = await ListEndpoints({  apiName: "petstore",  pathContains: "pet",  limit: 5,  offset: 0,  silent: true,});console.log(endpoints.petstore.length, "endpoints found");
// Inspect a single endpoint in full detail (4-tier fuzzy matching)const detail = await GetEndpointDetails({ apiName: "petstore", operationId: "getPetById", silent: true });console.log(detail.endpoint.path);
// Read an exact generated type declaration (with optional line pagination)const typeDecl = await ReadGeneratedType({ apiName: "petstore", typeName: "Pet", silent: true });console.log(typeDecl);
// Sync and get structured resultconst syncResult = await Init({ silent: true });if (!syncResult.success) throw new Error(JSON.stringify(syncResult));console.log("Files written:", syncResult.filesWritten);
// Generate clientconst clientResult = await GenerateClient({ type: "react-query", silent: true });console.log(JSON.stringify(clientResult));
// Detect and purge stale files from diskconst purgeResult = await Purge({ yes: true, silent: true });console.log("Purged files:", purgeResult.purged);

Exit Codes

Agent-safe vs Interactive Commands

Quick Start

Option 1: Interactive Setup (Recommended) 🎯

The easiest way to get started is with the interactive setup wizard:

npx openapi-sync init

The wizard will guide you through:

• 📝 Configuration file format selection (TypeScript, JSON, or JavaScript)
• 🌐 API specification source (URL or local file)
• 📁 Folder organization options (split by tags or custom logic)
• 🚀 Client generation options (React Query, SWR, Fetch, Axios, RTK Query)
• ✅ Validation library setup (Zod, Yup, Joi)
• 🔧 Custom code preservation settings
• 🏷️ Type naming preferences (operationId usage, prefix)
• 🚫 Endpoint filtering (exclude by tags)
• 📚 Documentation options (cURL examples)

Option 2: Manual Setup

1. Create openapi.sync.json in your project root:

{	"refetchInterval": 5000,	"folder": "./src/api",	"api": {		"petstore": "https://petstore3.swagger.io/api/v3/openapi.json"	}}

2. Run the sync command:

npx openapi-sync

3. Use generated types and endpoints:

import { getPetById } from "./src/api/petstore/endpoints";import { IPet } from "./src/api/petstore/types";
const petUrl = getPetById("123"); // Returns: "/pet/123"

View detailed quick start guide →

⚡ Presets (Zero-Config Framework Setup)

Presets bundle opinionated defaults for your framework, client library, and validation stack into a single name. Instead of configuring dozens of settings by hand, pick a preset during npx openapi-sync init or set "preset": "<name>" in your config file. Any explicit configuration values you define always override preset defaults.

Using a Preset

In the CLI Setup Wizard:

npx openapi-sync init# Select your preset from the interactive menu with rich descriptions

Non-Interactive / CI:

npx openapi-sync init --preset react-query-zod --api-name petstore --api-url https://petstore3.swagger.io/api/v3/openapi.json

In JSON (openapi.sync.json):

{  "$schema": "./node_modules/openapi-sync/openapi.sync.schema.json",  "preset": "react-query-zod",  "api": {    "petstore": "https://petstore3.swagger.io/api/v3/openapi.json"  }}

In TypeScript (openapi.sync.ts):

import { defineConfig } from "openapi-sync";
export default defineConfig({  preset: "react-query-zod",  api: {    petstore: "https://petstore3.swagger.io/api/v3/openapi.json",  },  // User values cleanly override preset defaults:  folder: "./src/api",});

View presets guide on website →

API Client Generation

Generate fully-typed API clients with hooks for popular libraries:

Generate Fetch Client

npx openapi-sync generate-client --type fetch

Generate Axios Client

npx openapi-sync generate-client --type axios

Generate React Query Hooks

npx openapi-sync generate-client --type react-query --api petstore

Generate SWR Hooks

npx openapi-sync generate-client --type swr

Generate RTK Query API

npx openapi-sync generate-client --type rtk-query

Generate Next.js Fetch Client (App Router & Server Components)

npx openapi-sync generate-client --type next-fetch# Or use --preset next-fetch during init / sync

Usage in Next.js App Router (Server Components):

// app/pets/[id]/page.tsx (Server Component — no React hooks needed)import { getPetById, setApiConfig } from "@/api/petstore/clients";
// Set baseURL at runtime or via environment variablessetApiConfig({ baseURL: process.env.API_BASE_URL || "https://api.example.com" });
export default async function PetPage({ params }: { params: { id: string } }) {  // Built-in Next.js App Router cache and tag-based revalidation  const pet = await getPetById(    { url: { petId: params.id } },    {      cache: "force-cache",      next: { revalidate: 3600, tags: ["pets"] },    }  );
  return <div><h1>{pet.name}</h1></div>;}

Filter by Tags or Endpoints

# Filter by tagsnpx openapi-sync generate-client --type fetch --tags pets,users
# Filter by specific endpointsnpx openapi-sync generate-client --type axios --endpoints getPetById,createPet

Usage Example (React Query)

1. Generate the client:

npx openapi-sync generate-client --type react-query

2. Use in your React components:

import { QueryClient, QueryClientProvider } from "@tanstack/react-query";import { useGetPetById, useCreatePet } from "./api/petstore/client/hooks";import apiClient from "./api/petstore/client/client";
// Configure API clientapiClient.updateConfig({  baseURL: "https://api.example.com",  headers: {    Authorization: "Bearer your-auth-token",  },});
function PetDetails({ petId }: { petId: string }) {  // Query hook for GET requests with structured params  const { data, isLoading, error } = useGetPetById({    url: { petId }, // Path parameters    query: { includeOwner: true }, // Query parameters (if any)  });
  // Mutation hook for POST/PUT/PATCH/DELETE requests  const createPet = useCreatePet({    onSuccess: () => {      console.log("Pet created!");    },  });
  const handleCreate = () => {    createPet.mutate({      data: {        // Request body        name: "Fluffy",        species: "cat",      },    });  };
  if (isLoading) return <div>Loading...</div>;  if (error) return <div>Error: {error.message}</div>;
  return (    <div>      <h1>{data?.name}</h1>      <button onClick={handleCreate}>Create New Pet</button>    </div>  );}

Client Generation Options

Custom Code Preservation

Generated clients support custom code sections that are preserved during regeneration:

// client.ts (Generated)
// ============================================================// 🔒 CUSTOM CODE START// Add your custom code below this line// This section will be preserved during regeneration// ============================================================
// Your custom helper functions, middleware, etc.
// 🔒 CUSTOM CODE END// ============================================================

View complete client generation guide →

Configuration

Supports multiple configuration formats: openapi.sync.json, openapi.sync.ts, or openapi.sync.js

Basic Example:

{	"refetchInterval": 5000,	"folder": "./src/api",	"api": {		"petstore": "https://petstore3.swagger.io/api/v3/openapi.json"	}}

Advanced TypeScript Example:

import { IConfig } from "openapi-sync";
const config: IConfig = {	refetchInterval: 10000,	folder: "./src/api",	api: {		"main-api": "https://api.example.com/openapi.json",	},	folderSplit: { byTags: true },	types: { name: { prefix: "I", useOperationId: true } },	endpoints: {		exclude: { tags: ["deprecated"] },		doc: { showCurl: true },	},	validations: { library: "zod" },};
export default config;

🔐 Protected Specs & Stored Authentication (auth)

Fetch OpenAPI specifications protected behind Bearer tokens, Basic auth, API keys, or custom headers.

⚠️ IMPORTANT FOR HUMANS & AI AGENTS: Referencing environment variables for credentials requires using a TypeScript (openapi.sync.ts) or JavaScript (openapi.sync.js) configuration file. Static JSON (openapi.sync.json) does not support JavaScript runtime expressions like process.env. Always use openapi.sync.ts or openapi.sync.js when dynamic environment variables are needed to keep secrets safe and prevent invalid JSON syntax errors.

TypeScript Example (openapi.sync.ts):

import { defineConfig } from "openapi-sync";
export default defineConfig({  folder: "./src/api",  api: {    // 1. Protected with Bearer token    billingApi: {      url: "https://api.example.com/billing/openapi.json",      auth: {        type: "bearer",        token: process.env.BILLING_API_TOKEN!,      },    },
    // 2. Protected with Basic auth    internalApi: {      url: "https://internal.example.com/spec.json",      auth: {        type: "basic",        username: process.env.INTERNAL_USER!,        password: process.env.INTERNAL_PASSWORD!,      },    },
    // 3. Protected with API Key (header or query)    analyticsApi: {      url: "https://analytics.example.com/openapi.json",      auth: {        type: "apiKey",        in: "header",        name: "X-API-Key",        value: process.env.ANALYTICS_KEY!,      },    },  },});

JavaScript Example (openapi.sync.js):

/** @type {import('openapi-sync').IConfig} */module.exports = {  folder: "./src/api",  api: {    protectedApi: {      url: "https://api.example.com/openapi.json",      auth: {        type: "bearer",        token: process.env.MY_SPEC_TOKEN,      },    },  },};

View full configuration options →

CLI Commands

Interactive Setup

npx openapi-sync init

Launch an interactive wizard that guides you through creating your configuration file. Perfect for first-time setup or exploring available options.

Sync API Types

# Sync with default confignpx openapi-sync
# Sync with custom refetch intervalnpx openapi-sync --refreshinterval 10000

Synchronize your OpenAPI specifications and generate TypeScript types, endpoints, and validation schemas.

Zero-Config CLI Execution & Config Overrides

You can run openapi-sync directly from terminal scripts or CI/CD pipelines without creating a configuration file on disk. Pass any property supported by the configuration file via CLI flags:

# Zero-config sync with presetnpx openapi-sync --api-url https://petstore3.swagger.io/api/v3/openapi.json --preset react-query-zod --folder ./src/api
# Zero-config sync with protected specnpx openapi-sync --api-url https://api.example.com/openapi.json --auth-type bearer --auth-token "$MY_TOKEN" --preset next-fetch
# Multiple APIs via CLInpx openapi-sync --api users=https://api.example.com/users.json --api billing=https://api.example.com/billing.json --preset axios-zod
# Override existing disk config properties on-the-flynpx openapi-sync --folder ./dist/api --validation-lib yup --no-docs
# Raw JSON configuration via CLInpx openapi-sync --config-json '{"api":{"main":"https://api.example.com/spec.json"},"preset":"react-query-zod"}'

[!NOTE] If run without a configuration file on disk and without necessary CLI flags (e.g. --api-url, --api <name>=<url>, or --config-json), openapi-sync will display the standard ConfigNotFoundError, prompting you to run npx openapi-sync init.

Generate API Client

# Generate React Query hooksnpx openapi-sync generate-client --type react-query
# Generate for specific APInpx openapi-sync generate-client --type axios --api petstore
# Generate with filtersnpx openapi-sync generate-client --type fetch --tags pets,users
# Generate for specific endpointsnpx openapi-sync generate-client --type swr --endpoints getPetById,createPet

Generate fully-typed API clients for various frameworks and libraries.

Available Commands & Options

CLI Flag Aliases

Flags are interchangeable across init, sync, validate, and generate-client:

• Output folder: --output-folder or --folder (-f) (defaults to project root "")
• Validation library: --validation-library or --validation-lib (--validations-library)
• Tag folder split: --folder-split or --split-by-tags
• Type prefix: --types-prefix or --type-prefix

Diagnostic Health Checks (doctor)

Run an automated environment audit to diagnose config syntax, specification accessibility, optional peer dependencies (zod, yup, joi), cache state, and directory write permissions:

# Run human-readable diagnostic reportnpx openapi-sync doctor
# Run machine-readable health check for agents and CInpx openapi-sync doctor --json

Output Example:

{  "healthy": true,  "checks": [    { "name": "Configuration", "status": "ok", "message": "Valid openapi.sync.ts found" },    { "name": "Spec Reachability: petstore", "status": "ok", "message": "HTTP 200 OK (20 endpoints)" },    { "name": "Peer Dependency: zod", "status": "ok", "message": "zod v3.23.8 installed" },    { "name": "Output Directory", "status": "ok", "message": "./src/api is writable" }  ],  "recommendations": []}

Stale File Detection & Cleanup (purge)

Whenever endpoints or schemas are removed from your OpenAPI specification, previously generated files can become orphaned in your codebase. openapi-sync tracks generated artifacts via .openapi-sync/manifest.json and automatically detects stale files.

# Preview what stale files would be deleted without making changesnpx openapi-sync purge --dry-run
# Preview stale files as JSON (for CI / AI agents)npx openapi-sync purge --dry-run --json
# Delete stale files without an interactive promptnpx openapi-sync purge --yes
# Limit purge to a single configured APInpx openapi-sync purge --api petstore --yes

Inspecting Endpoints & Types (get-endpoint, read-type)

AI agents and developers can query specific endpoint metadata or read generated type declarations without loading huge files or blowing LLM context windows:

# Inspect full endpoint definition by operationIdnpx openapi-sync get-endpoint --operation-id getPetById --json
# Inspect endpoint using 4-tier fuzzy matching by name or pathnpx openapi-sync get-endpoint --name pet_update --json
# Read exact generated TypeScript type definitionnpx openapi-sync read-type --api petstore --type-name Pet --json

Typed Error Codes & Recovery

All CLI commands and programmatic methods throw structured error objects extending OpenApiSyncError. Each error exposes a stable code string:

Documentation

For complete documentation including:

• Configuration Options - All available settings and customization
• Generated Output - Understanding generated files and structure
• Custom Code Injection - Preserve your code between regenerations
• Validation Schemas - Runtime validation with Zod, Yup, or Joi
• Advanced Examples - Complex configurations and use cases
• API Reference - Programmatic usage and type definitions
• Troubleshooting - Common issues and solutions

Visit openapi-sync.com

🔌 MCP Server (Model Context Protocol)

openapi-sync ships with a complete Model Context Protocol (MCP) server. AI agents (Claude Desktop, Cursor, Windsurf, Zed, and any MCP-compatible client) can query endpoints, inspect schemas, read generated types, and execute syncs directly via type-safe tool calls over stdio — without pasting entire 5MB–15MB specs into prompt context.

The MCP server is published both as part of openapi-sync and as a dedicated zero-install companion package on npm: openapi-sync-mcp.

[npm version] [Glama] [Install in Cursor]

4 Ways Users & Agents Can Access OpenAPI Sync

Starting the Server

# Option A: Via standalone companion package (recommended for agent configs)npx openapi-sync-mcp
# Option B: Via main CLI (if openapi-sync is installed)npx openapi-sync mcp
# Option C: If installed globallyopenapi-sync-mcp

Transport: The server uses stdio transport — it reads JSON-RPC from stdin and writes responses to stdout. The working directory (cwd) of the process is used as the project root for reading and writing files.

Host Configuration Guides

1. Cursor Configuration

Create or update .cursor/mcp.json in your project root:

{  "mcpServers": {    "openapi-sync": {      "command": "npx",      "args": ["-y", "openapi-sync-mcp"],      "cwd": "${workspaceFolder}"    }  }}

Or add it globally via Cursor Settings → Features → MCP → + Add New MCP Server.

2. Claude Desktop Configuration

Edit your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

{  "mcpServers": {    "openapi-sync": {      "command": "npx",      "args": ["-y", "openapi-sync-mcp"],      "cwd": "/path/to/your/project"    }  }}

3. Windsurf (Codeium) Configuration

Add to ~/.codeium/windsurf/mcp_config.json:

{  "mcpServers": {    "openapi-sync": {      "command": "npx",      "args": ["-y", "openapi-sync-mcp"]    }  }}

4. Zed Configuration

Add to your Zed settings.json under context_servers:

{  "context_servers": [    {      "name": "openapi-sync",      "command": {        "path": "npx",        "args": ["-y", "openapi-sync-mcp"]      }    }  ]}

5. Google Antigravity Configuration

Add to your global configuration (~/.gemini/config/mcp_config.json) or project root (.agents/mcp_config.json):

{  "mcpServers": {    "openapi-sync": {      "command": "npx",      "args": ["-y", "openapi-sync-mcp"]    }  }}

Available MCP tools

Typical agent workflow via MCP

1. openapi_sync_read_config               → check if config exists2. openapi_sync_init                      → create config if needed (non-interactive, default folder "")3. openapi_sync_doctor                    → verify environment, spec reachability, and peer dependencies4. openapi_sync_validate                  → confirm specs are reachable and valid5. openapi_sync_list_endpoints            → inspect a paged subset of endpoints or search by path6. openapi_sync_get_endpoint_details      → inspect the full schema for one endpoint7. openapi_sync_read_generated_type       → read a specific generated TypeScript declaration8. openapi_sync_sync                      → generate types + schemas9. openapi_sync_generate_client           → generate a typed client with optional cache reuse10. openapi_sync_purge                    → clean up stale files when specs evolve

Tool input/output types

All tools return JSON-serialized versions of the same structured types used by the programmatic API:

• openapi_sync_sync → SyncResult
• openapi_sync_generate_client → SyncResult
• openapi_sync_validate → ValidationResult
• openapi_sync_doctor → DoctorResult ({ healthy, checks, recommendations })
• openapi_sync_list_endpoints → Record<string, EndpointSummary[]>
• openapi_sync_get_endpoint_details → { apiName, endpoint }
• openapi_sync_read_generated_type → string
• openapi_sync_init → { success, configFile, message, errors }
• openapi_sync_read_config → { found, file, path, content }

Troubleshooting

macOS Big Sur (11.x) - esbuild Installation Error

Error: dyld: Symbol not found: _SecTrustCopyCertificateChain when installing openapi-sync

Cause: The default esbuild version requires macOS 12.0+ APIs that aren't available in Big Sur.

Solution: Install a compatible esbuild version before installing openapi-sync:

# Install compatible esbuild firstnpm install [email protected]
# Then install openapi-syncnpm install openapi-sync

Alternatively, add an override to your package.json:

{	"overrides": {		"esbuild": "0.17.19"	}}

Note: This issue only affects macOS Big Sur (darwin 20.x). Users on macOS 12+ are not affected.

License

ISC License - see LICENSE file for details.

Contributing

Contributions welcome! Submit pull requests to our GitHub repository.

Contributors

A special thanks to the following contributors for their valuable work on this project:

Support / Donate

If you find OpenAPI Sync useful and would like to support its development, thank you — your support helps pay for hosting, CI, and ongoing maintenance.

You can support the project in any of the following ways:

• Sponsor the maintainer on GitHub: https://github.com/sponsors/akintomiwa-fisayo
• Back the project on Open Collective (placeholder): https://opencollective.com/fisayo-akintomiwa

Thank you for considering supporting the project — every bit helps.

📘 Full Documentation | GitHub | npm