npm install readme-translator
# or
npm install -g readme-translator  # for CLI usage

# Basic usage
translate-readme README.md es fr de

# With options
translate-readme -v -o ./i18n --pattern docs.{lang}.md README.md es fr de ja zh

# List supported languages
translate-readme --list-languages

import { translateReadme } from "readme-translator";

const result = await translateReadme({
  source: "./README.md",
  languages: ["es", "fr", "de", "ja", "zh"],
  verbose: true,
});

console.log(`Translated ${result.successful} files`);
console.log(`Total cost: $${result.totalCostUsd.toFixed(4)}`);

interface TranslationOptions {
  /** Source README file path */
  source: string;

  /** Target language codes */
  languages: string[];

  /** Output directory (defaults to same directory as source) */
  outputDir?: string;

  /** Output filename pattern (use {lang} placeholder) */
  pattern?: string; // default: "README.{lang}.md"

  /** Preserve code blocks without translation */
  preserveCode?: boolean; // default: true

  /** Claude model to use */
  model?: string; // default: "sonnet"

  /** Maximum budget in USD */
  maxBudgetUsd?: number;

  /** Use existing translation file (if present) as a reference */
  useExisting?: boolean;

  /** Verbose output */
  verbose?: boolean;
}

interface TranslationJobResult {
  results: TranslationResult[];
  totalCostUsd: number;
  successful: number;
  failed: number;
}

interface TranslationResult {
  language: string;
  outputPath: string;
  success: boolean;
  error?: string;
  costUsd?: number;
}

{
  "scripts": {
    "translate": "translate-readme README.md es fr de ja zh",
    "translate:all": "translate-readme -v -o ./i18n README.md es fr de it pt ja ko zh ru ar",
    "prebuild": "npm run translate"
  }
}

name: Translate README
on:
  push:
    branches: [main]
    paths: [README.md]

jobs:
  translate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      
      - run: npm install -g readme-translator
      
      - name: Translate README
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        run: |
          translate-readme -v -o ./i18n README.md es fr de ja zh
      
      - name: Commit translations
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"
          git add i18n/
          git diff --staged --quiet || git commit -m "chore: update README translations"
          git push

// scripts/translate.ts
import { translateReadme } from "readme-translator";

async function main() {
  const result = await translateReadme({
    source: "./README.md",
    languages: (process.env.TRANSLATE_LANGS || "es,fr,de").split(","),
    outputDir: "./docs/i18n",
    maxBudgetUsd: 5.0,
    verbose: !process.env.CI,
  });

  if (result.failed > 0) {
    console.error("Some translations failed");
    process.exit(1);
  }
}

main();