ndi-cli 0.4.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ndi_cli/__init__.py +9 -0
- ndi_cli/_cli.py +166 -0
- ndi_cli/_config.py +94 -0
- ndi_cli/_docops.py +443 -0
- ndi_cli/_jobs.py +106 -0
- ndi_cli/_local.py +130 -0
- ndi_cli/_login.py +47 -0
- ndi_cli/_output.py +128 -0
- ndi_cli/_render.py +679 -0
- ndi_cli/_sources.py +154 -0
- ndi_cli/_tools.py +210 -0
- ndi_cli/_workspace.py +226 -0
- ndi_cli/commands.py +23 -0
- ndi_cli-0.4.0.dist-info/METADATA +86 -0
- ndi_cli-0.4.0.dist-info/RECORD +18 -0
- ndi_cli-0.4.0.dist-info/WHEEL +4 -0
- ndi_cli-0.4.0.dist-info/entry_points.txt +3 -0
- ndi_cli-0.4.0.dist-info/licenses/LICENSE +21 -0
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ndi-cli
|
|
3
|
+
Version: 0.4.0
|
|
4
|
+
Summary: NDI platform CLI: document operations, jobs, workspaces, and the agent workspace tools
|
|
5
|
+
Keywords: ndi,cli,document-intelligence,coding-agents
|
|
6
|
+
Author: Nace AI
|
|
7
|
+
Author-email: Nace AI <engineering@nace.ai>
|
|
8
|
+
License-Expression: MIT
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
16
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
17
|
+
Classifier: Typing :: Typed
|
|
18
|
+
Requires-Dist: ndi-sdk>=0.20,<1
|
|
19
|
+
Requires-Python: >=3.11, <3.14
|
|
20
|
+
Project-URL: Homepage, https://ndi-api.nace.ai
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
|
|
23
|
+
# ndi-cli
|
|
24
|
+
|
|
25
|
+
`ndi` — the NDI platform CLI. Document operations, jobs, and workspace
|
|
26
|
+
lifecycle wrap the same `/v1` methods as `ndi-sdk`. The six workspace tools
|
|
27
|
+
also run inside an agent sandbox; every other verb is refused there.
|
|
28
|
+
|
|
29
|
+
## Setup
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
ndi login # browser device-code; writes ~/.ndi/config.toml
|
|
33
|
+
export NDI_BASE_URL="https://ndi-api.nace.ai" # optional; default shown
|
|
34
|
+
export NDI_WORKSPACE_ID="<workspace uuid>" # or: ndi workspace use <id>
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
`$NDI_API_KEY` still wins over the file. `$NDI_CONFIG_PATH` overrides the
|
|
38
|
+
config location. Workspace-scoped verbs also take `--workspace ID`.
|
|
39
|
+
|
|
40
|
+
## Commands
|
|
41
|
+
|
|
42
|
+
| Command | Use |
|
|
43
|
+
|---|---|
|
|
44
|
+
| `ndi login` | Authorize and save the API key |
|
|
45
|
+
| `ndi version` | CLI + SDK versions |
|
|
46
|
+
| `ndi upload FILE` | Stage bytes; prints `ndi://upload/<id>` |
|
|
47
|
+
| `ndi parse SOURCE` | Markdown / text / blocks |
|
|
48
|
+
| `ndi extract SOURCE -s SCHEMA` | Structured extract (`--validate` checks a schema with no job) |
|
|
49
|
+
| `ndi split SOURCE --class id:label` | Logical sections |
|
|
50
|
+
| `ndi classify SOURCE --class id:label` | Labels (refuses `jobid://`) |
|
|
51
|
+
| `ndi ground SOURCE --target id=TEXT` | Locate quoted text |
|
|
52
|
+
| `ndi job ID` / `ndi jobs` / `ndi cancel ID` | Inspect or cancel jobs |
|
|
53
|
+
| `ndi workspace create\|list\|get\|stats\|delete\|use` | Workspace lifecycle |
|
|
54
|
+
| `ndi files upload\|list\|get\|delete` | Workspace files (`--ingest` uploads then queues ingestion) |
|
|
55
|
+
| `ndi ingest` | Queue ingestion |
|
|
56
|
+
| `ndi deep-search QUERY` / `ndi fact-search QUERY` | Agentic / single-shot search |
|
|
57
|
+
| `ndi folder-metadata` / `file-metadata` / `read-file` / `ask-file` / `run-sql` / `hybrid-search` | Read-only workspace tools (the sandbox surface) |
|
|
58
|
+
|
|
59
|
+
## Sources
|
|
60
|
+
|
|
61
|
+
`SOURCE` for document ops:
|
|
62
|
+
|
|
63
|
+
- local file — uploaded, then the handle is used
|
|
64
|
+
- directory — supported files, one job each (`-j N`, default 4)
|
|
65
|
+
- `https://...` — fetched by the server
|
|
66
|
+
- `ndi://upload/<uuid>` — a prior `ndi upload`
|
|
67
|
+
- `jobid://<uuid>` or a bare UUID — reuse a parse job (not classify)
|
|
68
|
+
- `ws://<file_id>` — a workspace file (needs a workspace)
|
|
69
|
+
- `-` — a `jobid://` / UUID line, or raw bytes with `--file-name`
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
ndi parse a.pdf -o id | ndi extract - -s schema.json
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Output
|
|
76
|
+
|
|
77
|
+
Result content goes to **stdout**; status (`job <id> queued`, `saved …`) goes
|
|
78
|
+
to **stderr**. `-o auto|md|json|payload|id` picks the shape. `--json` is an
|
|
79
|
+
alias for `-o json`. `--save PATH` / `--out-dir DIR` write files. `--async`
|
|
80
|
+
submits and prints the job id.
|
|
81
|
+
|
|
82
|
+
API failures exit 1. Usage / config errors exit 2. Schema-validation
|
|
83
|
+
failures also show up to five field constraints, each limited to 500
|
|
84
|
+
characters; request input and unrelated error-detail fields are omitted.
|
|
85
|
+
|
|
86
|
+
See `SKILL.md` for the agent-facing guide to the six workspace tools.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
ndi_cli/__init__.py,sha256=3fUtOInjlpCfL-f6-dSfUFA2IM4cxL1X5nHbTrEPXxk,307
|
|
2
|
+
ndi_cli/_cli.py,sha256=qiL3uXjbCUCwquZ98qc7008Y3rl-xfX4RzDvkvIr-BM,6923
|
|
3
|
+
ndi_cli/_config.py,sha256=DsbbgWQvUmclrohr0_wbdrH20nMcnY-_NxA-GiYqfCQ,3460
|
|
4
|
+
ndi_cli/_docops.py,sha256=YPJVNUEa1-hxZ_jvbg2bGwW38BBeTpqjeSOqh7uz3fc,17742
|
|
5
|
+
ndi_cli/_jobs.py,sha256=n1vd8pe3SK5uVfEkU6xoFbW2W-kzDcUA5djl3BfyJVo,4369
|
|
6
|
+
ndi_cli/_local.py,sha256=4AXIKpR88h738guv62LJsS8QICuk_fgq5Np1oSwsYM4,4750
|
|
7
|
+
ndi_cli/_login.py,sha256=hbCTD8O1PZ9WQvhnyikt4QXC2jhXzG2rqveFlprIUuc,1505
|
|
8
|
+
ndi_cli/_output.py,sha256=_lyarz87jN4AFro-WNAHy9huLcbbnqHsT9KSDM64l-o,4581
|
|
9
|
+
ndi_cli/_render.py,sha256=PMLUm6qCi8otrYNzlFLEVYROySqNE5inWIuDJSODlLU,30417
|
|
10
|
+
ndi_cli/_sources.py,sha256=erxG7Ddne66T_4JzjhKqYVheatTOoae0nyzzg_04Puo,5450
|
|
11
|
+
ndi_cli/_tools.py,sha256=UzH7dOO4MKuaoRamXzOECDwn2O7CQNcNmWjLZcm-MIM,9802
|
|
12
|
+
ndi_cli/_workspace.py,sha256=sniLlJoYlyPLdCq9EMxgXiijrFvFJ9MaT-3FpFVHknw,10707
|
|
13
|
+
ndi_cli/commands.py,sha256=Cnon_kvyt8UMPLa1RwJtT0iBqJrF498CjgUjKIHmlfg,754
|
|
14
|
+
ndi_cli-0.4.0.dist-info/licenses/LICENSE,sha256=G9_ltpdqkmEvYqlN_39GUzHEJCjkrApP6bWKI7d3rcs,1064
|
|
15
|
+
ndi_cli-0.4.0.dist-info/WHEEL,sha256=Hw8zGdV8JFU8a1SvxUgkEWcCqmicFybt1k02k8X8S2M,81
|
|
16
|
+
ndi_cli-0.4.0.dist-info/entry_points.txt,sha256=m_aG5Vw5ZCer5sFp2y2rZ2PFMwafsfKff5Ft48rzZnU,43
|
|
17
|
+
ndi_cli-0.4.0.dist-info/METADATA,sha256=GxsXx3WwfEV4aKnbxvdQA0OT0c0eeyh5h3Cd4q-ypRE,3636
|
|
18
|
+
ndi_cli-0.4.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Nace AI
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|