Struct Args 

pub struct Args {

    pub url: String,
    pub endpoint: Option<String>,
    pub token: Option<String>,
    pub browser: String,
    pub browser_bin: Option<PathBuf>,
    pub render: String,
    pub tab: String,
    pub wait: String,
    pub headers: Vec<String>,
    pub cookies: Vec<String>,
    pub user_agent: Option<String>,
    pub evaluate_after_wait: Vec<String>,
    pub want: Vec<String>,
    pub method: String,
    pub data: Option<String>,
    pub data_file: Option<PathBuf>,
    pub form: Vec<String>,
    pub network_bodies: NetworkBodiesArg,
    pub network_body_max_bytes: u64,
    pub network_redact: NetworkRedactArg,
    pub out: Option<PathBuf>,
    pub cookie_jar: Option<PathBuf>,
    pub no_cookie_jar: bool,
    pub observe_main_wait_ms: u64,
    pub max_response_bytes: u64,
    pub retry: u32,
    pub backoff_ms: u64,
    pub proxy: Option<String>,
    pub ca_cert: Option<PathBuf>,
    pub tls_insecure: bool,
    pub timeout: String,
    pub capture_ws: bool,
    pub capture_sse: bool,
}

Fields

url: String

URL to fetch.

endpoint: Option<String>

CDP endpoint of a running host. Omit to spawn an inline ephemeral host for this one fetch.

token: Option<String>

Bearer token, if the host was started with --token-secret.

browser: String

Browser backend for the inline host: auto, chromium, chrome, chrome_shell, fingerprint-chromium, edge, brave, lightpanda, camoufox. Ignored when –endpoint-url is set (the host owns its browser).

browser_bin: Option<PathBuf>

Browser binary path for the inline host, for when auto-discovery can’t find one. Ignored when –endpoint-url is set.

render: String

Render strategy: none (HTTP fast path, no browser), auto (HTTP first, escalate to the browser on failure), or always (browser only).

tab: String

Tab target to use. “new” allocates a temporary target and closes it after fetch; an id reuses that target and leaves it open.

wait: String

Readiness signal before capture on the browser path: load | idle | selector: | selector-visible: | ms:.

headers: Vec<String>

Add a request header (repeatable). Format: Name: value.

cookies: Vec<String>

Add a request cookie (repeatable). Format: name=value.

user_agent: Option<String>

Override the User-Agent header for this fetch.

evaluate_after_wait: Vec<String>

JavaScript to evaluate after the wait condition resolves (repeatable). Runs in page context before artifacts are captured.

want: Vec<String>

Artifacts to capture, comma-separated. Omit for all of: body, rendered_html, text, screenshot, network, console, observation (storage is opt-in only).

method: String

HTTP method. Common values: POST, PUT, PATCH, DELETE.

data: Option<String>

Request body as a string. Prefix with @ to read from a file path (e.g. --data @payload.json). Mutually exclusive with --form.

data_file: Option<PathBuf>

Request body from a file path. Mutually exclusive with --form.

form: Vec<String>

Add a form field (repeatable). Sends body as application/x-www-form-urlencoded. Mutually exclusive with --data. Format: key=value.

network_bodies: NetworkBodiesArg

Capture response bodies for network requests: off, xhr (XHR/fetch only), or all.

network_body_max_bytes: u64

Per-body cap for captured network bodies, in bytes.

network_redact: NetworkRedactArg

Redact sensitive values in network.json: on or off. On by default; off writes raw Authorization/Cookie headers and token-bearing query params to the artifact — only disable for trusted local debugging.

out: Option<PathBuf>

Directory to write artifacts into. Defaults to an afhttp-out subdirectory of the working directory.

cookie_jar: Option<PathBuf>

Override the cookie-jar path. The default — derived from the host’s GET /profile — places the jar at <profile-dir>/cookies.jar.json. This override is rejected with invalid_argument if it does not match the host’s profile path; the flag exists for tests and forensic tooling, not production sessions. Honors AFHTTP_COOKIE_JAR when omitted (same validation applies).

no_cookie_jar: bool

Opt out of cookie-jar persistence for this fetch. No cookies are replayed from the jar and no Set-Cookie responses are merged back.

observe_main_wait_ms: u64

Upper bound on the browser-path wait for the main document network event, in milliseconds. Raise for slow networks or low-end machines.

max_response_bytes: u64

Upper bound on the HTTP-path response body, in bytes. Default 1 GiB (1073741824). 0 disables the cap entirely. When the cap is hit, the fetch returns successfully with a network_body_truncated warning and the prefix bytes that were collected.

retry: u32

Number of additional attempts after the first. Retries fire only when the error has retryable: true (e.g. host_unreachable, cdp_timeout); non-retryable failures (tls_error, wait_selector_unmatched, etc.) short-circuit. Default 0 = single attempt.

backoff_ms: u64

Fixed delay between retries, in milliseconds.

proxy: Option<String>

Per-fetch upstream HTTP/HTTPS proxy for the HTTP fast path. The SDK never honors HTTP_PROXY from the environment; this flag is the only way to route an HTTP-path fetch through one. Format: http://user:pass@host:port or socks5://host:port.

ca_cert: Option<PathBuf>

Path to a PEM file containing extra root CAs to trust for this fetch’s HTTP path. Useful for self-signed staging or corporate MITM CAs.

tls_insecure: bool

Disable TLS certificate verification for this fetch’s HTTP path. Dangerous; leaves the connection open to MITM. Use only against known-self-signed environments.

timeout: String

Overall fetch timeout (e.g. 30s, 1500ms).

capture_ws: bool

Capture WebSocket frame payloads to network-bodies/.frames.jsonl. Frames may carry bearer tokens, session IDs, and message content — treat the artifact as sensitive.

capture_sse: bool

Capture SSE event payloads to network-bodies/.frames.jsonl. Events may carry PII; treat the artifact as sensitive.

Trait Implementations

impl Args for Args

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 Debug for Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

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.