7  CLI工具

7.1 简介

CLI工具是一种命令行工具，可以通过命令行方式进行操作。对于大部分IDE工具，例如Cursor IDE，都可以通过CLI工具进行操作。很多开发者会在网上分享一些CLI工具的安装和使用方法，成为开源社区的一部分。

CLI工具可以执行多种类型的语言命令，例如Python、JavaScript、TypeScript等。因此，理论上只要用户安装了对应CLI工具所需的程序语言、程序包、环境和依赖库，就可以执行对应的CLI语言命令。

7.2 MathPix CLI工具

Mathpix https://mathpix.com/ 提供快速精准的 PDF 和图像转换为可搜索、可导出、可机读文本的解决方案，适用于开发者和研究人员。开发者可通过集成 OCR 技术，实现包括数学、化学、手写、表格、外语及完整 PDF 文档转换等功能。

Mathpix 支持完整 PDF 转换为 Markdown/LaTeX，并对手写文本、表格等提供高精度支持。Mathpix 提供多种转换功能，包括 PDF 转 DOCX、Excel、Google Sheets、HTML、LaTeX 等。

Mathpix CLI工具特别适用于：

  1. 学术研究：将PDF论文转换为可编辑的Markdown或LaTeX格式
  2. 文档处理：批量处理包含数学公式的文档
  3. 内容迁移：将纸质文档数字化
  4. 格式转换：在不同文档格式间进行转换
  5. 自动化工作流：集成到CI/CD流程中进行文档处理

通过Mathpix CLI工具，开发者可以在IDE中直接处理包含数学公式、表格和复杂格式的文档，大大提高了工作效率。

用户可以使用多种方式使用Mathpix，包括：

  • 使用Mathpix官网的在线转换功能；
  • 使用Mathpix CLI工具；
  • 使用Mathpix API；

7.2.1 Mathpix CLI工具安装

为了更方便地在IDE工具（例如Cursor IDE、VS Code等）中使用Mathpix，可以使用Mathpix CLI工具。

Mathpix CLI工具的github仓库：mathpix-cli。

根据官方文档说明，安装Mathpix CLI工具的步骤如下：

  1. 全局安装Mathpix CLI工具
npm install -g @mathpix/mpx-cli
  1. 登录Mathpix账户

首先在 https://accounts.mathpix.com 注册账户，然后运行登录命令：

mpx login

系统会要求输入Mathpix邮箱和密码，然后保存授权令牌用于后续操作（对于windows用户，会保存在c:<username>.mpx-cli）。

  1. 设置API密钥（可选）

也可以使用Mathpix API账户，从 https://accounts.mathpix.com/ocr-api 创建API密钥，然后设置环境变量：

export MATHPIX_OCR_API_KEY=your_api_key_here

或者永久保存到配置文件中：

mpx set-api-key your_api_key_here

7.2.2 主要功能和使用方法

  1. PDF文档转换

将PDF文件转换为可编辑的Mathpix Markdown、DOCX、HTML或LaTeX格式：

# PDF转Markdown
mpx convert input-file.pdf output-file.mmd

# PDF转DOCX
mpx convert input-file.pdf output-file.docx

# PDF转LaTeX
mpx convert input-file.pdf output-file.tex

# PDF转HTML
mpx convert input-file.pdf output-file.html
  1. 图像文件转换

将图像文件转换为可编辑格式：

# 图像转Markdown
mpx convert input-file.png output-file.mmd
mpx convert input-file.jpeg output-file.mmd

# 图像转DOCX
mpx convert input-file.png output-file.docx

# 图像转LaTeX
mpx convert input-file.jpeg output-file.tex

# 图像转HTML
mpx convert input-file.png output-file.html
  1. Markdown文件编译

编译Markdown文件为其他格式（无需使用Mathpix OCR）：

# Markdown转DOCX
mpx convert input-file.mmd output-file.docx

# Markdown转LaTeX
mpx convert input-file.mmd output-file.tex

# Markdown转HTML
mpx convert input-file.mmd output-file.html

# Markdown转PDF
mpx convert input-file.mmd output-file.pdf
mpx convert input-file.mmd output-file.pdf --pdf-method html
  1. 本地服务器预览

在本地服务器上预览渲染的HTML文件：

# 预览整个目录
mpx serve ./input-dir

# 预览单个文件
mpx serve ./input-dir/example.mmd
  1. 静态网站构建

将Markdown文件目录构建为静态HTML网站：

mpx build ./input-dir ./output-dir
  1. 常用命令

查看所有可用命令和选项：

mpx --help

主要命令包括： - build - 构建静态HTML网站 - convert - 文件格式转换 - serve - 本地服务器预览 - set-api-key - 设置API密钥 - unset-api-key - 移除API密钥 - login - 登录账户 - logout - 登出账户