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 和系統安全存儲管理。
  • 批次、覆蓋、下載和移動文件前,先確認目標範圍、頁序與輸出路徑。

下一步