CLI Commands
tyndale init
Section titled “tyndale init”Initialize a new Tyndale project. Creates tyndale.config.json with sensible defaults.
npx tyndale inittyndale auth
Section titled “tyndale auth”Configure your AI provider credentials.
npx tyndale authtyndale translate
Section titled “tyndale translate”Extract translatable strings and generate translations for all configured locales.
npx tyndale translate [options]| Flag | Description |
|---|---|
--locale <code> | Translate only a specific locale |
--force | Re-translate all strings, not just changes |
--dry-run | Show what would be translated without writing files |
--token-budget <n> | Token budget per AI batch (default: 50000) |
--concurrency <n> | Max parallel translation sessions (auto-detected) |
tyndale validate
Section titled “tyndale validate”Check that all locales have complete, well-formed translations. No AI calls are made.
npx tyndale validateExits with code 1 if issues are found. Ideal for CI pipelines.
tyndale extract
Section titled “tyndale extract”Extract translatable strings without translating them. Useful for reviewing what will be sent to the AI provider.
npx tyndale extracttyndale translate-docs
Section titled “tyndale translate-docs”Translate documentation files (MDX/MD) for any supported framework. Automatically detects your docs framework or uses the configuration from tyndale.config.json.
npx tyndale translate-docs [options]| Flag | Description |
|---|---|
--content-dir <path> | Override the docs content directory |
--force | Re-translate all docs, not just missing files |
--concurrency <n> | Max parallel translation sessions (auto-detected) |
Supported frameworks: Starlight, Docusaurus, VitePress, MkDocs, Nextra.
translate-docs writes .tyndale-docs-state.json at your project root to track source-document hashes. Commit this file so fresh clones can skip unchanged docs without retranslation.
tyndale translate-docs setup
Section titled “tyndale translate-docs setup”Detect your documentation framework and save the configuration to tyndale.config.json.
npx tyndale translate-docs setupScans your project for framework signals (package dependencies and config files), confirms the detected framework, and writes the docs section to your config.
tyndale model
Section titled “tyndale model”Change the AI model used for translations.
npx tyndale model