Skip to content

command-reference.md

Latest commit

 

History

History
86 lines (60 loc) · 6.26 KB

command-reference.md

File metadata and controls

86 lines (60 loc) · 6.26 KB

Command reference

The Co-op Translator CLI offers several options to customize the translation process:

Command Description
translate -l "language_codes" Translates your project into specified languages. Example: translate -l "es fr de" translates into Spanish, French, and German. Use translate -l "all" to translate into all supported languages.
translate -l "language_codes" -u Updates translations by deleting existing ones and re-creating them. Warning: This will delete all current translations for specified languages.
translate -l "language_codes" -img Translates only image files.
translate -l "language_codes" -md Translates only Markdown files.
translate -l "language_codes" -nb Translates only Jupyter notebook files (.ipynb).
translate -l "language_codes" --fix Retranslates files with low confidence scores based on previous evaluation results.
translate -l "language_codes" -d Enables debug mode for detailed logging.
translate -l "language_codes" --save-logs, -s Save DEBUG-level logs to files under <root_dir>/logs/ (console remains controlled by -d)
translate -l "language_codes" -r "root_dir" Specifies the root directory of the project
translate -l "language_codes" -f Uses fast mode for image translation (up to 3x faster plotting at a slight cost to quality and alignment).
translate -l "language_codes" -y Automatically confirm all prompts (useful for CI/CD pipelines)
translate -l "language_codes" --add-disclaimer/--no-disclaimer Enable or disable adding a machine translation disclaimer section to translated markdown and notebooks (default: enabled).
translate -l "language_codes" --repo-url "https://github.com/org/repo.git" Personalize the README languages section advisory (sparse checkout) with your repository URL.
translate -l "language_codes" --help help details within the CLI showing available commands
evaluate -l "language_code" Evaluates translation quality for a specific language and provides confidence scores
evaluate -l "language_code" -c 0.8 Evaluates translations with custom confidence threshold
evaluate -l "language_code" -f Fast evaluation mode (rule-based only, no LLM)
evaluate -l "language_code" -D Deep evaluation mode (LLM-based only, more thorough but slower)
evaluate -l "language_code" --save-logs, -s Save DEBUG-level logs to files under <root_dir>/logs/
migrate-links -l "language_codes" Reprocess translated Markdown files to update links to notebooks (.ipynb). Prefers translated notebooks when available; otherwise can fall back to original notebooks.
migrate-links -l "language_codes" -r Specify the project root directory (default: current directory).
migrate-links -l "language_codes" --dry-run Show which files would change without writing changes.
migrate-links -l "language_codes" --no-fallback-to-original Do not rewrite links to original notebooks when translated counterparts are missing (only update when translated exists).
migrate-links -l "language_codes" -d Enable debug mode for detailed logging.
migrate-links -l "language_codes" --save-logs, -s Save DEBUG-level logs to files under <root_dir>/logs/
migrate-links -l "all" -y Process all languages and auto-confirm the warning prompt.

Usage examples

  1. Default behavior (add new translations without deleting existing ones): translate -l "ko" translate -l "es fr de" -r "./my_project"

  2. Add only new Korean image translations (no existing translations are deleted): translate -l "ko" -img

  3. Update all Korean translations (Warning: This deletes all existing Korean translations before re-translating): translate -l "ko" -u

  4. Update only Korean images (Warning: This deletes all existing Korean images before re-translating): translate -l "ko" -img -u

  5. Add new markdown translations for Korean without affecting other translations: translate -l "ko" -md

  6. Fix low confidence translations based on previous evaluation results: translate -l "ko" --fix

  7. Fix low confidence translations for specific files only (markdown): translate -l "ko" --fix -md

  8. Fix low confidence translations for specific files only (images): translate -l "ko" --fix -img

  9. Use fast mode for image translation: translate -l "ko" -img -f

  10. Fix low confidence translations with custom threshold: translate -l "ko" --fix -c 0.8

  11. Debug mode example: - translate -l "ko" -d: Enable debug logging.

  12. Save logs to files: translate -l "ko" -s

  13. Console DEBUG and file DEBUG: translate -l "ko" -d -s

  14. Translate without adding machine translation disclaimers to outputs: translate -l "ko" --no-disclaimer

  15. Migrate notebook links for Korean translations (update links to translated notebooks when available): migrate-links -l "ko"

  16. Migrate links with dry-run (no file writes): migrate-links -l "ko" --dry-run

  17. Only update links when translated notebooks exist (do not fallback to originals): migrate-links -l "ko" --no-fallback-to-original

  18. Process all languages with confirmation prompt: migrate-links -l "all"

  19. Process all languages and auto-confirm: migrate-links -l "all" -y

  20. Save logs to files for migrate-links: migrate-links -l "ko ja" -s

  21. Personalize README languages advisory with your repo URL: translate -l "ko" --repo-url "https://github.com/org/repo.git"

Evaluation Examples

Warning

Beta Feature: The evaluation functionality is currently in beta. This feature was released to evaluate translated documents, and the evaluation methods and detailed implementation are still under development and subject to change.

  1. Evaluate Korean translations: evaluate -l "ko"

  2. Evaluate with custom confidence threshold: evaluate -l "ko" -c 0.8

  3. Fast evaluation (rule-based only): evaluate -l "ko" -f

  4. Deep evaluation (LLM-based only): evaluate -l "ko" -D