# @spec2ts/cli

> Utility to convert specifications (Open API, JSON Schemas) to TypeScript using TypeScript native compiler

Latest version **4.0.5** (published 2026-09-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @spec2ts/cli
pnpm add @spec2ts/cli
yarn add @spec2ts/cli
bun add @spec2ts/cli
```

Provides the command `spec2ts`.

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 4.0.5 |
| Published | 2026-09-07 |
| First published | 2020-04-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 5 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Touchify |
| Maintainers | mluce, mtrimolet |
| Keywords | ast, client, compile, compiler, http, interface, json, jsonschema, openapi, openapiv3, rest, schema, share, spec, spec2ts, transpile, typescript, typing |

## Links

- npm: https://www.npmjs.com/package/@spec2ts/cli
- Repository: https://github.com/touchifyapp/spec2ts
- Homepage: https://github.com/touchifyapp/spec2ts/blob/master/packages/cli#readme
- Issues: https://github.com/touchifyapp/spec2ts/issues
- npm.io page: https://npm.io/package/@spec2ts/cli

## Dependencies (5)

- [yargs](https://npm.io/package/yargs.md) ^18.0.0
- [typescript](https://npm.io/package/typescript.md) ^6.0.0
- [@spec2ts/openapi](https://npm.io/package/@spec2ts/openapi.md) ^4.1.1
- [@spec2ts/jsonschema](https://npm.io/package/@spec2ts/jsonschema.md) ^4.1.1
- [@spec2ts/openapi-client](https://npm.io/package/@spec2ts/openapi-client.md) ^4.1.1

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 4.0.5 (latest) — 2026-09-07
- 4.0.4 — 2026-09-07
- 4.0.2 — 2026-07-17
- 4.0.1 — 2026-07-09
- 4.0.0 — 2026-07-09
- 3.0.5 — 2025-04-10
- 3.0.4 — 2023-10-23
- 3.0.3 — 2023-10-03
- 3.0.2 — 2023-09-25
- 3.0.1 — 2023-09-12
- 3.0.0 — 2023-09-12
- 2.0.0 — 2023-09-08
- 2.0.0-beta.13 — 2022-09-21
- 2.0.0-beta.12 — 2022-08-23
- 2.0.0-beta.11 — 2022-07-29
- … 30 more at https://npm.io/package/@spec2ts/cli/versions

## README

# @spec2ts/cli

[![NPM version](https://img.shields.io/npm/v/@spec2ts/cli.svg?style=flat-square)](https://npmjs.org/package/@spec2ts/cli)
[![NPM download](https://img.shields.io/npm/dm/@spec2ts/cli.svg?style=flat-square)](https://npmjs.org/package/@spec2ts/cli)
[![Build Status](https://travis-ci.org/touchifyapp/spec2ts.svg?branch=master)](https://travis-ci.org/touchifyapp/spec2ts)

`@spec2ts/cli` is an utility to create TypeScript types from JSON schemas or OpenAPI v3 specifications. Unlike other code generators `@spec2ts/cli` does not use templates to generate code but uses TypeScript's built-in API to generate and pretty-print an abstract syntax tree (AST).

## Features

- **AST-based:** Unlike other code generators `@spec2ts/cli` does not use templates to generate code but uses TypeScript's built-in API to generate and pretty-print an abstract syntax tree.
- **Tree-shakeable:** Individually exported types allows you to bundle only the ones you actually use.
- **YAML or JSON:** Use YAML or JSON for your specifications.
- **External references:** Resolves automatically external references and bundle or import them in generated files.
- **Implementation agnostic:** Use generated types in any projet or framework.

## Installation

Install in your project:

```bash
npm install @spec2ts/cli
```

## CLI Usage

#### JSON Schema command

```bash
spec2ts jsonschema [options] <input..>

Generate TypeScript types from JSON Schemas

Positionals:
  input  Path to JSON Schema(s) to convert to TypeScript                [string]

Options:
  --version     Show version number                                    [boolean]
  --help        Show help usage                                        [boolean]
  --output, -o  Output directory for generated types                    [string]
  --cwd, -c     Root directory for resolving $refs                      [string]
  --avoidAny    Avoid the `any` type and use `unknown` instead         [boolean]
  --enableDate  Build `Date` for format `date` and `date-time`         [boolean]
  --banner, -b  Comment prepended to the top of each generated file     [string]
```

#### OpenAPI command

```bash
spec2ts openapi [options] <input..>

Generate TypeScript types from OpenAPI specification

Positionals:
  input  Path to OpenAPI Specification(s) to convert to TypeScript      [string]

Options:
  --version     Show version number                                    [boolean]
  --help        Show help usage                                        [boolean]
  --output, -o  Output directory for generated types                    [string]
  --cwd, -c     Root directory for resolving $refs                      [string]
  --avoidAny    Avoid the `any` type and use `unknown` instead         [boolean]
  --enableDate  Build `Date` for format `date` and `date-time`         [boolean]
  --banner, -b  Comment prepended to the top of each generated file     [string]
```

## Implementations

- **JSON Schema:** See `@spec2ts/jsonschema`'s [documentation](https://github.com/touchifyapp/spec2ts/blob/master/packages/jsonschema/README.md).
- **Open API Specification:** See `@spec2ts/openapi`'s [documentation](https://github.com/touchifyapp/spec2ts/blob/master/packages/openapi/README.md).

## Compatibility Matrix

| TypeScript version | spec2ts version |
| ------------------ | --------------- |
| v3.x.x             | v1              |
| v4.x.x             | v2              |
| v5.x.x             | v3              |
| v6.x.x             | v4              |

## License

This project is under MIT License. See the [LICENSE](LICENSE) file for the full license text.

---
_Source: https://npm.io/package/@spec2ts/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
