ade-cli

ade-cli

Agentic Document Extraction (ADE), from your terminal. Run ade parse to turn documents with tables, figures, and charts into grounded Markdown and elements, and ade extract to pull schema-shaped fields with page-and-box evidence. Both save to a local store at ~/.ade, so re-running an identical command consumes no credits.

CLI documentation · Playground · Get an API key

Install

Each release ships self-contained binaries for macOS, Linux, and Windows (arm64 and x86_64). No Python or uv needed.

macOS / Linux

curl -fsSL https://raw.githubusercontent.com/landing-ai/ade-cli/main/scripts/install.sh | sh

Windows (PowerShell)

irm https://raw.githubusercontent.com/landing-ai/ade-cli/main/scripts/install.ps1 | iex

Windows (CMD)

curl -fsSL https://raw.githubusercontent.com/landing-ai/ade-cli/main/scripts/install.cmd -o install.cmd && install.cmd && del install.cmd

To develop or install from source, see CONTRIBUTING.md.

First run

Log in once per machine, parse a document, then extract the fields you want from it. The parse summary prints the job item ID that extract takes.

ade login
ade parse -d invoice.pdf
ade extract JOB_ITEM_ID --schema schema.json

The CLI Quickstart walks through the same three steps with a sample document and a sample schema, and ends in the viewer that shows where each extracted value came from.

Commands

Every command takes --json for one stable JSON object on stdout. Run ade help COMMAND for its flags and result shape, or see the CLI Reference.

command	what it does
ade parse	Parse a document into Markdown, elements, and grounding
ade extract	Pull schema-shaped fields from a parse, with per-field evidence
ade find	Search a parse's elements locally, with no API call
ade crop	Save an element's region of the page as a PNG
ade view	Build and open a self-contained HTML viewer for a job item
ade history list	List stored job items, newest first
ade history clear	Delete stored job items
ade login / ade auth login	Log in with your browser or an API key
ade auth status	Show how you are authenticated and where
ade auth org list / switch / clear	Choose which organization your runs act in
ade logout / ade auth logout	Log out of one environment, or all of them
ade version	Print the version and install mode
ade update	Self-update to the latest release
ade help	Print the whole command surface, including --json result shapes

The documentation covers what these tables cannot: how job items work and why re-runs are free (CLI Concepts), parsing and extraction in depth, searching and cropping evidence, authentication and organizations, and scripting the CLI.

For agents

Agents are first-class callers. Running ade help --json returns the entire shipped surface in one call: every command, flag, result shape, topic, exit state, and the store layout. Every command then takes --json and emits one stable object whose shape is published per verb, and the full result is always on stdout rather than only in a store file. SKILL.md ships the agent contract: the loop, the conventions, and the sharp edges.

A process that is already running keeps the environment it started with, so ade may not be on the PATH inside CI, cron, or an agent harness. Call the absolute path instead: ~/.ade/bin/ade on macOS and Linux, or %USERPROFILE%\.ade\bin\ade.exe on Windows. For credentials, set ADE_API_KEY.

Managing your install

	macOS and Linux	Windows
App	~/.ade/bin/ade	%USERPROFILE%\.ade\bin\ade.exe
Store	~/.ade	%USERPROFILE%\.ade
Reaches your PATH via	a symlink in ~/.local/bin	a user PATH entry

Set ADE_HOME to move the app and the store, ADE_CLI_VERSION to pin a version, and ADE_CLI_INSTALL_DIR to change the destination.

Run ade update to self-update, with --yes to skip the confirmation. For a uv or pipx install it points at uv tool upgrade ade-cli instead. The CLI mentions new releases on stderr once a day. Set ADE_NO_UPDATE_CHECK=1 to turn that off.

To uninstall, remove the app directory, and on macOS and Linux the ~/.local/bin/ade symlink too. Never delete all of .ade: the rest of that directory holds results that already consumed credits.

Project history

This repository was agentic-doc, the original Agentic Document Extraction SDK. That SDK is preserved unchanged, and no longer developed, on the legacy branch. Since 2026-07-31 this repository ships the ADE CLI.

License

Apache-2.0.