ndi-cli 0.13.0__tar.gz → 0.16.0__tar.gz

{ndi_cli-0.13.0 → ndi_cli-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ndi-cli
-Version: 0.13.0
+Version: 0.16.0
 Summary: NDI platform CLI: document operations, jobs, workspaces, and the agent workspace tools
 Keywords: ndi,cli,document-intelligence,coding-agents
 Author: Nace AI
@@ -16,7 +16,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Requires-Dist: ndi-sdk>=0.28,<1
+Requires-Dist: ndi-sdk>=0.31,<1
 Requires-Dist: truststore>=0.10.4,<1
 Requires-Python: >=3.11
 Project-URL: Homepage, https://ndi-api.nace.ai
@@ -94,7 +94,14 @@ file ids. A single file still requires `--path`.
 
 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`
+alias for `-o json`.
+
+The default (`auto`) prints the full JSON response. When that is over
+`$NDI_OUTPUT_LIMIT` characters (default 40,000), the compact text rendering
+prints instead and stderr carries `note: output shortened …` with the full
+size. `--json` always prints it whole, and `--save` / `--out-dir` always write
+it whole. Commands whose output is the content itself (`read-file`,
+`ws context`, parse markdown) print it as before. `--save PATH` / `--out-dir DIR` write files. `--async`
 submits and prints the job id.
 
 When a Parse result has external complete content, `-o auto` and `-o md` print

{ndi_cli-0.13.0 → ndi_cli-0.16.0}/README.md

@@ -70,7 +70,14 @@ file ids. A single file still requires `--path`.
 
 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`
+alias for `-o json`.
+
+The default (`auto`) prints the full JSON response. When that is over
+`$NDI_OUTPUT_LIMIT` characters (default 40,000), the compact text rendering
+prints instead and stderr carries `note: output shortened …` with the full
+size. `--json` always prints it whole, and `--save` / `--out-dir` always write
+it whole. Commands whose output is the content itself (`read-file`,
+`ws context`, parse markdown) print it as before. `--save PATH` / `--out-dir DIR` write files. `--async`
 submits and prints the job id.
 
 When a Parse result has external complete content, `-o auto` and `-o md` print

{ndi_cli-0.13.0 → ndi_cli-0.16.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ndi-cli"
-version = "0.13.0"
+version = "0.16.0"
 description = "NDI platform CLI: document operations, jobs, workspaces, and the agent workspace tools"
 readme = "README.md"
 license = "MIT"
@@ -24,7 +24,7 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "ndi-sdk>=0.28,<1",
+    "ndi-sdk>=0.31,<1",
     "truststore>=0.10.4,<1",
 ]
 

{ndi_cli-0.13.0 → ndi_cli-0.16.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "ndi-cli"
-version = "0.13.0"
+version = "0.16.0"
 description = "NDI platform CLI: document operations, jobs, workspaces, and the agent workspace tools"
 authors = [
     { name = "Nace AI", email = "engineering@nace.ai" }
@@ -27,7 +27,7 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "ndi-sdk>=0.28,<1",
+    "ndi-sdk>=0.31,<1",
     "truststore>=0.10.4,<1",
 ]
 

{ndi_cli-0.13.0 → ndi_cli-0.16.0}/src/ndi_cli/__init__.py

@@ -6,4 +6,4 @@ methods. The six workspace tools (``folder-metadata``, ``file-metadata``,
 in-sandbox surface.
 """
 
-__version__ = "0.13.0"
+__version__ = "0.16.0"

{ndi_cli-0.13.0 → ndi_cli-0.16.0}/src/ndi_cli/_cli.py

@@ -17,6 +17,7 @@ from ndi_sdk.resources.tools import SyncTools
 from ndi_cli import _docops, _jobs, _login, _tools, _workspace
 from ndi_cli._config import ConfigError, resolve_settings
 from ndi_cli._local import KG_ENV, SOCKET_ENV, TOKEN_ENV, LocalTransport
+from ndi_cli._output import full_json, output_limit, print_full_or_summary
 from ndi_cli._tools import GraphCommands, parse_pages
 
 # qa-file runs a durable workflow that legitimately takes minutes; the metadata,
@@ -39,6 +40,12 @@ def main(argv: list[str] | None = None) -> int:
     if args.command is None:
         parser.print_help()
         return 2
+    try:
+        # Checked before any request: a job is billed before its output prints.
+        output_limit()
+    except ValueError as exc:
+        print(f"error: {exc}", file=sys.stderr)
+        return 2
     family = getattr(args, "family", None)
     workspace_flag = getattr(args, "workspace", None)
     if workspace_flag is not None and not workspace_flag.strip():
@@ -80,7 +87,7 @@ def main(argv: list[str] | None = None) -> int:
         timeout = getattr(args, "timeout", DEFAULT_TIMEOUT_SECONDS)
         with NdiClient(api_key=settings.api_key, base_url=settings.base_url, timeout=timeout) as client:
             if family == "tool":
-                return _print_tool(args, args.run(client.tools, settings.workspace_id, args))
+                return _print_tool_full(args, args.run(client.tools, settings.workspace_id, args))
             return args.run(client, settings.workspace_id, args)
     except ConfigError as exc:
         print(f"error: {exc}", file=sys.stderr)
@@ -100,13 +107,21 @@ def main(argv: list[str] | None = None) -> int:
 
 
 def _print_tool(args: argparse.Namespace, response) -> int:
+    """The text rendering. An agent run always gets it: the renderings are what its agents are evaluated against."""
     if args.json:
-        print(response.model_dump_json(indent=2, exclude_none=True))
+        print(full_json(response))
         return 0
     print(args.render(response))
     return 0
 
 
+def _print_tool_full(args: argparse.Namespace, response) -> int:
+    """The full JSON response by default, unless the command's rendering is the content itself."""
+    if args.json or getattr(args, "verbatim", False):
+        return _print_tool(args, response)
+    return print_full_or_summary(response, args, lambda: args.render(response))
+
+
 def _validation_error_lines(detail: object) -> list[str]:
     """Keep field constraints actionable without echoing request inputs or arbitrary detail."""
     errors = detail.get("errors") if isinstance(detail, dict) else None
@@ -143,7 +158,9 @@ def _build_parser(*, graph: GraphCommands = "all") -> argparse.ArgumentParser:
         ),
     )
     common = argparse.ArgumentParser(add_help=False)
-    common.add_argument("--json", action="store_true", help="Print the raw response JSON instead of the text rendering.")
+    common.add_argument(
+        "--json", action="store_true", help="Always print the full response JSON, never the shortened text rendering."
+    )
     common.add_argument("--workspace", metavar="ID", default=None, help="Override $NDI_WORKSPACE_ID for this call.")
     common.add_argument(
         "--timeout",

{ndi_cli-0.13.0 → ndi_cli-0.16.0}/src/ndi_cli/_docops.py

@@ -48,7 +48,7 @@ def add_parsers(sub: argparse._SubParsersAction, common: argparse.ArgumentParser
     parse.add_argument("--format", dest="formats", default=None, help="Comma list: markdown,text,blocks.")
     parse.add_argument("--table-format", choices=("html", "markdown"), default="html")
     parse.add_argument("--chunk", choices=("none", "page", "section"), default="none")
-    parse.add_argument("--figures", choices=("omit", "include", "describe"), default="describe")
+    parse.add_argument("--figures", choices=("omit", "include", "describe"), default="include")
     parse.add_argument("--sheets", default=None, help="Comma-separated workbook sheet names.")
     parse.add_argument("--password", default=None, help="PDF password. Never stored.")
     parse.set_defaults(run=_run_parse, family="docops", needs_workspace=False, needs_client=True)

{ndi_cli-0.13.0 → ndi_cli-0.16.0}/src/ndi_cli/_jobs.py

@@ -13,7 +13,7 @@ from ndi_sdk.models.jobs import Job
 from ndi_sdk.resources.jobs import check_terminal
 
 from ndi_cli import _render
-from ndi_cli._output import add_job_output_args, emit_text, output_mode, render_job
+from ndi_cli._output import add_job_output_args, emit_text, full_json, output_mode, render_job, shortened
 
 
 def add_parsers(sub: argparse._SubParsersAction, common: argparse.ArgumentParser) -> None:
@@ -107,15 +107,16 @@ def _run_list(client: NdiClient, workspace_id: str, args: argparse.Namespace) ->
         limit=args.limit,
     )
     mode = output_mode(args)
-    if mode == "json":
-        return emit_text(page.model_dump_json(indent=2, exclude_none=True), args, default_stem="jobs", suffix=".json")
     if mode in ("md", "payload", "id"):
         # A listing is not a job, so these shapes have nothing to render. Say so
         # instead of silently printing the default listing.
         print(f"error: -o {mode} is not available for `jobs`; use auto or json", file=sys.stderr)
         return 2
     # Route through emit_text so --save / --out-dir work here as they do elsewhere.
-    return emit_text(_render.job_page(page), args, default_stem="jobs", suffix=".txt")
+    full = full_json(page)
+    if mode == "auto" and shortened(full, args):
+        return emit_text(_render.job_page(page), args, default_stem="jobs", suffix=".txt")
+    return emit_text(full, args, default_stem="jobs", suffix=".json")
 
 
 def _run_cancel(client: NdiClient, workspace_id: str, args: argparse.Namespace) -> int:

{ndi_cli-0.13.0 → ndi_cli-0.16.0}/src/ndi_cli/_output.py

@@ -2,14 +2,22 @@
 
 from __future__ import annotations
 
+import os
 import sys
 from collections.abc import Callable
 from pathlib import Path
 
 from ndi_sdk.models.jobs import IngestionResult, JetResult, Job, ParseResult
+from pydantic import BaseModel
 
 OUTPUT_CHOICES = ("auto", "md", "json", "payload", "id")
 
+#: Default output is the full JSON response while it stays within this many
+#: characters on stdout. Past it the compact text rendering stands in, so one
+#: command cannot flood a reading agent's context; a stderr note says so.
+FULL_OUTPUT_LIMIT = 40_000
+OUTPUT_LIMIT_ENV = "NDI_OUTPUT_LIMIT"
+
 
 def add_job_output_args(parser) -> None:
     parser.add_argument(
@@ -17,7 +25,10 @@ def add_job_output_args(parser) -> None:
         "--output",
         choices=OUTPUT_CHOICES,
         default="auto",
-        help="Result shape (default auto). --json is an alias for json.",
+        help=(
+            f"Result shape. auto (default) prints the full JSON response, or the text rendering when that is over "
+            f"${OUTPUT_LIMIT_ENV} chars (default {FULL_OUTPUT_LIMIT:,}). --json is an alias for json."
+        ),
     )
     parser.add_argument("--save", default=None, metavar="PATH", help="Write one result to this file.")
     parser.add_argument("--out-dir", default=None, metavar="DIR", help="Write one file per input.")
@@ -30,6 +41,49 @@ def output_mode(args) -> str:
     return getattr(args, "output", None) or "auto"
 
 
+def full_json(model: BaseModel) -> str:
+    return model.model_dump_json(indent=2, exclude_none=True)
+
+
+def shortened(full: str, args, *, get_full: str = "rerun with --json") -> bool:
+    """Whether ``full`` is too long for stdout; if so, tell stderr how to get it.
+
+    A file target is never shortened — the limit protects a reader's context,
+    and ``--save`` / ``--out-dir`` asked for the whole thing. ``get_full`` names
+    the command that prints it whole.
+    """
+    if getattr(args, "save", None) or getattr(args, "out_dir", None):
+        return False
+    limit = output_limit()
+    if len(full) <= limit:
+        return False
+    print(
+        f"note: output shortened — the full response is {len(full):,} chars, over the {limit:,} limit "
+        f"(${OUTPUT_LIMIT_ENV}); {get_full} for all of it",
+        file=sys.stderr,
+    )
+    return True
+
+
+def print_full_or_summary(model: BaseModel, args, summary: Callable[[], str]) -> int:
+    full = full_json(model)
+    print(summary() if shortened(full, args) else full)
+    return 0
+
+
+def output_limit() -> int:
+    raw = os.environ.get(OUTPUT_LIMIT_ENV)
+    if raw is None or not raw.strip():
+        return FULL_OUTPUT_LIMIT
+    try:
+        limit = int(raw)
+    except ValueError:
+        limit = -1
+    if limit < 0:
+        raise ValueError(f"bad ${OUTPUT_LIMIT_ENV} {raw!r}: use a character count (0 always prints the text rendering)")
+    return limit
+
+
 def emit_text(text: str, args, *, default_stem: str, suffix: str) -> int:
     save = getattr(args, "save", None)
     out_dir = getattr(args, "out_dir", None)
@@ -77,20 +131,27 @@ def render_job(job: Job, args, *, auto: Callable[[Job], str], stem: str) -> int:
         print(job.job_id)
         return _content_failure(job)
     if mode == "json":
-        code = emit_text(job.model_dump_json(indent=2, exclude_none=True), args, default_stem=stem, suffix=".json")
+        code = emit_text(full_json(job), args, default_stem=stem, suffix=".json")
     elif mode == "payload":
         if job.result is None:
             print("error: job has no result payload", file=sys.stderr)
             return 1
-        code = emit_text(job.result.model_dump_json(indent=2, exclude_none=True), args, default_stem=stem, suffix=".json")
+        code = emit_text(full_json(job.result), args, default_stem=stem, suffix=".json")
     elif mode == "md":
         markdown = _parse_markdown(job)
         if markdown is None:
             print("error: this job has no markdown; use -o auto|json|payload|id", file=sys.stderr)
             return 1
         code = emit_text(markdown, args, default_stem=stem, suffix=".md")
-    else:
+    elif isinstance(job.result, ParseResult):
+        # A parse renders the document itself, not a summary of the response,
+        # so it is never swapped for JSON.
         code = emit_text(auto(job), args, default_stem=stem, suffix=_auto_suffix(job, auto))
+    # Rerunning a job command submits (and bills) a new job; reading this one does not.
+    elif shortened(full := full_json(job), args, get_full=f"`ndi job {job.job_id} --json`"):
+        code = emit_text(auto(job), args, default_stem=stem, suffix=".txt")
+    else:
+        code = emit_text(full, args, default_stem=stem, suffix=".json")
     return code or _content_failure(job)
 
 

{ndi_cli-0.13.0 → ndi_cli-0.16.0}/src/ndi_cli/_render.py

@@ -3,7 +3,8 @@
 The audience is a coding agent reading terminal output: every fact the
 response carries is either shown or explicitly counted, long free text is
 kept whole (summaries and answers are the payload), and nothing is styled.
-``--json`` on any command bypasses all of this with the raw response.
+Outside an agent run they print only when the full JSON response is over the
+output limit (``_output.FULL_OUTPUT_LIMIT``); ``--json`` always prints it whole.
 """
 
 from __future__ import annotations
@@ -931,12 +932,15 @@ def search_job(job: Job) -> str:
 
 
 def je_testing_job(job: Job) -> str:
-    """The answer, then the numbers behind it — a JET result read at a glance.
-
-    Unlike :func:`search_job` this leads with ``figures``: the answer is prose a
-    person reads, and the figures are the same content a reviewer can check.
-    Each one names the receipt its numbers are readable out of, so
-    ``ndi job <id> -o json`` is the next step rather than the only one.
+    """Whether the requested tests ran, then the answer and the numbers behind it.
+
+    A run that did not perform every requested test says so first, with each
+    test's outcome and blocker: its prose answer can read like a finding when
+    nothing was measured. Unlike :func:`search_job` it then leads with
+    ``figures``: the answer is prose a person reads, and the figures are the
+    same content a reviewer can check. Each one names the receipt its numbers
+    are readable out of, so ``ndi job <id> -o json`` is the next step rather
+    than the only one.
     """
     result = job.result
     if not isinstance(result, JetResult):
@@ -944,6 +948,13 @@ def je_testing_job(job: Job) -> str:
     lines: list[str] = []
     if result.degraded:
         lines.append(f"degraded: {result.degraded}")
+    if result.execution_status and result.execution_status != "performed":
+        lines.append(f"execution: {result.execution_status}")
+        for criterion in result.criteria:
+            outcome = criterion.status
+            if criterion.status == "incomplete":
+                outcome += f" ({criterion.blocker or criterion.incomplete_reason or 'no reason given'})"
+            lines.append(f"  {criterion.description or criterion.criterion_id}: {outcome}")
     if result.answer:
         lines.append(result.answer.strip())
     if result.population_statement:
@@ -964,8 +975,6 @@ def je_testing_job(job: Job) -> str:
     for discrepancy in result.discrepancies:
         lines.append(f"discrepancy: {discrepancy}")
     lines.append(f"evidences ({len(result.evidences)}) | receipts ({len(result.sql_receipts)})")
-    if result.execution_status and result.execution_status != "performed":
-        lines.append(f"execution: {result.execution_status}")
     if result.quality and result.quality.status != "clean":
         lines.append(f"quality: {result.quality.status}")
     if result.exhausted:

{ndi_cli-0.13.0 → ndi_cli-0.16.0}/src/ndi_cli/_tools.py

@@ -103,7 +103,9 @@ def add_parsers(sub: argparse._SubParsersAction, common: argparse.ArgumentParser
     read.add_argument("--component", default=None, help="One tab or section, named as file-metadata lists it.")
     read.add_argument("--pages", default=None, metavar="SPEC", help="1-based pages, e.g. 3 or 1-5,8. Not for spreadsheets.")
     read.add_argument("--max-chars", type=int, default=None, help="Character budget for the returned text.")
-    read.set_defaults(run=_run_read_file, render=_render_read_file, family="tool", needs_workspace=True, needs_client=True)
+    read.set_defaults(
+        run=_run_read_file, render=_render_read_file, verbatim=True, family="tool", needs_workspace=True, needs_client=True
+    )
 
     ask_file = sub.add_parser(
         WorkspaceCommand.ASK_FILE,
@@ -264,7 +266,9 @@ def add_parsers(sub: argparse._SubParsersAction, common: argparse.ArgumentParser
         ),
     )
     kg_answer.add_argument("query", help="The question, verbatim.")
-    kg_answer.set_defaults(run=_run_kg_answer, render=_render_kg_answer, family="tool", needs_workspace=True, needs_client=True)
+    kg_answer.set_defaults(
+        run=_run_kg_answer, render=_render_kg_answer, verbatim=True, family="tool", needs_workspace=True, needs_client=True
+    )
 
 
 def _run_folder_metadata(tools: SyncTools, workspace_id: str, args: argparse.Namespace):

{ndi_cli-0.13.0 → ndi_cli-0.16.0}/src/ndi_cli/_workspace.py

@@ -18,7 +18,7 @@ from ndi_sdk.resources.jobs import check_terminal
 from ndi_cli import _render
 from ndi_cli._config import ConfigError, config_path, read_config_values, resolve_settings
 from ndi_cli._jobs import wait_and_report, wait_job
-from ndi_cli._output import add_job_output_args, emit_text, output_mode, _content_failure
+from ndi_cli._output import _content_failure, add_job_output_args, emit_text, full_json, output_mode, print_full_or_summary
 from ndi_cli._sources import collect_workspace_uploads, folder_upload_prefix, workspace_dest_path
 
 DEFAULT_UPLOAD_PARALLEL = 8
@@ -236,9 +236,8 @@ def _workspace_id(args: argparse.Namespace, fallback: str) -> str:
 
 def _dump_or_text(model, args, *, text: str, stem: str) -> int:
     if output_mode(args) == "json":
-        return emit_text(model.model_dump_json(indent=2, exclude_none=True), args, default_stem=stem, suffix=".json")
-    print(text)
-    return 0
+        return emit_text(full_json(model), args, default_stem=stem, suffix=".json")
+    return print_full_or_summary(model, args, lambda: text)
 
 
 def _finish_job(client: NdiClient, job: Job, args: argparse.Namespace, auto, stem: str) -> int:
@@ -270,7 +269,11 @@ def _run_ws_global_context(client: NdiClient, workspace_id: str, args: argparse.
         workspace = client.workspaces.update(target, global_context=args.text)
     else:
         workspace = client.workspaces.get(target)
-    return _dump_or_text(workspace, args, text=workspace.global_context or "(no global context)", stem="workspace")
+    # The context text is the content asked for, not a summary of the workspace.
+    if output_mode(args) == "json":
+        return emit_text(full_json(workspace), args, default_stem="workspace", suffix=".json")
+    print(workspace.global_context or "(no global context)")
+    return 0
 
 
 def _run_ws_stats(client: NdiClient, workspace_id: str, args: argparse.Namespace) -> int: