deepl-cli CLAUDE.md

A set of instructions for DeepL CLI, a command-line program for translating text and improving writing through the DeepL service. It describes commands for translation, writing, voice, file handling, glossaries, translation memory, and synchronization.

In plain words
What is it for?
Use it when developing, testing, linting, or documenting DeepL CLI and its services for translation, writing improvement, voice, files, glossaries, and translation memory.
Why use it?
It gives an agent the project's architecture, testing expectations, and source of version information before making changes.

Instructions file

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/deepl/deepl-cli/claude-md
Clone the repo
git clone --depth 1 https://github.com/DeepL/deepl-cli
Per session 2,869 This file is loaded in full into every session.
When invoked 2,869 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.02869 $0.02869
Opus 5 $0.01435 $0.01435
Sonnet 5 $0.00574 $0.00574
Haiku 4.5 $0.00287 $0.00287

Measured 2d ago against content hash 487c2628110b, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

deepl-cli CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 276 lines

How it starts

The opening of the file, as written. The whole thing — 276 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Claude Code Project Configuration

Project Overview

DeepL CLI is a command-line interface for the DeepL API that integrates translation, writing enhancement (DeepL Write API), and developer workflow automation.

Current Status

  • Version: see package.json (the single source of truth; src/version.ts reads it at runtime)
  • Tests: see npm test output (target: all green; coverage thresholds enforced by jest config)
  • Test mix: ~70-75% unit, ~25-30% integration/e2e

Architecture

CLI Commands (translate, write, voice, sync, watch, glossary, tm, …)
           ↓
Service Layer (Translation, Write, Voice, VoiceStreamSession, Batch, Watch,
               Glossary, TranslationMemory, StyleRules, Admin, Document,
               FileTranslation, StructuredFileTranslation, GitHooks, Usage,
               Detect, Languages)
           ↓                         ↓
Sync Engine (src/sync —        Format Parsers (src/formats — 11 i18n formats)
  incl. TmsClient)
           ↓                         ↓
API Client (Translate, Write, Glossary, Document, Voice,
            StyleRules, Admin)
           ↓
Storage (node:sqlite Cache, Config) + Static Data (src/data — language registry)

Configuration

  • Config: XDG default ~/.config/deepl-cli/config.json, legacy ~/.deepl-cli/config.json
  • Cache: XDG default ~/.cache/deepl-cli/cache.db, legacy ~/.deepl-cli/cache.db
  • Path priority: DEEPL_CONFIG_DIR > legacy ~/.deepl-cli/ > XDG env vars > XDG defaults
  • Environment Variables:
    • DEEPL_API_KEY - API authentication
    • DEEPL_CONFIG_DIR - Override config and cache directory (used for test isolation)
    • XDG_CONFIG_HOME - Override XDG config base (default: ~/.config)
    • XDG_CACHE_HOME - Override XDG cache base (default: ~/.cache)
    • NO_COLOR - Disable colored output

Key Project Files

  • CHANGELOG.md - Release history and version notes
  • docs/API.md - Complete CLI command reference
  • docs/MIGRATION.md - 1.x → 2.0.0 upgrade guide; update it with any breaking change
  • docs/SYNC.md - Continuous-localization reference and .deepl-sync.yaml schema
  • docs/TROUBLESHOOTING.md - Diagnostics for common failures
  • CONTRIBUTING.md - Contributor workflow and PR checklist
  • SECURITY.md - Supported versions and vulnerability reporting

Read the full file on GitHub · 276 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 276 lines · 2,869 tokens per session scan A 487c2628110b

Subscribe to this mod's changes

deepl-cli CLAUDE.md is an instructions file published in the GitHub repository DeepL/deepl-cli (40 stars, last pushed 7d ago), licensed MIT. It adds 2,869 tokens to every session, about $0.0143 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.