Skip to main content

ndi-cli

ndi — the NDI platform CLI. Document operations, jobs, and workspace lifecycle wrap the same /v1 methods as ndi-sdk. The six workspace tools also run inside an agent sandbox; every other verb is refused there.

Setup

ndi login                                          # browser device-code; writes ~/.ndi/config.toml
export NDI_BASE_URL="https://ndi-api.nace.ai"      # optional; default shown
export NDI_WORKSPACE_ID="<workspace uuid>"         # or: ndi workspace use <id>

$NDI_API_KEY still wins over the file. $NDI_CONFIG_PATH overrides the config location. Workspace-scoped verbs also take --workspace ID.

Commands

Command Use
ndi login Authorize and save the API key
ndi version CLI + SDK versions
ndi upload FILE Stage bytes; prints ndi://upload/<id>
ndi parse SOURCE Markdown / text / blocks
ndi extract SOURCE -s SCHEMA Structured extract (--validate checks a schema with no job)
ndi split SOURCE --class id:label Logical sections
ndi classify SOURCE --class id:label Labels (refuses jobid://)
ndi ground SOURCE --target id=TEXT Locate quoted text
ndi job ID / ndi jobs / ndi cancel ID Inspect or cancel jobs
ndi workspace create|list|get|stats|delete|use Workspace lifecycle
ndi files upload|list|get|delete Workspace files (--ingest uploads then queues ingestion)
ndi ingest Queue ingestion
ndi deep-search QUERY / ndi fact-search QUERY Agentic / single-shot search
ndi folder-metadata / file-metadata / read-file / ask-file / run-sql / hybrid-search Read-only workspace tools (the sandbox surface)

Sources

SOURCE for document ops:

  • local file — uploaded, then the handle is used
  • directory — supported files, one job each (-j N, default 4)
  • https://... — fetched by the server
  • ndi://upload/<uuid> — a prior ndi upload
  • jobid://<uuid> or a bare UUID — reuse a parse job (not classify)
  • ws://<file_id> — a workspace file (needs a workspace)
  • - — a jobid:// / UUID line, or raw bytes with --file-name
ndi parse a.pdf -o id | ndi extract - -s schema.json

Output

Result content goes to stdout; status (job <id> queued, saved …) goes to stderr. -o auto|md|json|payload|id picks the shape. --json is an alias for -o json. --save PATH / --out-dir DIR write files. --async submits and prints the job id.

API failures exit 1. Usage / config errors exit 2. Schema-validation failures also show up to five field constraints, each limited to 500 characters; request input and unrelated error-detail fields are omitted.

See SKILL.md for the agent-facing guide to the six workspace tools.

Metadata

Release files for ndi-cli 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ndi-cli 0.5.0
File Size Uploaded
ndi_cli-0.5.0.tar.gz 30.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ndi-cli 0.5.0
File Interpreter ABI Platform
ndi_cli-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 67.7 kB

Release files / ndi_cli-0.5.0.tar.gz

Download URL ndi_cli-0.5.0.tar.gz
Size 30.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0a40356c5f76be837ed577aeedc9efb64706cfa25cecc3a3066bce5aae1f241e
BLAKE2b-256 checksum
How to use checksums
e7a00f25a025c73875639c38e07314478951557d30c2de9620d92545031a4599
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / ndi_cli-0.5.0-py3-none-any.whl

Download URL ndi_cli-0.5.0-py3-none-any.whl
Size 37.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
530196979b735fe9611cccdda78add0a25bfad8dbec05405a6a0505b0ee1a96f
BLAKE2b-256 checksum
How to use checksums
11a3cb077d89c29112cb48f9555d3e7d55e873a221a6473f8a15ca096e75d7bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release history Release notifications | RSS feed

0.29.0

2 release files

0.28.1

2 release files

0.28.0

2 release files

0.27.0

2 release files

0.26.0

2 release files

0.25.0

2 release files

0.13.0

2 release files

0.12.0

2 release files

0.11.0

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.0

2 release files

This release

0.5.0 This release

2 release files

0.4.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page