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

CLI Commands

Installation

cargo install typebridge-cli

Commands

typewriter generate

Generate type files from Rust source definitions.

# Generate from a single file
typewriter generate src/models.rs

# Generate from all Rust files
typewriter generate --all

# Generate only specific languages
typewriter generate --all --lang typescript,python

# Show unified diffs for changed files
typewriter generate --all --diff

typewriter check

Check if generated files are in sync with Rust source.

# Check all types
typewriter check

# Exit non-zero on drift (for CI)
typewriter check --ci

# Output as JSON
typewriter check --json

# Write JSON report to file
typewriter check --json-out drift-report.json

# Check specific languages
typewriter check --lang typescript,python

typewriter watch

Watch Rust files and regenerate on save.

# Watch src directory
typewriter watch

# Watch custom path
typewriter watch src/models/

# Specific languages
typewriter watch --lang typescript,python

# Adjust debounce interval (ms)
typewriter watch --debounce-ms 100

Cargo Plugin

After installing, use via cargo:

cargo typewriter generate --all
cargo typewriter check --ci
cargo typewriter watch

Exit Codes

CodeMeaning
0Success (no drift for check --ci)
1Error or drift detected