CLI-referens¶
Co-op Translator installerar dessa kommandoradsingångspunkter:
translateevaluatemigrate-linksco-op-reviewco-op-translator-mcp
The translate, evaluate, migrate-links, and co-op-review commands dispatch through co_op_translator.__main__, which selects the command implementation based on the invoked script name. The MCP server uses co_op_translator.mcp.server directly.
If you are deciding between CLI, Python API, and MCP, start with Välj ditt arbetsflöde.
Första gången med CLI¶
Börja här om du använder Co-op Translator från en terminal:
- Konfigurera en LLM-leverantör enligt beskrivningen i Konfiguration.
- Välj den innehållstyp du vill översätta.
- Kör först ett fokuserat kommando, till exempel endast Markdown-översättning.
- Använd
--dry-runföre stora ändringar i repot. - Använd
co-op-reviewefter översättning för att kontrollera struktur och aktualitet.
| Mål | Kommando att börja med |
|---|---|
| Översätt Markdown-dokument | translate -l "ko" -md |
| Översätt notebooks | translate -l "ko" -nb |
| Översätt text i bilder | translate -l "ko" -img |
| Förhandsgranska arbete utan att skriva filer | translate -l "ko" -md --dry-run |
| Granska befintliga översättningar | co-op-review -l "ko" |
| Uppdatera länkar i notebooks och Markdown | migrate-links -l "ko" --dry-run |
| Gör verktyg tillgängliga för en MCP-klient | Konfigurera MCP-servern istället för att köra CLI-kommandon direkt. |
translate¶
Translate Markdown files, notebooks, and image text into one or more target languages.
Vanliga exempel¶
Översätt endast Markdown:
Översätt endast notebooks:
Översätt Markdown och bilder:
Uppdatera befintliga översättningar genom att ta bort dem och återskapa dem:
Kör utan interaktiva uppmaningar:
Spara loggar:
Alternativ¶
| Alternativ | Obligatoriskt | Beskrivning |
|---|---|---|
-l, --language-codes |
Ja | Språkkoder separerade med mellanslag, såsom "es fr de", eller "all". |
-r, --root-dir |
Nej | Projektrot. Standard är den aktuella katalogen. |
-u, --update |
Nej | Ta bort befintliga översättningar för valda språk och återskapa dem. |
-img, --images |
Nej | Översätt endast bildfiler. |
-md, --markdown |
Nej | Översätt endast Markdown-filer. |
-nb, --notebook |
Nej | Översätt endast Jupyter-notebook-filer. |
-d, --debug |
Nej | Aktivera debug-loggning i konsolen. |
-s, --save-logs |
Nej | Spara DEBUG-nivå loggar under <root-dir>/logs/. |
-x, --fix |
Nej | Översätt igen Markdown-filer med låg konfidens baserat på tidigare utvärderingsresultat. |
-c, --min-confidence |
Nej | Konfidensgräns för --fix. Standard är 0.7. |
--add-disclaimer, --no-disclaimer |
Nej | Lägg till eller undertryck ansvarsfriskrivningar för maskinöversättning. Som standard aktiverat i CLI. |
-f, --fast |
Nej | Föråldrat snabbt bildläge. |
-y, --yes |
Nej | Bekräfta uppmaningar automatiskt, användbart i CI. |
--repo-url |
Nej | Repository-URL som används i README:s språktabell för sparse-checkout-råd. |
--migrate-language-folders |
Nej | Byt namn på äldre aliasmappar, såsom cn eller tw, till kanoniska BCP 47-mappar. |
--dry-run |
Nej | Förhandsgranska migration av språkmappar och uppskattningar av översättning utan att skriva filer. |
If no type flag is provided, translate processes Markdown, notebooks, and images. Image translation requires Azure AI Vision configuration.
evaluate¶
Utvärdera kvaliteten på översatt Markdown för ett språk.
Experimental
evaluate is experimental. It can use rule-based and LLM-based quality checks, writes evaluation results into translation metadata, and its scoring model and metadata behavior may change.
Vanliga exempel¶
Använd en striktare tröskel för låg konfidens:
Kör endast regelbaserade kontroller:
Kör endast LLM-baserade kontroller:
Alternativ¶
| Alternativ | Obligatoriskt | Beskrivning |
|---|---|---|
-l, --language-code |
Ja | En enda språkkod att utvärdera. Alias-koder normaliseras. |
-r, --root-dir |
Nej | Projektrot. Standard är den aktuella katalogen. |
-c, --min-confidence |
Nej | Tröskel som används när lågkonfidensöversättningar listas. Standard är 0.7. |
-d, --debug |
Nej | Aktivera debug-loggning. |
-s, --save-logs |
Nej | Spara DEBUG-nivå loggar under <root-dir>/logs/. |
-f, --fast |
Nej | Endast regelbaserad utvärdering. |
-D, --deep |
Nej | Endast LLM-baserad utvärdering. |
Som standard använder evaluate både regelbaserad och LLM-baserad utvärdering. Resultaten skrivs till översättningsmetadata och sammanfattas i konsolen.
co-op-review¶
Kör deterministiska underhållskontroller för översättningar utan API-referenser.
Beta
co-op-review is a beta deterministic review command. It does not call model providers or write files, but its checks and issue output schema may evolve.
Vanliga exempel¶
Granska koreanska och japanska översättningar från den aktuella katalogen:
Granska en specifik projektrot:
Granska endast källfiler som ändrats jämfört med en basref:
Skriv ut GitHub-flavored Markdown-utdata för CI-sammanfattningar:
Alternativ¶
| Alternativ | Obligatoriskt | Beskrivning |
|---|---|---|
-l, --language-code |
Nej | Språkkod att granska. Kan passeras flera gånger eller som ett värde separerat med mellanslag. Som standard alla upptäckta översättningsspråk. |
-r, --root-dir |
Nej | Projektrot. Standard är den aktuella katalogen. |
--changed-from |
Nej | Git-ref som används för att begränsa granskningen till ändrade källfiler. |
--format |
Nej | Utdataformat: text eller github. Standard är text. |
co-op-review kontrollerar för närvarande saknade översatta filer, saknad eller föråldrad översättningsmetadata, integriteten hos Markdown frontmatter och kodavgränsare, ogiltig översatt notebook JSON, och saknade lokala Markdown- eller bildlänkmål. Saknade länkar är varningar som standard; strukturella och aktualitetsproblem gör att kommandot misslyckas.
co-op-translator-mcp¶
Kör Co-op Translator MCP-servern för agenter, redaktörer och MCP-kompatibla klienter.
The default transport is stdio. See the MCP-servern guide for client configuration, tools, resources, and safety notes.
Alternativ¶
| Alternativ | Obligatoriskt | Beskrivning |
|---|---|---|
--transport |
Nej | MCP-transport: stdio, streamable-http, eller sse. Standard är stdio. |
migrate-links¶
Bearbeta om översatta Markdown-filer och uppdatera notebook-länkar så att de pekar på översatta notebooks när sådana finns.
Vanliga exempel¶
Förhandsgranska länkuppdateringar:
Bearbeta alla stödda språk utan bekräftelse:
Skriv bara om länkar när översatta notebooks finns:
Alternativ¶
| Alternativ | Obligatoriskt | Beskrivning |
|---|---|---|
-l, --language-codes |
Ja | Språkkoder separerade med mellanslag, eller "all". |
-r, --root-dir |
Nej | Projektrot. Standard är den aktuella katalogen. |
--image-dir |
Nej | Översatt bildmapp relativt roten. Standard är translated_images. |
--dry-run |
Nej | Visa filer som skulle ändras utan att skriva uppdateringar. |
--fallback-to-original, --no-fallback-to-original |
Nej | Använd ursprungliga notebook-länkar när översatta notebooks saknas. Aktiverat som standard. |
-d, --debug |
Nej | Aktivera debug-loggning. |
-s, --save-logs |
Nej | Spara DEBUG-nivå loggar under <root-dir>/logs/. |
-y, --yes |
Nej | Bekräfta uppmaningar automatiskt när alla språk bearbetas. |
Miljö¶
Alla kommandon kräver en konfigurerad LLM-leverantör:
# 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"
# Eller OpenAI
OPENAI_API_KEY="..."
OPENAI_CHAT_MODEL_ID="gpt-4o"
Bildöversättning kräver dessutom Azure AI Vision:
AZURE_AI_SERVICE_API_KEY="..."
AZURE_AI_SERVICE_ENDPOINT="https://<resource>.cognitiveservices.azure.com/"
Utdata-layout¶
Textöversättningar skrivs under:
Översatt bildutdata skrivs under:
Till exempel, att översätta README.md och docs/setup.md till koreanska ger:
Kopiera-klistra CLI-exempel¶
Översätt Markdown till tre språk:
Översätt endast notebooks:
Översätt endast bilder:
Förhandsgranska Markdown-översättning utan att skriva filer:
Åtgärda Markdown-översättningar med låg konfidens:
Kör CI-vänlig Markdown-översättning:
Granska översatt utdata:
Förhandsgranska länk-migrering: