CLI Reference¶
Co-op Translator inštaluje tieto príkazové vstupné body:
translateevaluatemigrate-linksco-op-reviewco-op-translator-mcp
Príkazy translate, evaluate, migrate-links a co-op-review sa odosielajú cez co_op_translator.__main__, ktorý vyberie implementáciu príkazu na základe názvu spusteného skriptu. MCP server používa priamo co_op_translator.mcp.server.
Ak sa rozhodujete medzi CLI, Python API a MCP, začnite s Vyberte si pracovný postup.
First-Time CLI Flow¶
Začnite tu, ak používate Co-op Translator z terminálu:
- Nakonfigurujte poskytovateľa LLM podľa pokynov v Configuration.
- Vyberte typ obsahu, ktorý chcete preložiť.
- Najprv spustite zameraný príkaz, napríklad preklad iba Markdown.
- Pred rozsiahlymi zmenami v repozitári použite
--dry-run. - Po preklade použite
co-op-reviewna skontrolovanie štruktúry a aktuálnosti.
| Goal | Command to start with |
|---|---|
| Translate Markdown documents | translate -l "ko" -md |
| Translate notebooks | translate -l "ko" -nb |
| Translate image text | translate -l "ko" -img |
| Preview work without writing files | translate -l "ko" -md --dry-run |
| Review existing translations | co-op-review -l "ko" |
| Update notebook and Markdown links | migrate-links -l "ko" --dry-run |
| Expose tools to an MCP client | Configure the MCP Server instead of running CLI commands directly. |
translate¶
Prekladajte súbory Markdown, notebooky a text na obrázkoch do jedného alebo viacerých cieľových jazykov.
Common examples¶
Preložiť iba Markdown:
Preložiť iba notebooky:
Preložiť Markdown a obrázky:
Aktualizovať existujúce preklady ich odstránením a obnovením:
Spustiť bez interaktívnych výziev:
Uložiť logy:
Options¶
| Option | Required | Description |
|---|---|---|
-l, --language-codes |
Yes | Medzerou oddelené kódy jazykov, napríklad "es fr de", alebo "all". |
-r, --root-dir |
No | Koreň projektu. Predvolené je aktuálny adresár. |
-u, --update |
No | Odstrániť existujúce preklady pre vybrané jazyky a znovu ich vytvoriť. |
-img, --images |
No | Preložiť iba súbory s obrázkami. |
-md, --markdown |
No | Preložiť iba súbory Markdown. |
-nb, --notebook |
No | Preložiť iba Jupyter notebook súbory. |
-d, --debug |
No | Zapnúť debug logging v konzole. |
-s, --save-logs |
No | Uložiť DEBUG-úrovňové logy do <root-dir>/logs/. |
-x, --fix |
No | Preložiť znovu Markdown súbory s nízkou dôverou na základe predchádzajúcich výsledkov hodnotenia. |
-c, --min-confidence |
No | Prah dôvery pre --fix. Predvolené je 0.7. |
--add-disclaimer, --no-disclaimer |
No | Pridať alebo potlačiť upozornenia o strojovom preklade. V CLI je predvolene povolené. |
-f, --fast |
No | Zastaralý režim rýchleho spracovania obrázkov. |
-y, --yes |
No | Automaticky potvrdiť výzvy, užitočné v CI. |
--repo-url |
No | URL repozitára používané v odporúčaní sparse-checkout tabuľky jazykov v README. |
--migrate-language-folders |
No | Premenovať staršie alias priečinky, ako cn alebo tw, na kanonické BCP 47 priečinky. |
--dry-run |
No | Náhľad migrácie priečinkov jazykov a odhadov prekladu bez zápisu súborov. |
Ak nie je zadaný žiadny typový parameter, translate spracuje Markdown, notebooky a obrázky. Preklad obrázkov vyžaduje konfiguráciu Azure AI Vision.
evaluate¶
Vyhodnoťte kvalitu preloženého Markdownu pre jeden jazyk.
Experimentálne
evaluate je experimentálne. Môže používať pravidlové a LLM-založené kontroly kvality, zapisuje výsledky hodnotenia do metadát prekladu a jeho model hodnotenia a správanie s metadátami sa môžu meniť.
Common examples¶
Použiť prísnejší prah pre nízku dôveru:
Spustiť len pravidlové kontroly:
Spustiť len LLM-založené kontroly:
Options¶
| Option | Required | Description |
|---|---|---|
-l, --language-code |
Yes | Jediný kód jazyka na vyhodnotenie. Alias kódy sú normalizované. |
-r, --root-dir |
No | Koreň projektu. Predvolené je aktuálny adresár. |
-c, --min-confidence |
No | Prah používaný pri vypisovaní prekladov s nízkou dôverou. Predvolené je 0.7. |
-d, --debug |
No | Zapnúť debug logging. |
-s, --save-logs |
No | Uložiť DEBUG-úrovňové logy do <root-dir>/logs/. |
-f, --fast |
No | Iba pravidlové hodnotenie. |
-D, --deep |
No | Iba LLM-založené hodnotenie. |
Predvolene evaluate používa oba prístupy: pravidlové aj LLM-založené hodnotenie. Výsledky sa zapisujú do metadát prekladu a sumarizujú v konzole.
co-op-review¶
Spustite deterministické kontroly údržby prekladov bez prihlasovacích údajov API.
Beta
co-op-review je beta deterministický príkaz na revíziu. Neposkytuje volania poskytovateľov modelov ani nezapisuje súbory, avšak jeho kontroly a schéma výstupu problémov sa môžu vyvíjať.
Common examples¶
Skontrolovať kórejské a japonské preklady z aktuálneho adresára:
Skontrolovať konkrétny koreň projektu:
Skontrolovať iba zdrojové súbory zmenené oproti základnému refu:
Vytlačiť výstup vo formáte GitHub-flavored Markdown pre súhrny CI:
Options¶
| Option | Required | Description |
|---|---|---|
-l, --language-code |
No | Kód jazyka na kontrolu. Môže byť zadaný viackrát alebo ako medzerou oddelená hodnota. Predvolene všetky zistené jazyky prekladov. |
-r, --root-dir |
No | Koreň projektu. Predvolené je aktuálny adresár. |
--changed-from |
No | Git ref používaný na obmedzenie revízie na zmenené zdrojové súbory. |
--format |
No | Formát výstupu: text alebo github. Predvolené je text. |
co-op-review momentálne kontroluje chýbajúce preložené súbory, chýbajúce alebo zastarané metadáta prekladu, integritu frontmatteru v Markdown a ohraničení kódu, neplatný preložený notebook JSON a chýbajúce miestne cieľové odkazy v Markdown alebo obrázkoch. Chýbajúce odkazy sú predvolene varovania; štrukturálne a aktuálne problémy ukončia príkaz s chybou.
co-op-translator-mcp¶
Spustite MCP server Co-op Translator pre agentov, editorov a klientov kompatibilných s MCP.
Predvolený transport je stdio. Pozrite si príručku MCP Server pre konfiguráciu klienta, nástroje, zdroje a bezpečnostné poznámky.
Options¶
| Option | Required | Description |
|---|---|---|
--transport |
No | MCP transport: stdio, streamable-http, alebo sse. Predvolené je stdio. |
migrate-links¶
Znovu spracovať preložené súbory Markdown a aktualizovať odkazy v notebookoch tak, aby smerovali na preložené notebooky, ak sú dostupné.
Common examples¶
Náhľad aktualizácií odkazov:
Spracovať všetky podporované jazyky bez potvrdenia:
Prepísať odkazy iba keď existujú preložené notebooky:
Options¶
| Option | Required | Description |
|---|---|---|
-l, --language-codes |
Yes | Medzerou oddelené kódy jazykov, alebo "all". |
-r, --root-dir |
No | Koreň projektu. Predvolené je aktuálny adresár. |
--image-dir |
No | Adresár preložených obrázkov relatívny ku koreňu. Predvolené je translated_images. |
--dry-run |
No | Zobraziť súbory, ktoré by sa zmenili, bez zápisu aktualizácií. |
--fallback-to-original, --no-fallback-to-original |
No | Použiť pôvodné odkazy na notebooky, keď chýbajú preložené notebooky. Predvolené je povolené. |
-d, --debug |
No | Zapnúť debug logging. |
-s, --save-logs |
No | Uložiť DEBUG-úrovňové logy do <root-dir>/logs/. |
-y, --yes |
No | Automaticky potvrdiť výzvy pri spracovaní všetkých jazykov. |
Environment¶
Všetky príkazy vyžadujú aspoň jedného nakonfigurovaného poskytovateľa 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"
# Alebo OpenAI
OPENAI_API_KEY="..."
OPENAI_CHAT_MODEL_ID="gpt-4o"
Preklad obrázkov navyše vyžaduje Azure AI Vision:
AZURE_AI_SERVICE_API_KEY="..."
AZURE_AI_SERVICE_ENDPOINT="https://<resource>.cognitiveservices.azure.com/"
Output layout¶
Textové preklady sa zapisujú do:
Výstup preložených obrázkov sa zapisuje do:
Napríklad, preložením README.md a docs/setup.md do kórejčiny vznikne:
Copy-Paste CLI Examples¶
Preložiť Markdown do troch jazykov:
Preložiť len notebooky:
Preložiť len obrázky:
Náhľad prekladu Markdown bez zápisu súborov:
Opraviť preklady Markdown s nízkou dôverou:
Spustiť CI-friendly preklad Markdown:
Skontrolovať preložený výstup:
Náhľad migrácie odkazov: