Struct Cli 

pub struct Cli {

    pub api_key: Option<String>,
    pub config_file: Option<PathBuf>,
    pub format: Option<Format>,
    pub no_color: bool,
    pub quiet: bool,
    pub wide: bool,
    pub verbose: bool,
    pub no_input: bool,
    pub retries: u32,
    pub yes: u8,
    pub base_url: Option<String>,
    pub base_prefix: Option<String>,
    pub help: Option<bool>,
    pub version: Option<bool>,
    pub command: Command,
}

qn — command-line interface for the Quicknode API.

Fields

api_key: Option<String>

API key. Overrides the config file.

config_file: Option<PathBuf>

Path to an alternate config file (default: ~/.config/qn/config.toml).

format: Option<Format>

Output format. table is the human view; the others are pipeline-friendly serialized forms. If unset, falls back to the [output] format = "…" value in ~/.config/qn/config.toml, then the TTY-aware default: table when stdout is a terminal, json otherwise.

no_color: bool

Disable ANSI colors. Also honored: NO_COLOR env var, TERM=dumb, non-TTY stdout.

quiet: bool

Suppress non-essential output (state-change confirmations on stderr).

wide: bool

Show additional columns in list-style tables (e.g. URLs in endpoint list). Mirrors kubectl get -o wide. Only affects table and md formats — json/yaml/toon always include everything.

verbose: bool

Verbose output: include error bodies and other details.

no_input: bool

Never prompt interactively; fail with a clear message if input is needed.

retries: u32

Max automatic retries for read-only commands on transient failures (HTTP 429/500/502/503/504, timeouts). Uses exponential backoff with jitter. 0 disables retries. Commands that modify resources never retry.

yes: u8

Skip confirmation prompts on destructive operations.

base_url: Option<String>

Override the Quicknode API base URL (used for testing or on-prem mirrors). All four sub-clients (admin/streams/webhooks/kv) hang off this host.

base_prefix: Option<String>

Path prefix inserted between the host and each sub-client’s path (e.g. /console-api). For reverse-proxy / gateway environments. Requires --base-url.

help: Option<bool>

Print help (see a summary with ‘-h’).

version: Option<bool>

Print version.

command: Command

Implementations

impl Cli

pub fn global_args(&self) -> GlobalArgs

Build a GlobalArgs suitable for Ctx::from_global.

pub async fn run(self) -> Result<(), CliError>

Dispatch the parsed command.

Some commands (auth, completions) are handled without constructing the SDK — they have nothing to talk to and shouldn’t trigger an API-key prompt.

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.