Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Prerequisites

  • Rust stable toolchain (1.70+)
  • A Cargo project with serde for serialization
  • Rust is not required for end users who install the released typebridge CLI binary.

Add Dependencies

Add typebridge and serde to your Cargo.toml:

[dependencies]
typebridge = "0.5.0"
serde = { version = "1", features = ["derive"] }

By default, all language emitters are enabled:

  • TypeScript
  • Python
  • Go
  • Swift
  • Kotlin
  • GraphQL
  • JSON Schema

Feature Flags

To reduce compile times, enable only the languages you need:

# TypeScript only
typebridge = { version = "0.5.0", default-features = false, features = ["typescript"] }

# TypeScript + Python
typebridge = { version = "0.5.0", default-features = false, features = ["typescript", "python"] }

# All languages (default)
typebridge = "0.5.0"

CLI Installation

For project-wide generation, drift checking, and watch mode:

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/aarambh-darshan/typewriter/releases/latest/download/typebridge-installer.sh | sh

Windows:

powershell -ExecutionPolicy Bypass -c "irm https://github.com/aarambh-darshan/typewriter/releases/latest/download/typebridge-installer.ps1 | iex"

Rust users can also install from crates.io:

cargo install typebridge-cli

Use typebridge as the primary command. typewriter remains available as a compatibility alias.

Next Steps