Skip to content

CLI

CamScanner CLI 是扫描全能王的文档处理命令行工具。它适合在本地终端、项目脚本、测试任务和自动化流程中调用扫描与图像优化、文字识别、格式转换、PDF 处理、云端保存与文档管理能力。

与 Skill 相比,CLI 提供更直接、可重复的命令调用;与 MCP 相比,CLI 更适合由 Shell、Node.js 脚本或现有工程明确控制输入、参数和输出路径。

适合什么场景

  • 在开发或测试环境中快速验证文档能力。
  • 将固定处理步骤写入脚本或项目命令。
  • 批量转换、合并和整理本地文档。
  • 需要明确控制输出格式、文件路径和云端保存行为。

前置条件

  • 可以使用 npm 安装包的 Node.js 开发环境。
  • macOS、Linux 或 Windows,CPU 架构为 x64 或 arm64。
  • 首次使用时能够打开浏览器完成扫描全能王 OAuth 登录。
  • 待处理文件属于你本人,或你已获得相应的处理权限。

安装方式建议

在项目中使用时,建议本地安装并通过 npx 调用,便于项目锁定版本;需要在多个目录直接使用时,可以选择全局安装。

快速接入

交给 Agent 安装

复制下面的 Prompt,发送给当前 Agent:

text
请帮我在当前环境接入 CamScanner CLI。安装命令是 npm install camscanner-cli。请先识别项目使用的包管理器以及 CLI 应该本地安装还是全局安装,说明将修改哪些文件后再执行;不要替换现有锁文件。安装完成后运行可用的 help 或 version 命令验证,并告诉我后续如何调用。

安装到当前项目

在需要使用 CamScanner CLI 的项目目录中执行:

bash
npm install camscanner-cli

安装完成后通过 npx 调用:

bash
npx camscanner-cli --version

安装包会根据当前操作系统和 CPU 架构选择对应的原生可执行文件。请勿使用 --omit=optional,否则平台对应的二进制依赖可能不会安装。

全局安装

如果希望在任意目录直接运行:

bash
npm install -g camscanner-cli
camscanner-cli --version

下文统一使用 camscanner-cli 展示命令。本地安装时,在每条命令前添加 npx 即可。

登录

检查当前登录状态:

bash
camscanner-cli auth status

如果尚未登录或登录已过期:

bash
camscanner-cli auth login

登录命令会打开浏览器,并在你完成授权后返回。不要将登录命令放到后台执行。完成后再次验证:

bash
camscanner-cli auth status

需要退出当前账号时:

bash
camscanner-cli auth logout

命令结构

bash
camscanner-cli <group> <command> [file...] [flags]
命令组用途
image扫描与图像优化、OCR、转换、翻译、检测、编辑和多图合并
pdfPDF 转换、逐页转图片、水印处理
txt文本转换
doc云文档搜索、下载、移动和文件夹查询
auth登录状态与账号授权管理

查看总帮助或某个命令组的帮助:

bash
camscanner-cli --help
camscanner-cli image --help
camscanner-cli pdf --help

常用命令

图片 OCR

bash
camscanner-cli image ocr document.jpg

将识别结果写入本地文本文件:

bash
camscanner-cli image ocr document.jpg > result.txt

图片转 Word 或 Excel

bash
camscanner-cli image convert document.jpg --format word -o result.docx
camscanner-cli image convert table.png --format excel -o result.xlsx

PDF 转 Word 或 Markdown

bash
camscanner-cli pdf convert report.pdf --format word -o report.docx
camscanner-cli pdf convert paper.pdf --format md -o paper.md

扫描件去阴影

bash
camscanner-cli image enhance scan.jpg --mode 5 -o enhanced.jpg

多图合并为 PDF

bash
camscanner-cli image merge-pdf "page1.jpg" "page2.jpg" "page3.jpg" -o merged.pdf

请显式列出文件并确认顺序。单次最多处理 100 张图片,不要使用顺序不确定的 *.jpg 通配符。

图片翻译

bash
camscanner-cli image translate menu.jpg --lang zh -o menu-zh.jpg

发票与票据识别

bash
camscanner-cli image receipt invoice.jpg

搜索云文档

bash
camscanner-cli doc search "合同"

下载或移动云文档前,应先展示搜索结果并确认目标文档,避免操作错误文件。

输出到本地或云端

常用输出参数:

参数行为
-o, --output <path>将结果保存到指定本地路径
-s, --save将结果保存到扫描全能王云空间
--save-title <title>指定云文档标题
--save-dir <name>按文件夹名称指定云端保存位置
--save-dir-id <id>按文件夹 ID 指定云端保存位置

本地和云端可以同时保存:

bash
camscanner-cli pdf convert contract.pdf \
  --format word \
  -o contract.docx \
  -s \
  --save-title "采购合同-可编辑版"

如果只传 -s,结果只保存到云端;如果只传 -o,结果只保存到本地。并非所有输出类型都支持 -s,请使用 --help 确认当前命令的参数。

注意同名文件

-o 指向已有文件时可能直接覆盖。自动化脚本应提前检查路径,或为新结果生成不会冲突的文件名。

在脚本中使用

CLI 会通过退出码表示命令是否成功,可以直接接入现有 Shell 或 CI 流程。建议脚本明确指定输入和输出路径,并保留错误输出用于排查。

首次运行需要浏览器 OAuth 登录。对于无人值守环境,请先确认执行环境已经安全地完成授权;不要把本地凭据、访问令牌或认证目录提交到代码仓库。目前公开接入流程未提供在文档中直接配置明文 Token 的方式。

更新与卸载

项目内安装:

bash
npm update camscanner-cli
npm uninstall camscanner-cli

全局安装:

bash
npm install -g camscanner-cli@latest
npm uninstall -g camscanner-cli

更新后运行 camscanner-cli --version,确认实际调用的是预期版本。如果项目内和全局都安装过,请同时检查 npx camscanner-cli --versioncamscanner-cli --version

常见问题

安装成功但找不到命令

项目内安装不会自动提供全局命令,请使用 npx camscanner-cli。全局安装后仍找不到命令时,检查 npm 的全局可执行目录是否在 PATH 中。

提示缺少当前平台的二进制包

确认系统为 macOS、Linux 或 Windows,CPU 为 x64 或 arm64,并重新安装。不要忽略 npm 的 optional dependencies,因为对应平台的原生二进制通过可选依赖分发。

登录命令一直等待

auth login 会等待浏览器授权完成,这是正常行为。完成浏览器登录后返回终端;如果授权页面未打开,请检查默认浏览器和网络环境后重试。

文件处理失败

先运行当前命令的 --help 检查参数,再确认文件格式、大小和文件是否损坏。不要对参数错误反复重试。

云端保存到了根目录

通过 --save-dir 指定的文件夹不存在时,CLI 可能降级保存到根目录并输出警告。先执行 camscanner-cli doc dirs 查看可用目录,或使用明确的 --save-dir-id

限制与安全说明

  • 单个上传文件当前不应超过 40 MB。
  • 图片输入支持 JPG、JPEG、PNG;文档输入支持 PDF、TXT、Markdown。
  • PDF 水印操作最多处理 100 页;带密码保护的 PDF 暂不支持。
  • 输入文件会上传到扫描全能王服务端处理;使用 -s 时,结果会保存在当前登录账号中。
  • 不要输出、记录或提交登录 Token。认证信息应交由 CLI 和系统安全存储管理。
  • 批量、覆盖、下载和移动文件前,先确认目标范围、页序与输出路径。

下一步