Struct ScanArgs 

pub struct ScanArgs {
    pub common: GlobalArgs,
    pub batch_size: usize,
    pub apply: bool,
    pub prune: bool,
    pub sync: bool,
    pub all_releases: bool,
    pub vex: VexEmbedArgs,
}

Fields

common: GlobalArgs

batch_size: usize

Number of packages to query per API request.

apply: bool

Download and apply selected patches in JSON mode (non-interactive). Without this flag, scan --json is read-only — it lists available patches plus an updates array but does not mutate the manifest. Designed for unattended workflows (cron jobs, bots that open PRs); pair with --yes for clarity though --json already implies non- interactive confirmation. No effect outside --json mode (the non-JSON path always prompts the user).

prune: bool

Garbage-collect after the scan: prune manifest entries for packages no longer present in the crawl, then delete orphan blob, diff, and package-archive files from .socket/. Off by default to preserve manifest state across temporary uninstalls; pair with --apply (or use --sync) for the auto-update workflow.

sync: bool

Convenience flag for the auto-update workflow: implies both --apply and --prune. Designed so a cron job or CI workflow can run socket-patch scan --json --sync --yes and end up in a fully-reconciled state in one invocation.

all_releases: bool

Download patches for every release/distribution variant of a matched package, not just the one(s) matching the locally- installed distribution. Affects ecosystems with per-release variants — PyPI (wheel/sdist via artifact_id), RubyGems (platform), and Maven (classifier). Off by default: narrow scans store only the patch(es) for the installed dist, keeping .socket/ small; --all-releases makes the manifest portable across environments (e.g. cross-platform CI caches).

vex: VexEmbedArgs

On a successful scan, also generate an OpenVEX 0.2.0 document. --vex <path> is the trigger; the --vex-* knobs mirror the standalone vex command. The document is built from the manifest as it stands after the scan (including any --apply/--sync writes) and verified against on-disk state. A requested-but-failed VEX makes the command exit non-zero.

Trait Implementations

impl Args for ScanArgs

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 FromArgMatches for ScanArgs

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.