Skip to main content

Crate stacksdapp_shell

Crate stacksdapp_shell 

Source
Expand description

Shared shell utilities for the stacksdapp CLI and libraries. Init once from main via init. Commands and crates then use status, warn, error, debug, and emit_json.

Re-exports§

pub use mnemonic::check_deployer_mnemonic;
pub use mnemonic::inspect_settings_file;
pub use mnemonic::is_mnemonic_placeholder;
pub use mnemonic::is_public_devnet_mnemonic;
pub use mnemonic::parse_deployer_mnemonic;
pub use mnemonic::settings_relative_path;
pub use mnemonic::validate_mnemonic_word_format;
pub use mnemonic::MnemonicCheck;
pub use mnemonic::ParsedDeployerMnemonic;
pub use mnemonic::PUBLIC_DEVNET_MNEMONICS;
pub use project::default_config_toml;
pub use project::enter_scaffold_root;
pub use project::find_init_root;
pub use project::find_scaffold_root;
pub use project::load_config;
pub use project::project_root;
pub use project::resolve_scaffold_root;
pub use project::validate_network;
pub use project::StacksdappConfig;
pub use project::CONFIG_FILE;
pub use steps::begin_step;
pub use steps::grey;
pub use steps::kv;
pub use steps::lavender;
pub use steps::mint;
pub use steps::print_banner;
pub use steps::println_human_safe;
pub use steps::rule;
pub use steps::step_ok;
pub use steps::LiveStep;

Modules§

mnemonic
Deployer mnemonic inspection for testnet/mainnet safety checks.
project
Project root discovery
steps
Shared spinner steps and banner chrome for -style CLI output.

Structs§

Shell

Enums§

ColorMode
Format

Functions§

debug
Verbose detail when -v / -vv … is set (and not quiet/json).
emit_error_json
Emit a JSON error object (for command failures under --json).
emit_json
Emit a JSON value on stdout when --json is active.
error
Errors always print unless JSON mode (then prefer emit_json / emit_error_json).
get
init
Initialize global shell settings. Safe to call once; later calls are ignored.
is_json
is_quiet
json_already_emitted
True if a command already wrote a JSON payload this process.
println_human
Pretty-print JSON when not in machine mode helpers need human fallback.
status
Human status line on stdout (suppressed when quiet/json).
verbosity
warn
Human warning on stderr (suppressed when quiet/json).