Add CLI reference binding flags
This commit is contained in:
13
docs/cli.md
13
docs/cli.md
@@ -20,7 +20,7 @@ a bearer token.
|
||||
|
||||
```text
|
||||
notarius help
|
||||
notarius run <pipeline-id> --input path/to/source.json [--config path/to/config.yml] [--only lane-a,lane-b]
|
||||
notarius run <pipeline-id> --input path/to/source.json [--config path/to/config.yml] [--only lane-a,lane-b] [--reference slot=path] [--without-reference slot]
|
||||
notarius config validate --config path/to/config.yml [--pipeline pipeline-id] [--only lane-a,lane-b]
|
||||
notarius pipelines list --config path/to/config.yml [--json]
|
||||
```
|
||||
@@ -46,11 +46,22 @@ Flags:
|
||||
invocation.
|
||||
- `--llm-profile id`: override every effective module binding to use one LLM
|
||||
profile.
|
||||
- `--reference slot=path`: bind a reference path to an extractor reference
|
||||
slot. Repeatable. Use `lane.slot=path` when multiple selected lanes declare
|
||||
the same slot.
|
||||
- `--without-reference slot`: remove a configured optional reference binding.
|
||||
Repeatable. Use `lane.slot` when multiple selected lanes declare the same
|
||||
slot.
|
||||
|
||||
On success, the command prints the completed pipeline ID, approved and rejected
|
||||
artifact counts, and the output directory. If the run completes with warnings,
|
||||
the warning count is printed to stderr.
|
||||
|
||||
Reference flags are resolved against selected artifact lanes before the run
|
||||
starts. Flat slot names are accepted only when exactly one selected lane
|
||||
declares that slot. Binding paths are recorded in resolved pipeline metadata;
|
||||
reference file content is not read by the current runner.
|
||||
|
||||
For durable output, diagnostics, retention, and failure inspection, see
|
||||
[Operations](operations.md).
|
||||
|
||||
|
||||
@@ -121,6 +121,9 @@ Pipeline fields:
|
||||
- `artifacts`: required for pipeline resolution. It maps artifact lane IDs to
|
||||
lane definitions.
|
||||
- `output`: optional module binding. Default module is `json`.
|
||||
- `references`: optional map of extractor reference slot names to reference
|
||||
paths. These bindings are defaults for artifact lanes whose extractor declares
|
||||
the matching slot.
|
||||
|
||||
Artifact lane fields:
|
||||
|
||||
@@ -129,11 +132,19 @@ Artifact lane fields:
|
||||
- `normalize`: optional module binding. Default module is `noop`.
|
||||
- `validators`: optional list of module bindings. The production CLI currently
|
||||
does not register validator modules.
|
||||
- `references`: optional map of extractor reference slot names to reference
|
||||
paths. Lane bindings override pipeline-level bindings for the same slot.
|
||||
|
||||
`notarius run` and `notarius config validate --pipeline` resolve the pipeline
|
||||
against the production module catalog and fail fast for unknown or incompatible
|
||||
module keys.
|
||||
|
||||
Reference bindings are validated against extractor-declared slots during
|
||||
pipeline resolution. Required slots must be bound after config defaults,
|
||||
lane-level bindings, and run-time `--reference` or `--without-reference`
|
||||
overrides are applied. Reference paths are recorded in resolved pipeline
|
||||
metadata; the current runner does not read reference file content.
|
||||
|
||||
## Module Bindings
|
||||
|
||||
Every module binding may use shorthand:
|
||||
@@ -215,3 +226,5 @@ Pipeline resolution additionally checks:
|
||||
- required module keys are present;
|
||||
- module keys are registered for the expected slot;
|
||||
- module capability requirements are satisfied.
|
||||
- bound reference slots are declared by selected lane extractors;
|
||||
- required reference slots are bound for selected lanes.
|
||||
|
||||
Reference in New Issue
Block a user