@prototypey/cli

CLI tool for generating types from ATProto lexicon schemas.

Installation

npm install -g @prototypey/cli

Or use directly with npx:

npx @prototypey/cli

Commands

gen-emit

Emit JSON lexicon schemas from authored TypeScript files.

Usage:

prototypey gen-emit <outdir> <sources...>

Arguments:

• outdir - Output directory for emitted JSON schema files
• sources... - One or more glob patterns matching TypeScript source files

Example:

prototypey gen-emit ./lexicons ./src/lexicons/**/*.ts

What it does:

• Scans TypeScript files for exported lexicon definitions
• Extracts the .json property from each lexicon
• Emits properly formatted JSON lexicon schema files
• Names output files by lexicon ID (e.g., app.bsky.feed.post.json)

Workflow

The typical workflow combines both commands for bidirectional type safety:

1. Author lexicons in TypeScript using the prototypey library
2. Emit to JSON with gen-emit for runtime validation and API contracts

# Write your lexicons in TypeScript
# src/lexicons/app.bsky.actor.profile.ts

# Emit JSON schemas
prototypey gen-emit ./schemas ./src/lexicons/**/*.ts

Requirements

• Node.js >= 20.19.0

License

MIT