Skip to main content

Module cli

Module cli 

Source
Expand description

Descriptor-driven CLI helpers shared by the FerrisKey binary and tests.

§Design Philosophy

The CLI module provides a bridge between command-line arguments and the typed SDK interface. It uses clap for argument parsing and converts the results into OperationInput for SDK execution.

§Extension Point

Custom CLI commands can be added via extension traits without modifying the core CLI infrastructure.

Structs§

CliConfig
CLI runtime configuration resolved from the command line.
CliCredentials
Configuration file for persistent CLI authentication.
CliInvocation
Parsed CLI invocation normalized into the shared SDK request shape.

Enums§

CliError
Errors raised while parsing or executing CLI requests.
OutputFormat
Output rendering mode for CLI responses.

Functions§

execute_with_transport
Execute a parsed CLI invocation through the shared SDK runtime.
parse_args
Parse CLI arguments into a normalized invocation.
render_help
Render the top-level CLI help text.