Struct Cli 

pub struct Cli {

    pub method: Option<String>,
    pub headers: Vec<String>,
    pub data: Option<String>,
    pub auth_type: Option<String>,
    pub username: Option<String>,
    pub verbose: bool,
    pub trace: bool,
    pub stream: bool,
    pub file: Option<String>,
    pub app: Option<String>,
    pub output: OutputFormat,
    pub json: bool,
    pub jsonl: bool,
    pub raw: bool,
    pub no_pager: bool,
    pub quiet: bool,
    pub no_interactive: bool,
    pub timeout: u64,
    pub color: ColorChoice,
    pub dry_run: bool,
    pub limit: Option<i32>,
    pub cursor: Option<String>,
    pub page: Option<String>,
    pub after: Option<String>,
    pub command: Option<Commands>,
    pub url: Option<String>,
}

Auth-enabled curl-like interface for the X API.

Fields

method: Option<String>

HTTP method (GET by default)

headers: Vec<String>

Request headers

data: Option<String>

Request body data

auth_type: Option<String>

Authentication type (oauth1, oauth2, app)

username: Option<String>

Username for OAuth2 authentication

verbose: bool

Print verbose information

trace: bool

Add trace header to request

stream: bool

Force streaming mode

file: Option<String>

File to upload (for multipart requests)

app: Option<String>

Use a specific registered app (overrides default)

output: OutputFormat

Output format. text (default), json, jsonl, ndjson (alias of jsonl), yaml (.yml), csv, tsv. Formats not in the value enum (e.g. toml, xml) are not supported — xurl emits a JSON envelope with reason invalid-args if requested.

json: bool

Shorthand for --output json (P2 alias).

jsonl: bool

Shorthand for --output jsonl (P2 alias).

raw: bool

Emit unstyled, compact output. Strips ANSI in text mode; compact (no pretty-printing) JSON in json/jsonl modes.

no_pager: bool

Documented no-op. xr writes directly to stdout and never invokes $PAGER; this flag is advertised so agents can pass --no-pager unconditionally without xr rejecting it.

quiet: bool

Suppress all non-essential output (errors still go to stderr)

no_interactive: bool

Disable interactive prompts; fail with error instead

timeout: u64

Request timeout in seconds

color: ColorChoice

Colorize output: auto (TTY-aware), always, or never

dry_run: bool

Validate inputs and skip the API call (U7).

Honored by every write op; emits a canonical dry-run envelope on stdout under --output json / --output jsonl, or a “Would …” line under --output text. Read ops ignore it.

limit: Option<i32>

Global result-set limit, clamped to 1..=100 (U7).

Applies to every list-style command. The per-command -n/--max-results flag takes precedence when both are set.

cursor: Option<String>

Pagination cursor / pagination_token for list endpoints.

The X API uses cursor-based pagination: each list response carries a meta.next_token field, and the next page is fetched by re-running the same command with --cursor <token> (or XURL_CURSOR=<token>). Threads through to the pagination_token query parameter on every search, timeline, mentions, bookmarks, likes, following, followers, and dms invocation.

page: Option<String>

Documented alias for --cursor.

X’s API does not offer offset-style pagination (--page 2 is not addressable). Passing --page returns a canonical unsupported-pagination envelope on stderr suggesting --cursor instead. Exposed so agents trained on offset-pagination conventions get a structured error rather than a silent no-op.

after: Option<String>

Documented alias for --cursor (--after <token>).

Threads through to the same pagination_token query parameter as --cursor. Exposed so agents that picked up “after-style” pagination from other CLIs (gh, kubectl) get a working flag.

command: Option<Commands>

Subcommand to run

url: Option<String>

URL for raw mode (positional, only when no subcommand)

Implementations

impl Cli

pub fn effective_output(&self) -> OutputFormat

Resolves the effective output format after applying --json / --jsonl aliases.

--jsonl wins over --json if both were set (they conflict via clap, so at most one survives parsing); either alias overrides --output.

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.