Справочник по CLI¶
Co-op Translator устанавливает следующие точки входа командной строки:
translateevaluatemigrate-linksco-op-reviewco-op-translator-mcp
Команды translate, evaluate, migrate-links и co-op-review вызываются через co_op_translator.__main__, который выбирает реализацию команды на основе имени вызванного скрипта. Сервер MCP использует co_op_translator.mcp.server напрямую.
Если вы выбираете между CLI, Python API и MCP, начните с Выберите рабочий процесс.
Процесс при первом использовании через CLI¶
Начните здесь, если вы используете Co-op Translator из терминала:
- Настройте провайдера LLM, как описано в Конфигурация.
- Выберите тип содержимого, который хотите перевести.
- Сначала выполните целевую команду, например перевод только Markdown.
- Используйте
--dry-runперед крупными изменениями в репозитории. - Выполните
co-op-reviewпосле перевода для проверки структуры и актуальности.
| Цель | Команда для начала работы |
|---|---|
| Перевести документы Markdown | translate -l "ko" -md |
| Перевести ноутбуки | translate -l "ko" -nb |
| Перевести текст на изображениях | translate -l "ko" -img |
| Просмотреть результат без записи файлов | translate -l "ko" -md --dry-run |
| Проверить существующие переводы | co-op-review -l "ko" |
| Обновить ссылки в ноутбуках и Markdown | migrate-links -l "ko" --dry-run |
| Предоставить инструменты клиенту MCP | Настройте Сервер MCP вместо прямого запуска команд CLI. |
translate¶
Translate Markdown files, notebooks, and image text into one or more target languages.
Распространённые примеры¶
Перевести только Markdown:
Перевести только ноутбуки:
Перевести Markdown и изображения:
Обновить существующие переводы, удалив и воссоздав их:
Запустить без интерактивных подсказок:
Сохранить логи:
Параметры¶
| Опция | Обязательно | Описание |
|---|---|---|
-l, --language-codes |
Yes | Коды языков, разделённые пробелами, такие как "es fr de", или "all". |
-r, --root-dir |
No | Корень проекта. По умолчанию — текущая директория. |
-u, --update |
No | Удалять существующие переводы для выбранных языков и воссоздавать их. |
-img, --images |
No | Переводить только файлы изображений. |
-md, --markdown |
No | Переводить только Markdown-файлы. |
-nb, --notebook |
No | Переводить только Jupyter-ноутбуки. |
-d, --debug |
No | Включить отладочное логирование в консоли. |
-s, --save-logs |
No | Сохранять логи уровня DEBUG в <root-dir>/logs/. |
-x, --fix |
No | Переперевести Markdown-файлы с низкой уверенностью на основе результатов предыдущей оценки. |
-c, --min-confidence |
No | Порог уверенности для --fix. По умолчанию 0.7. |
--add-disclaimer, --no-disclaimer |
No | Добавлять или подавлять дисклеймеры машинного перевода. По умолчанию в CLI включено. |
-f, --fast |
No | Устаревший быстрый режим обработки изображений. |
-y, --yes |
No | Автоматически подтверждать подсказки, полезно в CI. |
--repo-url |
No | URL репозитория, используемый в рекомендациях sparse-checkout таблицы языков в README. |
--migrate-language-folders |
No | Переименовать устаревшие папки-алиасы, такие как cn или tw, в канонические папки BCP 47. |
--dry-run |
No | Просмотр миграции папок языков и оценок перевода без записи файлов. |
Если флаг типа не указан, translate обрабатывает Markdown, ноутбуки и изображения. Перевод изображений требует настройки Azure AI Vision.
evaluate¶
Evaluate translated Markdown quality for one language.
Экспериментально
evaluate является экспериментальной функцией. Она может использовать основанные на правилах и на LLM проверки качества, записывает результаты оценки в метаданные перевода, и её модель оценивания и поведение с метаданными могут измениться.
Распространённые примеры¶
Использовать более строгий порог низкой уверенности:
Запустить только проверку на основе правил:
Запустить только проверку на основе LLM:
Параметры¶
| Опция | Обязательно | Описание |
|---|---|---|
-l, --language-code |
Yes | Один код языка для оценки. Псевдонимы кодов нормализуются. |
-r, --root-dir |
No | Корень проекта. По умолчанию — текущая директория. |
-c, --min-confidence |
No | Порог, используемый при перечислении переводов с низкой уверенностью. По умолчанию 0.7. |
-d, --debug |
No | Включить отладочное логирование. |
-s, --save-logs |
No | Сохранять логи уровня DEBUG в <root-dir>/logs/. |
-f, --fast |
No | Только основанная на правилах оценка. |
-D, --deep |
No | Только оценка, основанная на LLM. |
По умолчанию evaluate использует как оценку на основе правил, так и на основе LLM. Результаты записываются в метаданные перевода и суммируются в консоли.
co-op-review¶
Run deterministic translation maintenance checks without API credentials.
Бета
co-op-review — бета-команда детерминированного обзора. Она не вызывает провайдеров моделей и не записывает файлы, но её проверки и схема вывода проблем могут измениться.
Распространённые примеры¶
Проверить корейские и японские переводы из текущей директории:
Проверить конкретный корень проекта:
Проверить только исходные файлы, изменённые относительно базового ref:
Вывести результат в формате GitHub-flavored Markdown для сводок CI:
Параметры¶
| Опция | Обязательно | Описание |
|---|---|---|
-l, --language-code |
No | Код языка для проверки. Может быть передан несколько раз или как значение, разделённое пробелами. По умолчанию — все обнаруженные языки переводов. |
-r, --root-dir |
No | Корень проекта. По умолчанию — текущая директория. |
--changed-from |
No | Git-реф, используемый для ограничения проверки изменёнными исходными файлами. |
--format |
No | Формат вывода: text или github. По умолчанию text. |
co-op-review в настоящее время проверяет отсутствие переведённых файлов, отсутствующие или устаревшие метаданные перевода, целостность frontmatter в Markdown и кодовых блоков, недопустимый JSON переведённых ноутбуков и отсутствующие локальные цели ссылок Markdown или изображений. Отсутствующие ссылки по умолчанию считаются предупреждениями; структурные и проблемы с актуальностью приводят к провалу команды.
co-op-translator-mcp¶
Run the Co-op Translator MCP server for agents, editors, and MCP-compatible clients.
Транспорт по умолчанию — stdio. См. руководство Сервер MCP для настройки клиента, инструментов, ресурсов и заметок по безопасности.
Параметры¶
| Опция | Обязательно | Описание |
|---|---|---|
--transport |
No | Транспорт MCP: stdio, streamable-http, или sse. По умолчанию stdio. |
migrate-links¶
Повторно обработать переведённые Markdown-файлы и обновить ссылки на ноутбуки так, чтобы они указывали на переведённые ноутбуки, когда они доступны.
Распространённые примеры¶
Просмотреть обновления ссылок:
Обработать все поддерживаемые языки без подтверждения:
Переписывать ссылки только когда существуют переведённые ноутбуки:
Параметры¶
| Опция | Обязательно | Описание |
|---|---|---|
-l, --language-codes |
Yes | Коды языков, разделённые пробелами, или "all". |
-r, --root-dir |
No | Корень проекта. По умолчанию — текущая директория. |
--image-dir |
No | Каталог переведённых изображений относительно корня проекта. По умолчанию translated_images. |
--dry-run |
No | Показать файлы, которые изменились бы, без записи обновлений. |
--fallback-to-original, --no-fallback-to-original |
No | Использовать оригинальные ссылки на ноутбуки, когда переведённые ноутбуки отсутствуют. По умолчанию включено. |
-d, --debug |
No | Включить отладочное логирование. |
-s, --save-logs |
No | Сохранять логи уровня DEBUG в <root-dir>/logs/. |
-y, --yes |
No | Автоматически подтверждать запросы при обработке всех языков. |
Окружение¶
Все команды требуют настройки одного провайдера LLM:
# Azure OpenAI
AZURE_OPENAI_API_KEY="..."
AZURE_OPENAI_ENDPOINT="https://<resource>.openai.azure.com/"
AZURE_OPENAI_MODEL_NAME="gpt-4o"
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME="<deployment>"
AZURE_OPENAI_API_VERSION="2024-12-01-preview"
# Или OpenAI
OPENAI_API_KEY="..."
OPENAI_CHAT_MODEL_ID="gpt-4o"
Перевод изображений дополнительно требует Azure AI Vision:
AZURE_AI_SERVICE_API_KEY="..."
AZURE_AI_SERVICE_ENDPOINT="https://<resource>.cognitiveservices.azure.com/"
Структура вывода¶
Текстовые переводы записываются в:
Переведённые изображения записываются в:
Например, перевод README.md и docs/setup.md на корейский даёт:
Примеры CLI для копирования и вставки¶
Перевести Markdown на три языка:
Перевести только ноутбуки:
Перевести только изображения:
Просмотреть перевод Markdown без записи файлов:
Исправить переводы Markdown с низкой уверенностью:
Запустить перевод Markdown, удобный для CI:
Проверить переведённый результат:
Просмотреть миграцию ссылок: