Skip to content

CLI справка

Co-op Translator инсталира следните командни точки за командния ред:

  • translate
  • evaluate
  • migrate-links
  • co-op-review
  • co-op-translator-mcp

Командите translate, evaluate, migrate-links и co-op-review се извикват чрез co_op_translator.__main__, който избира реализацията на командата въз основа на името на извикания скрипт. MCP сървърът използва директно co_op_translator.mcp.server.

Ако се колебаете между CLI, Python API и MCP, започнете с Изберете работния си процес.

Конзолен изход

Интерактивните терминали използват форматирането на Rich за заглавието на командата, прогреса и обобщенията. CI и неинтерактивният изход автоматично преминават към обикновен текст.

Задайте CO_OP_TRANSLATOR_OUTPUT_STYLE=plain за да принудите обикновен изход, или CO_OP_TRANSLATOR_OUTPUT_STYLE=rich за да принудите Rich изход. Задайте CO_OP_TRANSLATOR_NO_PROGRESS=1 за да запазите обобщенията, като същевременно скриете живите ленти за прогрес.

Използвайте translate --json-events progress.ndjson когато друга система се нуждае от машиночитаем прогрес. CLI продължава да генерира изход, предназначен за хора, докато NDJSON файлът получава версионирани събития co-op.translation.event.v1 с стабилни полета като type, stage_key, completed, total, и current_path.

Първоначален поток за CLI

Започнете тук, ако използвате Co-op Translator от терминал:

  1. Конфигурирайте доставчик на LLM, както е описано в Конфигурация.
  2. Изберете типа съдържание, който искате да преведете.
  3. Стартирайте първо фокусирана команда, като например превод само на Markdown.
  4. Използвайте --dry-run преди големи промени в хранилището.
  5. Използвайте 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

Превежда Markdown файлове, бележници и текст в изображения на един или повече целеви езици.

translate -l "ko ja fr"

Чести примери

Превеждане само на Markdown:

translate -l "de" -md

Превеждане само на бележници:

translate -l "zh-CN" -nb

Превод на Markdown и изображения:

translate -l "pt-BR" -md -img

Актуализирайте съществуващите преводи, като ги изтриете и пресъздадете:

translate -l "ko" -u

Стартиране без интерактивни подкани:

translate -l "ko ja" -md -y

Запазване на логове:

translate -l "ko" -s

Записване на структурирани събития за прогрес:

translate -l "ko ja" -md --json-events progress.ndjson

Опции

Опция Задължително Описание
-l, --language-codes Да Кодове на езици, разделени с интервал, като "es fr de", или "all".
-r, --root-dir Не Корен на проекта. По подразбиране е текущата директория.
-u, --update Не Изтрива съществуващите преводи за избраните езици и ги пресъздава.
-img, --images Не Превежда само файлове с изображения.
-md, --markdown Не Превежда само Markdown файлове.
-nb, --notebook Не Превежда само Jupyter notebook файлове.
-d, --debug Не Разрешава debug логване в конзолата.
-s, --save-logs Не Записва DEBUG ниво логове в <root-dir>/logs/.
--json-events Не Записва машиночитаеми събития за напредъка на превода като NDJSON.
-x, --fix Не Превежда отново Markdown файлове с ниско доверие въз основа на предишни резултати от оценка.
-c, --min-confidence Не Праг на доверие за --fix. По подразбиране 0.7.
--add-disclaimer, --no-disclaimer Не Добавя или премахва пояснения за машинен превод. По подразбиране е включено в CLI.
-f, --fast Не Остарял бърз режим за изображения.
-y, --yes Не Автоматично потвърждава подкани, полезно в CI.
--repo-url Не URL на хранилището, използван в таблицата с езици в README за препоръка за sparse-checkout.
--migrate-language-folders Не Преименува наследени алиас папки, като cn или tw, в канонични папки по BCP 47.
--dry-run Не Преглед на миграцията на папките за езици и оценките за превод без записване на файлове.

Ако не е предоставен флаг за тип, translate обработва Markdown, бележници и изображения. Преводът на изображения изисква конфигурация на Azure AI Vision.

evaluate

Оценява качеството на преведените Markdown файлове за един език.

Експериментално

evaluate е експериментален. Може да използва проверки на качеството, базирани на правила, и такива, базирани на LLM, записва резултатите от оценяването в метаданните на превода и моделът за оценяване и поведението на метаданните може да се променят.

evaluate -l "ko"

Чести примери

Използвайте по-строг праг за ниско доверие:

evaluate -l "es" -c 0.8

Стартиране само на проверки, базирани на правила:

evaluate -l "fr" -f

Стартиране само на проверки, базирани на LLM:

evaluate -l "ja" -D

Опции

Опция Задължително Описание
-l, --language-code Да Един код на език за оценка. Алиас кодовете се нормализират.
-r, --root-dir Не Корен на проекта. По подразбиране е текущата директория.
-c, --min-confidence Не Праг, използван при изброяване на преводите с ниско доверие. По подразбиране 0.7.
-d, --debug Не Активира debug логване.
-s, --save-logs Не Записва DEBUG ниво логове в <root-dir>/logs/.
-f, --fast Не Само оценяване, базирано на правила.
-D, --deep Не Само оценяване, базирано на LLM.

