Skip to content

Commit b4f2098

Browse files
theAPILifeclaude
authored andcommitted
Apply docs-reviewer feedback to CLI page
- Add description to frontmatter - Add "This page shows you" opening summary - Replace redundant MIT callout with Node.js prerequisite note - Make capabilities table verbs parallel (all imperative) - Remove bold-before-colon pattern in developer features - Add context line before git hooks example - Add cross-reference to "Your first API request" Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 67fa9db commit b4f2098

1 file changed

Lines changed: 23 additions & 18 deletions

File tree

docs/getting-started/deepl-cli.mdx

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,25 @@
11
---
22
title: "DeepL CLI"
3+
description: "Install and use the DeepL CLI to translate text, documents, and more from your terminal."
34
public: true
45
---
56

6-
The [DeepL CLI](https://github.com/DeepLcom/deepl-cli) is an open-source (MIT license) command-line tool for interacting with the DeepL API. It covers text translation, document translation, writing enhancement, voice translation, glossary management, and admin operations — all from your terminal.
7+
**This page shows you:**
8+
- How to install the DeepL CLI from source
9+
- How to authenticate and run your first translation
10+
- What commands are available for translation, writing, voice, and more
711

8-
<Info>
9-
The DeepL CLI is open-source under the [MIT License](https://github.com/DeepLcom/deepl-cli/blob/main/LICENSE). Contributions and feedback are welcome!
10-
</Info>
12+
The [DeepL CLI](https://github.com/DeepLcom/deepl-cli) is an open-source (MIT license) command-line tool for interacting with the DeepL API. It covers text translation, document translation, writing enhancement, voice translation, glossary management, and admin operations — all from your terminal.
1113

1214
## Installation
1315

16+
<Note>
17+
The CLI requires [Node.js](https://nodejs.org/) (v18+) and build tools for native compilation:
18+
- **macOS**: Xcode Command Line Tools (`xcode-select --install`)
19+
- **Linux**: `python3`, `make`, `gcc` (`apt install python3 make gcc g++`)
20+
- **Windows**: Visual Studio Build Tools
21+
</Note>
22+
1423
```bash
1524
git clone https://github.com/DeepLcom/deepl-cli.git
1625
cd deepl-cli
@@ -21,13 +30,6 @@ npm link
2130
deepl --version
2231
```
2332

24-
<Note>
25-
The CLI uses `better-sqlite3` for local caching, which requires native compilation. Ensure you have build tools installed:
26-
- **macOS**: Xcode Command Line Tools (`xcode-select --install`)
27-
- **Linux**: `python3`, `make`, `gcc` (`apt install python3 make gcc g++`)
28-
- **Windows**: Visual Studio Build Tools
29-
</Note>
30-
3133
## Quick start
3234

3335
### 1. Set up authentication
@@ -69,10 +71,10 @@ deepl write "Their going to the stor tommorow" --lang en-us
6971
| Command | Description |
7072
|---------|-------------|
7173
| `deepl translate` | Translate text with support for formality, context, and custom instructions |
72-
| `deepl translate --file` | Translate text files (preserves code blocks and formatting) |
74+
| `deepl translate --file` | Translate text files while preserving code blocks and formatting |
7375
| `deepl document` | Translate documents (PDF, DOCX, PPTX, XLSX) with format preservation |
74-
| `deepl write` | Grammar and style enhancement via DeepL Write |
75-
| `deepl voice` | Real-time speech translation via WebSocket streaming |
76+
| `deepl write` | Enhance grammar and style via DeepL Write |
77+
| `deepl voice` | Stream real-time speech translation via WebSocket |
7678
| `deepl watch` | Monitor files and auto-translate on change |
7779
| `deepl glossary` | Create, list, and manage glossaries |
7880
| `deepl admin` | Manage API keys, usage limits, and team access |
@@ -108,19 +110,22 @@ deepl watch ./content/en --to de,fr --output ./content/
108110

109111
### Git hooks integration
110112

113+
Automatically translate changed files before each commit:
114+
111115
```bash
112116
deepl hooks install --pre-commit --languages de,fr
113117
```
114118

115119
## Developer workflow features
116120

117-
- **Smart caching**: Local SQLite cache with LRU eviction avoids redundant API calls
118-
- **Cost tracking**: Monitor billed characters for budget planning (`deepl usage`)
119-
- **CI/CD ready**: `--quiet` and `--no-input` flags for non-interactive pipelines
120-
- **Shell completion**: Generate completions for bash, zsh, fish, and PowerShell
121+
- Local SQLite cache with LRU eviction avoids redundant API calls
122+
- Monitor billed characters for budget planning with `deepl usage`
123+
- Use `--quiet` and `--no-input` flags for CI/CD pipelines
124+
- Generate shell completions for bash, zsh, fish, and PowerShell
121125

122126
## Further reading
123127

124128
- [DeepL CLI on GitHub](https://github.com/DeepLcom/deepl-cli) — full documentation, changelog, and source code
125129
- [DeepL API authentication](/docs/getting-started/auth) — set up your API key
130+
- [Your first API request](/docs/getting-started/your-first-api-request) — understand how the API works
126131
- [Client libraries](/docs/getting-started/client-libraries) — official SDKs for six languages

0 commit comments

Comments
 (0)