CLI User Guide
输入“/”快速插入内容
CLI User Guide
CLI User Guide
用户7107用户7107
用户8938用户89386月16日修改
❗
ADP is the Agentic Document Processing product of Laiye Technology Company (Agentic Document Processing, abbreviated as ADP), which, based on the general understanding ability of large models, does not rely on rules and annotations, and has the general understanding ability for multi-language, MultiModal Machine Learning, and multi-scenario; the autonomous planning and execution of the agent can understand task objectives, autonomously plan steps, call tools, and complete complex tasks; end-to-end business automation, from document input to business decision-making and then to human-machine collaboration, forms a complete closed loop.
agentic-doc-parse-and-extract is the official open-source CLI tool of ADP, which supports both manual terminal invocation and automatic invocation by AI Skill. With a single command, it can accomplish: structured document parsing + intelligent extraction of key fields, covering all scenarios including invoices, orders, certificates, bills, and general documents, outputting standard JSON, and seamlessly integrating with automation and AI processes
Install
Install from NPM platform(Recommended)
代码块
npm install -g @laiye-adp/agentic-doc-parse-and-extract-cli
Install from the Github platform script
代码块
# Linux/macOS
curl -fsSL https://raw.githubusercontent.com/laiye-ai/adp-cli/main/scripts/adp-init.sh | bash
# Windows
irm https://raw.githubusercontent.com/laiye-ai/adp-cli/main/scripts/adp-init.ps1 | iex
Manually install from the Github platform
•
Supported platforms: Windows / Linux / macOS (x64 and arm64).
VerifyInstallation:
代码块
adp version
Complete ADP Configuration
Before use, you need to configure the API Key and service address. The configuration information is encrypted and stored using AES-256-GCM in ~/.adp/config.json.
Configuration
代码块
# Set API Key
adp config set --api-key YOUR_API_KEY
# Set API Base URL(Optional, if using private deployment)
adp config set --api-base-url https://your-server.com
View Configuration
代码块
adp config get
API Key will be displayed in masked form.
Clear Configuration
代码块
adp config clear # Confirm
adp config clear -y # No need for confirmation
Document Parsing
Automatically recognize multi-format documents such as PDFs and images, convert messy unstructured content (such as scanned documents, handwritten text, and complex layout documents) into standardized structured data, while retaining the original document hierarchy and key relationships
Command Description:
Parse Local File
代码块
# Parse a single file
adp parse local ./invoice.pdf --app-id APP_ID
# Parse the entire directory (recursively scan all supported files)
adp parse local ./documents/ --app-id APP_ID
# Export the results to a file
adp parse local ./invoice.pdf --app-id APP_ID --export ./result.json
Parse URL
代码块
# Parse a single URL
adp parse url https://example.com/doc.pdf --app-id APP_ID
# Read URLs from the file in batches (one URL per line)
adp parse url ./url_list.txt --app-id APP_ID