По подразбиране, evaluate използва както оценки, базирани на правила, така и такива, базирани на LLM. Резултатите се записват в метаданните на превода и се обобщават в конзолата.

co-op-review

Изпълнява детерминистични проверки за поддръжка на превода без API идентификационни данни.

Бета

co-op-review е бета детерминистична команда за преглед. Не извиква доставчици на модели и не записва файлове, но проверките и схемата на изхода за проблеми може да се променят.

co-op-review -l "ko"

Чести примери

Прегледайте корейските и японските преводи от текущата директория:

co-op-review -l "ko ja"

Преглед на конкретен корен на проекта:

co-op-review -l "fr" -r ./my-course

Преглед само на README след превод само на README:

translate -l "ko" --readme-only -y
co-op-review -l "ko" --readme-only --format github

--readme-only игнорира други документи и вложени README-та. Командата се проваля ако корен README.md липсва. В комбинация с --changed-from, тя преглежда само README-то когато този изходен файл е променен. Преводът само на README оставя изходния README непроменен, включително и маркерите за споделени секции.

Преглед само на изходни файлове, променени спрямо базов реф:

co-op-review -l "ko" --changed-from origin/main

Изведете Markdown в GitHub стил за CI обобщения:

co-op-review -l "ko ja" --changed-from origin/main --format github

Опции

Опция Задължително Описание
-l, --language-code Не Код на език за преглед. Може да се подаде няколко пъти или като стойност, разделена с интервали. По подразбиране — всички открити езици за превод.
-r, --root-dir Не Корен на проекта. По подразбиране е текущата директория.
--changed-from Не Git ref, използван за ограничаване на прегледа до променените изходни файлове.
--readme-only Не Преглежда само коренния README.md превод.
--format Не Формат на изхода: text или github. По подразбиране text.

co-op-review в момента проверява за липсващи преведени файлове, липсващи или остарели метаданни на превода, целостта на frontmatter и code fence в Markdown, невалиден преведен notebook JSON и липсващи локални Markdown или image цели за връзки. Липсващите връзки по подразбиране са предупреждения; структурните и проблеми с актуалността причиняват неуспех на командата.

co-op-translator-mcp

Стартира MCP сървъра на Co-op Translator за агенти, редактори и MCP-съвместими клиенти.

co-op-translator-mcp

По подразбиране транспортът е stdio. Вижте ръководството MCP сървър за конфигурация на клиент, инструменти, ресурси и бележки за безопасност.

Опции

Опция Задължително Описание
--transport Не MCP транспорт: stdio, streamable-http, или sse. По подразбиране stdio.

Преработва преведените Markdown файлове и актуализира връзките към бележници така, че да сочат към преведени бележници, когато са налични.

migrate-links -l "ko ja"

Чести примери

Прегледайте обновленията на връзките:

migrate-links -l "ko" --dry-run

Обработете всички поддържани езици без потвърждение:

migrate-links -l "all" -y

Презаписване на връзки само когато съществуват преведени бележници:

migrate-links -l "ko" --no-fallback-to-original

Опции

Опция Задължително Описание
-l, --language-codes Да Кодове на езици, разделени с интервал, или "all".
-r, --root-dir Не Корен на проекта. По подразбиране е текущата директория.
--image-dir Не Директория за преведени изображения относително на корена. По подразбиране translated_images.
--dry-run Не Показва файловете, които биха се променили, без да записва промени.
--fallback-to-original, --no-fallback-to-original Не Използва оригиналните връзки към бележници, когато преведените бележници липсват. По подразбиране е разрешено.
-d, --debug Не Активира debug логване.
-s, --save-logs Не Записва DEBUG ниво логове в <root-dir>/logs/.
-y, --yes Не Автоматично потвърждава подкани при обработка на всички езици.

Околна среда

Когато команда изисква идентификационни данни на доставчик, конфигурирайте един от тези набори от доставчици. translate --dry-run и co-op-review не изискват идентификационни данни на доставчик:

# 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"

# Или Anthropic
ANTHROPIC_API_KEY="..."
ANTHROPIC_MODEL="claude-..."

Преводът на изображения допълнително изисква Azure AI Vision:

AZURE_AI_SERVICE_API_KEY="..."
AZURE_AI_SERVICE_ENDPOINT="https://<resource>.cognitiveservices.azure.com/"

Структура на изхода

Текстовите преводи се записват под:

translations/<language-code>/<original-path>

Преведеният изход за изображения се записва под:

translated_images/<language-code>/<original-path>

Например, превеждането на README.md и docs/setup.md на корейски води до:

translations/ko/README.md
translations/ko/docs/setup.md

CLI примери за копиране и поставяне

Превеждане на Markdown на три езика:

translate -l "ko ja fr" -md

Превеждане само на бележници:

translate -l "zh-CN" -nb

Превеждане само на изображения:

translate -l "pt-BR" -img

Преглед на превода на Markdown без записване на файлове:

translate -l "de es" -md --dry-run

Поправяне на Markdown преводи с ниско доверие:

evaluate -l "ko" -c 0.8
translate -l "ko" --fix -c 0.8 -md

Стартиране на CI-приятелски превод на Markdown:

translate -l "ko ja" -md -y -s

Преглед на преведения изход:

co-op-review -l "ko ja"

Преглед на миграцията на връзките:

migrate-links -l "ko" --dry-run