TypeBox CLI


Description

CLI tool for various TypeBox and JSON Schema operations.

Install

``bash
npm install -g typebox-cli
`

$3

#### Convert TypeScript types to TypeBox Schema

Input file (i.e. types.ts):
`ts
export type T = "test";
`
Run TypeBox Codegen:

`bash
typebox codegen TypeBox --source types.ts
`
Outputs:

`ts
import { Type, Static } from '@sinclair/typebox'

export type T = Static
export const T = Type.String()
`

#### Convert TypeBox Schema into JSON schema

Input file (i.e. typebox.ts):
`ts
import { Type } from "@sinclair/typebox";
export const T = Type.String();
`
Run JSON Schema extraction:

`bash
typebox extract json --module typebox.ts -e T
`

Outputs:
`json
{
"$id": "T",
"type": "string"
}
`

Reference

$3

`bash


Extract - Extract JSON schema from exported TypeBox variables:

typebox extract json --module

Codegen -- Generate Schema from either TypeScript types (using --source) or TypeBox schema (using --module):

typebox codegen --source # Generate from TypeScript Types.
typebox codegen --module # Generate from exported TypeBox Schema values.

List available Codegen models:

typebox list

Misc

typebox --version # Display current typebox version.
typebox --help # Help
`

$3

typebox-cli` is based on these packages:

- TypeBox - Json Schema Type Builder with Static Type Resolution for TypeScript
- TypeBox Codegen - Code Generation Tools for TypeBox
- jiti - Module Loading
- Commander - CLI Interface

License

MIT