Struct Cli 

pub struct Cli {
    pub tick_rate: f64,
    pub frame_rate: f64,
    pub ascii: bool,
    pub no_color: bool,
    pub bee_bin: Option<PathBuf>,
    pub bee_config: Option<PathBuf>,
    pub once: Option<String>,
    pub json: bool,
    pub once_args: Vec<String>,
}

Fields

tick_rate: f64

Tick rate, i.e. number of ticks per second

frame_rate: f64

Frame rate, i.e. number of frames per second

ascii: bool

Render with ASCII glyphs only — no Unicode (✓ ⚠ ✗ ▶ ▇ …). Use on terminals with poor Unicode support: Windows Terminal pre-Win11, screen readers, some SSH chains. Equivalent to setting [ui].ascii_fallback = true in config.toml.

no_color: bool

Suppress colour output regardless of the configured theme. Equivalent to setting [ui].theme = "mono" in config.toml, or to NO_COLOR=1 in the environment (which is also honoured automatically per https://no-color.org).

bee_bin: Option<PathBuf>

Path to a bee binary to spawn before opening the cockpit. When set together with --bee-config, bee-tui starts Bee as a child process, captures its log into a temp file, waits for the API to come up, then opens the cockpit. Overrides [bee].bin from config.toml.

bee_config: Option<PathBuf>

Path to the Bee YAML config the spawned binary should use. Required when --bee-bin is set unless [bee].config is already in config.toml. Overrides [bee].config.

once: Option<String>

Run a single verb without launching the TUI. Prints the result on stdout and exits with 0 (ok), 1 (unhealthy / failed), or 2 (usage error). Designed for CI / shell pipelines: bee-tui --once readiness is the canonical “is my Bee node ready for traffic?” smoke test.

Supported verbs: hash, cid, depth-table, pss-target, gsoc-mine, readiness, version-check, inspect, durability-check. Trailing positional args go to the verb.

json: bool

When --once is set, emit a single JSON object on stdout instead of the human-readable line. Field shape: { verb, status, message, data }. Lets CI parse the result without regex on the human line.

once_args: Vec<String>

Trailing positional args consumed by --once <verb>. Not used in TUI mode.

Trait Implementations

impl Args for Cli

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Cli

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Cli

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for Cli

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Cli

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.