Skip to main content

Crate bhwi_cli

Crate bhwi_cli 

Source
Expand description

Native command-line device selection, output helpers, and Python HWI compatibility.

Address and descriptor helpers print to stdout; hwi::process_request returns a serializable response. Selection warnings and device-interaction prompts use stderr. On Unix, hwi’s --stdinpass password prompt uses the controlling terminal when available, falling back to a stderr prompt and stdin input if password reading fails.

Native discovery types and shared selection helpers are reexported here; Linux builds also reexport udev-rule installation through udev.

Modules§

address
Device-backed address retrieval with stdout output.
get_descriptors
Device-backed descriptor derivation and stdout formatting.
host
Interactive KeepKey PIN-position and recovery-character input.
hwi
Python HWI-compatible argument parsing, device operations, and JSON responses.
management
Management contexts built from local entropy, time, and PIN-position input.
udev
Bundled Linux udev rules and system installation helpers.

Structs§

Device
An opened wallet with discovery metadata and cached successful query results.
DeviceJson
The bhwi frontend’s serializable view of cached device metadata.
DeviceManager
A native device manager with CLI pairing and host-interaction prompts.
DeviceSelector
Filters discovery candidates and optionally selects a wallet by fingerprint.
Info
Backend-specific device, firmware, and session information.
NativeSource
A native device-discovery source with optional broad-scan exclusions.
SkippedDevice
A candidate rejected during opening, selection, or probing.

Enums§

DeviceType
A supported hardware-wallet family, independent of enabled backend features.
DeviceTypeArg
A device-family argument accepted by Clap, independent of compiled device support.
NativeError
A failure while discovering, opening, or probing a native device.
OutputFormat
An output format for CLI tables and descriptor records.
SelectError
A discovery, opening, or wallet-selection failure.

Functions§

can_sign_taproot
Returns the known Taproot-signing capability for a family and model string.
device_manager
Creates a native manager with stderr pairing prompts and CLI host interaction.
is_user_cancelled
Returns whether an error chain contains a common user-cancellation error.
networks_string
Formats network names as a comma-separated string.
no_device
Returns None for an empty scan or an error containing rejected candidates.
python_hwi_device_manager
Creates a CLI manager that excludes Specter-DIY from broad HWI discovery.
reports_device_info
Returns whether the family reports the management metadata used by discovery.
select_device
Selects a device and prints skipped-device and network-mismatch warnings to stderr.
warn_skipped
Prints a skipped-device warning to stderr.