Skip to main content

GlobalArgs

Struct GlobalArgs 

Source
pub struct GlobalArgs {
Show 50 fields pub spec: Option<String>, pub mcp: Option<String>, pub mcp_stdio: Option<String>, pub graphql: Option<String>, pub auth_header: Vec<String>, pub base_url: Option<String>, pub cache_key: Option<String>, pub cache_ttl: u64, pub refresh: bool, pub list_commands: bool, pub search_pattern: Option<String>, pub detail: Option<String>, pub describe: Option<String>, pub verbose: bool, pub sort: Option<String>, pub top: Option<usize>, pub compact: bool, pub pretty: bool, pub raw: bool, pub json_output: bool, pub envelope: bool, pub toon: bool, pub head: Option<usize>, pub max_bytes: Option<usize>, pub inline: bool, pub agent: bool, pub spool_clean: bool, pub fields: Option<String>, pub transport: String, pub env: Vec<String>, pub oauth: bool, pub oauth_client_id: Option<String>, pub oauth_client_secret: Option<String>, pub oauth_client_name: String, pub oauth_scope: Option<String>, pub oauth_redirect_uri: Option<String>, pub oauth_flow: String, pub oauth_clear: bool, pub session_start: Option<String>, pub session: Option<String>, pub session_stop: Option<String>, pub session_list: bool, pub session_idle_secs: Option<u64>, pub session_clean_env: bool, pub list_resources: bool, pub list_resource_templates: bool, pub read_resource: Option<String>, pub list_prompts: bool, pub get_prompt: Option<String>, pub prompt_arg: Vec<String>,
}

Fields§

§spec: Option<String>

OpenAPI spec URL or local file

§mcp: Option<String>

MCP server URL (HTTP streamable / SSE)

§mcp_stdio: Option<String>

MCP server as a shell command (stdio transport)

§graphql: Option<String>

GraphQL endpoint URL

§auth_header: Vec<String>

HTTP header as Name:Value (repeatable; value may use env:/file:)

§base_url: Option<String>

Override base URL from OpenAPI spec

§cache_key: Option<String>

Custom cache key

§cache_ttl: u64

Cache TTL in seconds

§refresh: bool

Force re-fetch

§list_commands: bool

List available subcommands

§search_pattern: Option<String>

Search tools by name or description

§detail: Option<String>

List / help JSON detail: names|brief|full

§describe: Option<String>

Emit one tool’s full schema as JSON (progressive describe)

§verbose: bool

Full tool descriptions in –list

§sort: Option<String>

Sort –list: usage|recent|alpha|default

§top: Option<usize>

Show only top N tools

§compact: bool

Space-separated tool names only (alias for –detail names)

§pretty: bool

Pretty-print JSON

§raw: bool

Print raw response body

§json_output: bool

Force valid JSON output (content-only for MCP; see –envelope)

§envelope: bool

Return full MCP CallToolResult envelope (instead of content-only)

§toon: bool

TOON encoding (native; falls back to JSON on encode failure)

§head: Option<usize>

Limit output to first N array records

§max_bytes: Option<usize>

Spill stdout to spool when rendered size exceeds N bytes (0 = never)

§inline: bool

Never spill; always print full stdout

§agent: bool

Agent defaults: JSON, brief discovery, spool oversize (or SKIFF_AGENT=1)

§spool_clean: bool

Delete expired spool files and exit

§fields: Option<String>

GraphQL selection set override

§transport: String

MCP HTTP transport: auto|sse|streamable

§env: Vec<String>

Env KEY=VALUE for MCP stdio (repeatable)

§oauth: bool

Enable OAuth (also implied by –oauth-client-id / –oauth-client-secret)

§oauth_client_id: Option<String>

OAuth client ID (supports env:/file: secrets)

§oauth_client_secret: Option<String>

OAuth client secret (supports env:/file: secrets)

§oauth_client_name: String

OAuth client name for DCR

§oauth_scope: Option<String>

OAuth scope string

§oauth_redirect_uri: Option<String>

Loopback redirect URI (http://127.0.0.1:/callback)

§oauth_flow: String

OAuth flow: auto|authorization_code|client_credentials

§oauth_clear: bool

Clear cached OAuth credentials for the discovery URL and exit

§session_start: Option<String>

Start a named MCP session daemon (requires –mcp or –mcp-stdio; Unix)

§session: Option<String>

Use an existing session daemon instead of a one-shot MCP connect (Unix)

§session_stop: Option<String>

Stop a named session daemon (SIGTERM, then SIGKILL; Unix)

§session_list: bool

List session daemons (use –json for machine-readable output)

§session_idle_secs: Option<u64>

Session idle exit after N seconds of no IPC (default 1800; 0 = never)

§session_clean_env: bool

For stdio sessions: child gets only PATH/HOME/LANG/TMP* plus –env

§list_resources: bool

List MCP resources (via –session today)

§list_resource_templates: bool

List MCP resource templates

§read_resource: Option<String>

Read an MCP resource by URI

§list_prompts: bool

List MCP prompts

§get_prompt: Option<String>

Get an MCP prompt by name

§prompt_arg: Vec<String>

Prompt argument as key=value (repeatable, with –get-prompt)

Implementations§

Source§

impl GlobalArgs

Source

pub fn apply_agent_defaults(&mut self)

Apply --agent / SKIFF_AGENT=1 defaults (idempotent).

Source

pub fn list_detail(&self) -> ListDetail

Source

pub fn quiet_list(&self) -> bool

Suppress human list banners.

Source

pub fn output_options(&self) -> OutputOptions

Source

pub fn full_envelope(&self) -> bool

MCP call: content-only unless --envelope.

Source

pub fn parse_auth_headers(&self) -> Result<Vec<(String, String)>>

Source

pub fn parse_env_vars(&self) -> Result<BTreeMap<String, String>>

Trait Implementations§

Source§

impl Args for GlobalArgs

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

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 Read more
Source§

impl Clone for GlobalArgs

Source§

fn clone(&self) -> GlobalArgs

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl CommandFactory for GlobalArgs

Source§

fn command<'b>() -> Command

Build a Command that can instantiate Self. Read more
Source§

fn command_for_update<'b>() -> Command

Build a Command that can update self. Read more
Source§

impl Debug for GlobalArgs

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for GlobalArgs

Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Assign values from ArgMatches to self.
Source§

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

Assign values from ArgMatches to self.
Source§

impl Parser for GlobalArgs

Source§

fn parse() -> Self

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

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

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

fn parse_from<I, T>(itr: I) -> Self
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.
Source§

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.
Source§

fn update_from<I, T>(&mut self, itr: I)
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error. Read more
Source§

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.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more