Skip to main content

Module cli

Module cli 

Source
Expand description

The bynkc command-line interface definition.

The clap types live here (rather than in main.rs) so they are the single source of truth for both the binary and the generated CLI reference page site/src/content/docs/docs/cli.md. render_markdown walks the clap command tree; the test tests/cli_reference.rs checks the page is up to date.

Structs§

Cli

Enums§

CliPlatform
v0.17: the deploy platform that selects the bynk surface binding. Distinct from CliTarget (the emit topology). v0.18 adds node.
CliTarget
Command
DiagFormat
v0.38 (ADR 0071): bynkc check --format selector.
EmitFormat
v0.108 (in-browser track, slice 1): the emitted artefact language. ts (the default and primary output) writes the typed TypeScript modules; js writes the same modules with their types stripped — an emit-then-strip JavaScript artefact (ADR 0137) runnable with no tsc in the loop. Orthogonal to --target (topology) and --platform (binding).
TestFormat
v0.59: bynkc test --format selector. A per-command subset whose value names match DiagFormat (rich is the human rendering across bynkc), rather than sharing the enum — test has no short behaviour yet, so it must not expose a value that parses but does nothing.

Functions§

command
The clap [clap::Command] tree for the bynkc CLI.
render_markdown
Render the CLI reference as a Markdown page, walking the clap command tree.