Skip to content

typebox-cli.md

Latest commit

 

History

History
110 lines (84 loc) · 2.58 KB

typebox-cli.md

File metadata and controls

110 lines (84 loc) · 2.58 KB
Raw
repo gsuess/typebox-cli
url https://github.com/gsuess/typebox-cli
homepage
starredAt 2025-11-29T16:23:33Z
createdAt 2025-02-11T18:02:57Z
updatedAt 2025-12-22T17:13:52Z
language TypeScript
license MIT
branch main
stars 11
isPublic true
isTemplate false
isArchived false
isFork false
hasReadMe true
refreshedAt 2025-12-27T22:31:49.916Z
description CLI tool for various TypeBox and JSON Schema operations
tags

TypeBox CLI

Test Package Publication

Description

CLI tool for various TypeBox and JSON Schema operations.

Install

npm install -g typebox-cli

Usage

Convert TypeScript types to TypeBox Schema

Input file (i.e. types.ts):

export type T = "test";

Run TypeBox Codegen:

typebox codegen TypeBox --source types.ts

Outputs:

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

export type T = Static<typeof T>
export const T = Type.String()

Convert TypeBox Schema into JSON schema

Input file (i.e. typebox.ts):

import { Type } from "@sinclair/typebox";
export const T = Type.String();

Run JSON Schema extraction:

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

Outputs:

{
  "$id": "T",
  "type": "string"
}

Reference

Commands

# Extract - Extract JSON schema from exported TypeBox variables:
typebox extract json --module <module path>

# Codegen -- Generate Schema from either TypeScript types (using --source) or TypeBox schema (using --module):
typebox codegen <model-name> --source <source file> # Generate from TypeScript Types.
typebox codegen <model-name> --module <module path> # Generate from exported TypeBox Schema values.

# List available Codegen models:
typebox list

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

Dependencies

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