PDF scientific paper translation and bilingual comparison library.

• Online Service: Beta version launched Immersive Translate - BabelDOC Free usage quota is available; please refer to the FAQ section on the page for details.
• Self-deployment: PDFMathTranslate-next support for BabelDOC, available for self-deployment + WebUI with more translation services.
• Provides a simple command line interface.
• Provides a Python API.

Mainly designed to be embedded into other programs, but can also be used directly for simple translation tasks.

Tip: How to use BabelDOC in Zotero

• Immersive Translate Pro members can use the immersive-translate/zotero-immersivetranslate plugin
• PDFMathTranslate self-deployed users can use the guaguastandup/zotero-pdf2zh plugin

Using BabelDOC via Command Line (CLI)

Method 1: Using uv tool install

We recommend using the Tool feature of uv to install yadt.

1. First, you need to refer to uv installation to install uv and set up the PATH environment variable as prompted.
2. Use the following command to install yadt:

uv tool install --python 3.12 BabelDOC
babeldoc --help```
3. Use the `babeldoc` command. For example:
```bash
babeldoc --openai --openai-model "gpt-4o-mini" --openai-base-url "https://api.openai.com/v1" --openai-api-key "your-api-key-here" --files example.pdf
# multiple files
babeldoc --openai --openai-model "gpt-4o-mini" --openai-base-url "https://api.openai.com/v1" --openai-api-key "your-api-key-here" --files example1.pdf --files example2.pdf

Method 2: Using uv run (Recommended)

We still recommend using uv to manage virtual environments.

1. First, you need to refer to uv installation to install uv and set up the PATH environment variable as prompted.
2. Use the following command to install yadt:

# clone the project
git clone https://github.com/funstory-ai/BabelDOC
# enter the project directory
cd BabelDOC
# install dependencies and run babeldoc
uv run babeldoc --help

3. Use the uv run babeldoc command. For example:

uv run babeldoc --files example.pdf --openai --openai-model "gpt-4o-mini" --openai-base-url "https://api.openai.com/v1" --openai-api-key "your-api-key-here"
# multiple files
uv run babeldoc --files example.pdf --files example2.pdf --openai --openai-model "gpt-4o-mini" --openai-base-url "https://api.openai.com/v1" --openai-api-key "your-api-key-here"

CLI Options Reference

Tip: The absolute path is recommended.

Note: This CLI is mainly for debugging purposes. Although end users can use this CLI to translate files, we do not provide any technical support for this purpose.

• End users should directly use Online Service: Beta version launched Immersive Translate - BabelDOC 1000 free pages per month.
• End users who need self-deployment should use PDFMathTranslate 2.0
• If you find that an option is not listed below, it means that this option is a debugging option for maintainers. Please do not use these options.

Option	Short	Description	Default
--lang-in	-li	Source language code	en
--lang-out	-lo	Target language code	zh

Tip: Currently, this project mainly focuses on English-to-Chinese translation, and other scenarios have not been tested yet.
(2025.3.1 update): Basic English target language support has been added, primarily to minimize line breaks within words([0-9A-Za-z]+).

Option	Description
--files	One or more file paths to input PDF documents.
--pages	-p: Specify pages to translate (e.g.,