CLI-referentie¶
Co-op Translator installeert de volgende commandoregel-entrypoints:
translateevaluatemigrate-linksco-op-reviewco-op-translator-mcp
De translate, evaluate, migrate-links en co-op-review commando's dispatchen via co_op_translator.__main__, dat de commandoregelimplementatie selecteert op basis van de aangeroepen scriptnaam. De MCP-server gebruikt co_op_translator.mcp.server rechtstreeks.
Als u moet kiezen tussen CLI, Python API en MCP, begin dan met Choose Your Workflow.
Eerste CLI-stappen¶
Begin hier als u Co-op Translator vanaf een terminal gebruikt:
- Configureer een LLM-provider zoals beschreven in Configuration.
- Kies het inhoudstype dat u wilt vertalen.
- Voer eerst een gerichte opdracht uit, zoals alleen Markdown-vertaling.
- Gebruik
--dry-runvoordat u grote repository-wijzigingen uitvoert. - Gebruik
co-op-reviewna vertaling om structuur en actualiteit te controleren.
| 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¶
Vertaal Markdown-bestanden, notebooks en afbeeldings-tekst naar een of meer doeltalen.
Veelvoorkomende voorbeelden¶
Alleen Markdown vertalen:
Alleen notebooks vertalen:
Markdown en afbeeldingen vertalen:
Bestaande vertalingen bijwerken door ze te verwijderen en opnieuw te maken:
Zonder interactieve prompts uitvoeren:
Logs opslaan:
Opties¶
| Option | Required | Description |
|---|---|---|
-l, --language-codes |
Yes | Spatie-gescheiden taalcodes, zoals "es fr de", of "all". |
-r, --root-dir |
No | Projectroot. Standaard de huidige map. |
-u, --update |
No | Verwijder bestaande vertalingen voor geselecteerde talen en maak ze opnieuw aan. |
-img, --images |
No | Alleen afbeeldingsbestanden vertalen. |
-md, --markdown |
No | Alleen Markdown-bestanden vertalen. |
-nb, --notebook |
No | Alleen Jupyter-notebookbestanden vertalen. |
-d, --debug |
No | Debug-logging in de console inschakelen. |
-s, --save-logs |
No | DEBUG-niveau logs opslaan onder <root-dir>/logs/. |
-x, --fix |
No | Markdown-bestanden met lage betrouwbaarheid opnieuw vertalen op basis van eerdere evaluatieresultaten. |
-c, --min-confidence |
No | Betrouwbaarheiddrempel voor --fix. Standaard 0.7. |
--add-disclaimer, --no-disclaimer |
No | Machinevertaling-verklaringen toevoegen of onderdrukken. Standaard ingeschakeld in de CLI. |
-f, --fast |
No | Verouderde snelle afbeeldingsmodus. |
-y, --yes |
No | Prompts automatisch bevestigen, handig in CI. |
--repo-url |
No | Repository-URL gebruikt in de README talen-tabel sparse-checkout advisering. |
--migrate-language-folders |
No | Hernoem legacy alias-mappen, zoals cn of tw, naar canonieke BCP 47 mappen. |
--dry-run |
No | Voorvertoning van taalmapmigratie en vertaalschattingen zonder bestanden te schrijven. |
Als geen typevlag is opgegeven, verwerkt translate Markdown, notebooks en afbeeldingen. Afbeeldingvertaling vereist Azure AI Vision-configuratie.
evaluate¶
Evalueer de kwaliteit van vertaalde Markdown voor één taal.
Experimenteel
evaluate is experimenteel. Het kan regelgebaseerde en LLM-gebaseerde kwaliteitscontroles gebruiken, schrijft evaluatieresultaten in vertaalmetadata, en het scoringsmodel en metadata-gedrag kunnen veranderen.
Veelvoorkomende voorbeelden¶
Gebruik een strengere drempel voor lage betrouwbaarheid:
Alleen regelgebaseerde controles uitvoeren:
Alleen LLM-gebaseerde controles uitvoeren:
Opties¶
| Option | Required | Description |
|---|---|---|
-l, --language-code |
Yes | Enkele taalcode om te evalueren. Alias-codes worden genormaliseerd. |
-r, --root-dir |
No | Projectroot. Standaard de huidige map. |
-c, --min-confidence |
No | Drempel gebruikt bij het opsommen van vertalingen met lage betrouwbaarheid. Standaard 0.7. |
-d, --debug |
No | Debug-logging inschakelen. |
-s, --save-logs |
No | DEBUG-niveau logs opslaan onder <root-dir>/logs/. |
-f, --fast |
No | Alleen regelgebaseerde evaluatie. |
-D, --deep |
No | Alleen LLM-gebaseerde evaluatie. |
Standaard gebruikt evaluate zowel regelgebaseerde als LLM-gebaseerde evaluatie. Resultaten worden geschreven in vertaalmetadata en samengevat in de console.
co-op-review¶
Voer deterministische onderhoudscontroles voor vertalingen uit zonder API-referenties.
Bèta
co-op-review is een bètacommand die deterministische controles uitvoert. Het roept geen modelproviders aan en schrijft geen bestanden, maar de controles en het schema voor issue-uitvoer kunnen evolueren.
Veelvoorkomende voorbeelden¶
Kijk Koreaanse en Japanse vertalingen na vanuit de huidige map:
Controleer een specifieke projectroot:
Controleer alleen bronbestanden die gewijzigd zijn ten opzichte van een basisref:
Print GitHub-flavored Markdown-uitvoer voor CI-samenvattingen:
Opties¶
| Option | Required | Description |
|---|---|---|
-l, --language-code |
No | Taalcode om te controleren. Kan meerdere keren worden opgegeven of als spatie-gescheiden waarde. Standaard alle ontdekte vertaaltalen. |
-r, --root-dir |
No | Projectroot. Standaard de huidige map. |
--changed-from |
No | Git-ref gebruikt om de controle te beperken tot gewijzigde bronbestanden. |
--format |
No | Uitvoervorm: text of github. Standaard text. |
co-op-review controleert momenteel op ontbrekende vertaalde bestanden, ontbrekende of verouderde vertaalmetadata, Markdown-frontmatter en integriteit van codefences, ongeldig vertaald notebook JSON, en ontbrekende lokale Markdown- of afbeeldingslinkdoelen. Ontbrekende links zijn standaard waarschuwingen; structurele en actualiteitproblemen doen het commando falen.
co-op-translator-mcp¶
Start de Co-op Translator MCP-server voor agents, editors en MCP-compatibele clients.
De standaardtransportlaag is stdio. Zie de MCP Server gids voor clientconfiguratie, tools, resources en veiligheidsopmerkingen.
Opties¶
| Option | Required | Description |
|---|---|---|
--transport |
No | MCP-transport: stdio, streamable-http, of sse. Standaard stdio. |
migrate-links¶
Herschrijf vertaalde Markdown-bestanden en werk notebooklinks bij zodat ze naar vertaalde notebooks verwijzen wanneer beschikbaar.
Veelvoorkomende voorbeelden¶
Voorvertoning van linkupdates:
Verwerk alle ondersteunde talen zonder bevestiging:
Herschrijf links alleen wanneer vertaalde notebooks bestaan:
Opties¶
| Option | Required | Description |
|---|---|---|
-l, --language-codes |
Yes | Spatie-gescheiden taalcodes, of "all". |
-r, --root-dir |
No | Projectroot. Standaard de huidige map. |
--image-dir |
No | Vertaalde afbeeldingsmap relatief aan de root. Standaard translated_images. |
--dry-run |
No | Toon bestanden die zouden veranderen zonder updates te schrijven. |
--fallback-to-original, --no-fallback-to-original |
No | Gebruik originele notebooklinks wanneer vertaalde notebooks ontbreken. Standaard ingeschakeld. |
-d, --debug |
No | Debug-logging inschakelen. |
-s, --save-logs |
No | DEBUG-niveau logs opslaan onder <root-dir>/logs/. |
-y, --yes |
No | Prompts automatisch bevestigen bij het verwerken van alle talen. |
Omgeving¶
Alle commando's vereisen één geconfigureerde LLM-provider:
# 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"
# Of OpenAI
OPENAI_API_KEY="..."
OPENAI_CHAT_MODEL_ID="gpt-4o"
Afbeeldingvertaling vereist bovendien Azure AI Vision:
AZURE_AI_SERVICE_API_KEY="..."
AZURE_AI_SERVICE_ENDPOINT="https://<resource>.cognitiveservices.azure.com/"
Uitvoerlayout¶
Tekstvertalingen worden weggeschreven onder:
Vertaalde afbeeldingsuitvoer wordt weggeschreven onder:
Bijvoorbeeld, het vertalen van README.md en docs/setup.md naar Koreaans produceert:
Kopieer-en-plak CLI-voorbeelden¶
Markdown naar drie talen vertalen:
Alleen notebooks vertalen:
Alleen afbeeldingen vertalen:
Markdownvertaling voorvertonen zonder bestanden te schrijven:
Markdownvertalingen met lage betrouwbaarheid repareren:
CI-vriendelijke Markdownvertaling uitvoeren:
Vertaald uitvoer beoordelen:
Voorvertoning van linkmigratie: