Rendered from docs/interfaces/headwater-query.md in the Headwater corpus. Every document on this half of the site is typed by the taxonomy the descriptor names: corpus.json.

headwater query

Synopsis

headwater query <expression>

The verb takes one or more words as the expression. It refuses every expression because this repository defines no expression grammar.

Description

headwater query is listed in spec 6, but no document defines an expression or its selected data. The engine therefore implements no query language.

The verb reports this gap and names the reads that exist. Use headwater route to match a task to documents. Use headwater explain to read the graph behind one document.

Preconditions

None. The command line reaches the refusal without loading a corpus or a taxonomy lock.

Options

The verb has no verb-specific options. Global --root, --wide, --no-color, --no-banner, --version and --help are parsed by the binary, but query does not read them for this refusal.

Exit status

1 for every expression. The refusal states that the grammar is not defined and names headwater route and headwater explain as the available reads.

0 for --help, --version and the global help paths that the binary answers before it enters this verb.

1, and never 101, when standard output or standard error cannot be written, and one sentence on standard error names a failed standard output.

Environment

No environment variable reaches this verb. The refusal depends only on the command line.

Files

None. The verb reads and writes no file.

See also

HW-OBL-0029 records the missing expression grammar and waits on a build.

headwater route matches a task description to the graph.

headwater explain reports the kind, purpose and edges of one document.