The command line
c-earchin exposes four subcommands: translate, check, explain, and
version.
translate
Section titled “translate”Lowers an EARS or Kiro source into a Deep file and a span manifest.
c-earchin translate <input> [options]The input is a path, or - to read from standard input.
| Flag | Effect |
|---|---|
--output <path> | Where to write the .dp Deep file. Defaults to the input path with a .dp extension. |
--spans <path> | Where to write the .spans.json manifest. Defaults to the input path with a .spans.json extension. |
--no-spans | Do not write the span manifest. |
--inline | Write the Deep to standard output and the spans to standard error, instead of to files. |
--strict | Fail if any requirement response has no vocabulary predicate. |
--module <name> | Override the generated module name. |
--dialect <ears|kiro> | Force the input notation. |
Without --dialect, the notation is inferred from the filename: a .md source
is read as Kiro, and everything else, including .ears and standard input,
defaults to EARS. An explicit --dialect always wins over the filename. See
the Kiro dialect.
Translates the input in strict mode and discards the output, reporting only whether it is valid. Use it to confirm a requirement file translates cleanly without writing artifacts.
c-earchin check <input> [--module <name>] [--dialect <ears|kiro>]On success it prints checked. Because check is always strict, a vocabulary
miss makes it fail.
explain
Section titled “explain”Looks up one Deep node in a span manifest and prints where it came from.
c-earchin explain <spans.json> --target <node>The target is either a Deep node id (such as req_FIN_003) or a Deep path. The
command prints the resolved location and the original requirement text:
req_FIN_003 -> references/finance_options/options_rules.ears:3:1 FIN-003WHILE the exchange is open, the portfolio delta shall be at most the limit.This is the same resolution chelis prove performs when reporting a failure,
available as a standalone lookup. See provenance.
version
Section titled “version”Prints the bridge name and its version.
c-earchin version