extract-cli 0.1.5__tar.gz → 0.1.6__tar.gz

{extract_cli-0.1.5 → extract_cli-0.1.6}/CHANGELOG.md

@@ -6,6 +6,23 @@ to [Semantic Versioning](https://semver.org/). Per the suite convention
 (see [`docs/INTEROP.md`](docs/INTEROP.md)), **backward-incompatible changes to
 the output schema require a major version bump**; new optional fields are minor.
 
+## [0.1.6] - 2026-05-21
+
+### Docs
+- **Rewrote the README composability section to verified, runnable examples.**
+  Testing extract-cli against the real sibling CLIs (`template-vault-cli`,
+  `nda-review-cli`) showed the previous pipes were aspirational — the siblings
+  expose no `--from-extract`/`--stdin` flag (`nda-review review` takes
+  `--file`/`--text`; `template-vault` reads its own vault). The integration
+  contract is the **output schema + the shared canonical clause vocabulary**,
+  glued by stdout JSON and standard tools (`jq`, `comm`): `extract`'s
+  `canonical_title` values are the same names template-vault detects and
+  nda-review keys policy on, so a foreign document's clauses line up with the
+  suite's with no bespoke adapter. New examples cover clause-coverage gap
+  analysis against a vault template and a combined extract+nda-review intake
+  report — all runnable today. (Also fixed a broken `jq input_filename` in the
+  folder-triage example.) No code or schema change.
+
 ## [0.1.5] - 2026-05-21
 
 ### Added
@@ -181,6 +198,7 @@ Initial release — the open-loop front door of the contract-ops CLI suite.
   intentionally *not* governed by the output schema (the schema describes the
   full default output).
 
+[0.1.6]: https://github.com/DrBaher/extract-cli/releases/tag/v0.1.6
 [0.1.5]: https://github.com/DrBaher/extract-cli/releases/tag/v0.1.5
 [0.1.4]: https://github.com/DrBaher/extract-cli/releases/tag/v0.1.4
 [0.1.3]: https://github.com/DrBaher/extract-cli/releases/tag/v0.1.3

{extract_cli-0.1.5 → extract_cli-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: extract-cli
-Version: 0.1.5
+Version: 0.1.6
 Summary: Open-loop front door of the contract-ops CLI suite: ingest any contract (.md/.txt/.html/.docx/.pdf) and emit structured JSON.
 Project-URL: Homepage, https://cli.drbaher.com/
 Project-URL: Repository, https://github.com/DrBaher/extract-cli
@@ -171,37 +171,48 @@ extract counterparty.pdf | jq '.clauses[] | {canonical_title, detected_title, ma
 
 ## Composability — piping into the rest of the suite
 
-`extract-cli` is built to be the first stage of a Unix pipe. Its JSON is the
-contract every downstream tool reads.
+`extract-cli` is built to be the first stage of a Unix pipe. The glue is its
+**stdout JSON + standard tools** (`jq`, `comm`) and the **shared clause
+vocabulary** — `extract`'s `canonical_title` values are the same names
+`template-vault-cli` detects and `nda-review-cli` keys policy on, so a foreign
+document's clauses line up with the suite's with no bespoke adapter. Every
+example below is runnable today (verified against the real sibling CLIs).
 
 ```bash
-# 1) Foreign NDA → review. extract normalizes clauses; nda-review runs policy.
-extract counterparty_nda.pdf | nda-review review --from-extract -
-
-# 2) Pull just the clause map and feed compare-cli to diff a foreign doc
-#    against your canonical template's structure.
-extract their_msa.docx --fields clauses | compare-cli align --stdin \
-  --against msa/standard
-
-# 3) Archive structured metadata for any inbound paper into the post-signature
-#    vault, keyed by content hash.
-extract signed_contract.pdf | contract-vault put --from-extract - \
-  --id "$(extract signed_contract.pdf | jq -r .document.sha256)"
-
-# 4) Triage a folder of inbound contracts: list governing law + parties.
-for f in inbox/*.pdf; do
+# 1) Inspect any contract's structure (.md/.txt/.html/.docx/.pdf, one tool).
+extract counterparty.docx | jq '{parties: [.parties[].name],
+  governing_law: .governing_law.value, clauses: [.clauses[].canonical_title]}'
+
+# 2) Clause-coverage gap vs your canonical template in template-vault-cli.
+#    extract normalizes the counterparty's *foreign* headings onto the same
+#    clause vocabulary template-vault detects, so a plain `comm` diffs them.
+template-vault info nda/mutual-standard --json | jq -r '.clauses[].title' | sort > ours.txt
+extract counterparty_nda.docx | jq -r '.clauses[].canonical_title' | sort -u > theirs.txt
+comm -23 ours.txt theirs.txt    # clauses in OUR standard that THEY are missing
+comm -13 ours.txt theirs.txt    # clauses THEY added that we don't have
+
+# 3) Intake: extract for structure, nda-review-cli for a policy verdict on the
+#    same foreign doc; merge both views with jq.
+extract counterparty_nda.docx > extract.json
+nda-review review --file counterparty_nda.docx --playbook output/nda_playbook.json \
+  --out-json review.json
+jq -n --slurpfile e extract.json --slurpfile r review.json \
+  '{parties: [$e[0].parties[].name], governing_law: $e[0].governing_law.value,
+    clauses: ($e[0].clauses | length), decision: $r[0].decision, risk: $r[0].risk_score}'
+
+# 4) Triage a folder of inbound contracts: governing law + parties per file.
+for f in inbox/*; do
   extract "$f" --fields parties,governing_law --no-confidence \
-    | jq -c '{file: input_filename, gov: .governing_law, parties: [.parties[].name]}'
+    | jq -c --arg f "$f" '{file: $f, gov: .governing_law, parties: [.parties[].name]}'
 done
 
-# 5) Gate a workflow on extraction confidence.
+# 5) Gate a workflow on extraction confidence (non-zero exit if any clause is shaky).
 extract draft.docx | jq -e '.clauses | all(.confidence > 0.7)' && echo "ok to review"
 ```
 
-> The `--from-extract`/`--stdin` flags above are the consumption points the
-> sibling CLIs expose (or are adopting) for this contract; see
-> [`docs/INTEROP.md`](docs/INTEROP.md) for the shared conventions and the
-> versioning commitment on the schema.
+> The integration contract is the **output schema** and the **canonical clause
+> vocabulary**, not per-tool flags. See [`docs/INTEROP.md`](docs/INTEROP.md) for
+> the shared conventions and the schema's versioning commitment.
 
 ## LLM configuration (opt-in)
 

{extract_cli-0.1.5 → extract_cli-0.1.6}/README.md

@@ -133,37 +133,48 @@ extract counterparty.pdf | jq '.clauses[] | {canonical_title, detected_title, ma
 
 ## Composability — piping into the rest of the suite
 
-`extract-cli` is built to be the first stage of a Unix pipe. Its JSON is the
-contract every downstream tool reads.
+`extract-cli` is built to be the first stage of a Unix pipe. The glue is its
+**stdout JSON + standard tools** (`jq`, `comm`) and the **shared clause
+vocabulary** — `extract`'s `canonical_title` values are the same names
+`template-vault-cli` detects and `nda-review-cli` keys policy on, so a foreign
+document's clauses line up with the suite's with no bespoke adapter. Every
+example below is runnable today (verified against the real sibling CLIs).
 
 ```bash
-# 1) Foreign NDA → review. extract normalizes clauses; nda-review runs policy.
-extract counterparty_nda.pdf | nda-review review --from-extract -
-
-# 2) Pull just the clause map and feed compare-cli to diff a foreign doc
-#    against your canonical template's structure.
-extract their_msa.docx --fields clauses | compare-cli align --stdin \
-  --against msa/standard
-
-# 3) Archive structured metadata for any inbound paper into the post-signature
-#    vault, keyed by content hash.
-extract signed_contract.pdf | contract-vault put --from-extract - \
-  --id "$(extract signed_contract.pdf | jq -r .document.sha256)"
-
-# 4) Triage a folder of inbound contracts: list governing law + parties.
-for f in inbox/*.pdf; do
+# 1) Inspect any contract's structure (.md/.txt/.html/.docx/.pdf, one tool).
+extract counterparty.docx | jq '{parties: [.parties[].name],
+  governing_law: .governing_law.value, clauses: [.clauses[].canonical_title]}'
+
+# 2) Clause-coverage gap vs your canonical template in template-vault-cli.
+#    extract normalizes the counterparty's *foreign* headings onto the same
+#    clause vocabulary template-vault detects, so a plain `comm` diffs them.
+template-vault info nda/mutual-standard --json | jq -r '.clauses[].title' | sort > ours.txt
+extract counterparty_nda.docx | jq -r '.clauses[].canonical_title' | sort -u > theirs.txt
+comm -23 ours.txt theirs.txt    # clauses in OUR standard that THEY are missing
+comm -13 ours.txt theirs.txt    # clauses THEY added that we don't have
+
+# 3) Intake: extract for structure, nda-review-cli for a policy verdict on the
+#    same foreign doc; merge both views with jq.
+extract counterparty_nda.docx > extract.json
+nda-review review --file counterparty_nda.docx --playbook output/nda_playbook.json \
+  --out-json review.json
+jq -n --slurpfile e extract.json --slurpfile r review.json \
+  '{parties: [$e[0].parties[].name], governing_law: $e[0].governing_law.value,
+    clauses: ($e[0].clauses | length), decision: $r[0].decision, risk: $r[0].risk_score}'
+
+# 4) Triage a folder of inbound contracts: governing law + parties per file.
+for f in inbox/*; do
   extract "$f" --fields parties,governing_law --no-confidence \
-    | jq -c '{file: input_filename, gov: .governing_law, parties: [.parties[].name]}'
+    | jq -c --arg f "$f" '{file: $f, gov: .governing_law, parties: [.parties[].name]}'
 done
 
-# 5) Gate a workflow on extraction confidence.
+# 5) Gate a workflow on extraction confidence (non-zero exit if any clause is shaky).
 extract draft.docx | jq -e '.clauses | all(.confidence > 0.7)' && echo "ok to review"
 ```
 
-> The `--from-extract`/`--stdin` flags above are the consumption points the
-> sibling CLIs expose (or are adopting) for this contract; see
-> [`docs/INTEROP.md`](docs/INTEROP.md) for the shared conventions and the
-> versioning commitment on the schema.
+> The integration contract is the **output schema** and the **canonical clause
+> vocabulary**, not per-tool flags. See [`docs/INTEROP.md`](docs/INTEROP.md) for
+> the shared conventions and the schema's versioning commitment.
 
 ## LLM configuration (opt-in)
 

{extract_cli-0.1.5 → extract_cli-0.1.6}/extract_cli.py

@@ -43,11 +43,11 @@ import urllib.request
 from pathlib import Path
 from typing import Any, Dict, List, Optional, Tuple
 
-__version__ = "0.1.5"
+__version__ = "0.1.6"
 
 # Bumped independently of the package version when the *extraction logic*
 # changes in a way downstream consumers should notice. Embedded in `_meta`.
-EXTRACTOR_VERSION = "0.1.5"
+EXTRACTOR_VERSION = "0.1.6"
 
 # JSON Schema version of the output contract (docs/spec/extract-output.schema.json).
 SCHEMA_VERSION = 1

{extract_cli-0.1.5 → extract_cli-0.1.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "extract-cli"
-version = "0.1.5"
+version = "0.1.6"
 description = "Open-loop front door of the contract-ops CLI suite: ingest any contract (.md/.txt/.html/.docx/.pdf) and emit structured JSON."
 readme = "README.md"
 requires-python = ">=3.9"

{extract_cli-0.1.5 → extract_cli-0.1.6}/tests/fixtures/employment_docx.docx.expected.json

@@ -138,7 +138,7 @@
     "source": "deterministic"
   },
   "_meta": {
-    "extractor_version": "0.1.5",
+    "extractor_version": "0.1.6",
     "tiers_used": [
       "deterministic"
     ],

{extract_cli-0.1.5 → extract_cli-0.1.6}/tests/fixtures/heading_docx.docx.expected.json

@@ -133,7 +133,7 @@
     "source": "none"
   },
   "_meta": {
-    "extractor_version": "0.1.5",
+    "extractor_version": "0.1.6",
     "tiers_used": [
       "deterministic"
     ],

{extract_cli-0.1.5 → extract_cli-0.1.6}/tests/fixtures/lease_allcaps.txt.expected.json

@@ -133,7 +133,7 @@
     "source": "deterministic"
   },
   "_meta": {
-    "extractor_version": "0.1.5",
+    "extractor_version": "0.1.6",
     "tiers_used": [
       "deterministic"
     ],

{extract_cli-0.1.5 → extract_cli-0.1.6}/tests/fixtures/license_pdf.pdf.expected.json

@@ -133,7 +133,7 @@
     "source": "deterministic"
   },
   "_meta": {
-    "extractor_version": "0.1.5",
+    "extractor_version": "0.1.6",
     "tiers_used": [
       "deterministic"
     ],

{extract_cli-0.1.5 → extract_cli-0.1.6}/tests/fixtures/nda_h2.md.expected.json

@@ -143,7 +143,7 @@
     "source": "none"
   },
   "_meta": {
-    "extractor_version": "0.1.5",
+    "extractor_version": "0.1.6",
     "tiers_used": [
       "deterministic"
     ],

{extract_cli-0.1.5 → extract_cli-0.1.6}/tests/fixtures/scanned.pdf.expected.json

@@ -48,7 +48,7 @@
     "source": "none"
   },
   "_meta": {
-    "extractor_version": "0.1.5",
+    "extractor_version": "0.1.6",
     "tiers_used": [
       "deterministic"
     ],

{extract_cli-0.1.5 → extract_cli-0.1.6}/tests/fixtures/services_bold.txt.expected.json

@@ -133,7 +133,7 @@
     "source": "deterministic"
   },
   "_meta": {
-    "extractor_version": "0.1.5",
+    "extractor_version": "0.1.6",
     "tiers_used": [
       "deterministic"
     ],

{extract_cli-0.1.5 → extract_cli-0.1.6}/tests/fixtures/services_html.html.expected.json

@@ -148,7 +148,7 @@
     "source": "deterministic"
   },
   "_meta": {
-    "extractor_version": "0.1.5",
+    "extractor_version": "0.1.6",
     "tiers_used": [
       "deterministic"
     ],