Skip to content

The command line

c-earchin exposes four subcommands: translate, check, explain, and version.

Lowers an EARS or Kiro source into a Deep file and a span manifest.

Terminal window
c-earchin translate <input> [options]

The input is a path, or - to read from standard input.

FlagEffect
--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-spansDo not write the span manifest.
--inlineWrite the Deep to standard output and the spans to standard error, instead of to files.
--strictFail 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.

Terminal window
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.

Looks up one Deep node in a span manifest and prints where it came from.

Terminal window
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-003
WHILE 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.

Prints the bridge name and its version.

Terminal window
c-earchin version