Struct Cli 

pub struct Cli {

    pub dir_path: Vec<String>,
    pub output_json: Option<String>,
    pub output_json_pp: Option<String>,
    pub output_json_lines: Option<String>,
    pub output_yaml: Option<String>,
    pub output_debian: Option<String>,
    pub output_html: Option<String>,
    pub output_spdx_tv: Option<String>,
    pub output_spdx_rdf: Option<String>,
    pub output_cyclonedx: Option<String>,
    pub output_cyclonedx_xml: Option<String>,
    pub custom_output: Option<String>,
    pub custom_template: Option<String>,
    pub max_depth: usize,
    pub processes: ProcessMode,
    pub timeout: f64,
    pub quiet: bool,
    pub verbose: bool,
    pub strip_root: bool,
    pub full_root: bool,
    pub exclude: Vec<String>,
    pub include: Vec<String>,
    pub cache_dir: Option<String>,
    pub cache_clear: bool,
    pub incremental: bool,
    pub max_in_memory: MemoryMode,
    pub info: bool,
    pub from_json: bool,
    pub package: bool,
    pub system_package: bool,
    pub package_in_compiled: bool,
    pub package_only: bool,
    pub no_assemble: bool,
    pub license_dataset_path: Option<String>,
    pub reindex: bool,
    pub no_license_index_cache: bool,
    pub license_text: bool,
    pub license_text_diagnostics: bool,
    pub license_diagnostics: bool,
    pub unknown_licenses: bool,
    pub license_score: u8,
    pub license_url_template: String,
    pub filter_clues: bool,
    pub ignore_author: Vec<String>,
    pub ignore_copyright_holder: Vec<String>,
    pub only_findings: bool,
    pub mark_source: bool,
    pub classify: bool,
    pub summary: bool,
    pub license_clarity_score: bool,
    pub license_references: bool,
    pub license_policy: Option<String>,
    pub tallies: bool,
    pub tallies_key_files: bool,
    pub tallies_with_details: bool,
    pub facet: Vec<String>,
    pub tallies_by_facet: bool,
    pub generated: bool,
    pub license: bool,
    pub copyright: bool,
    pub email: bool,
    pub max_email: usize,
    pub url: bool,
    pub max_url: usize,
    pub show_attribution: bool,
    pub export_license_dataset: Option<String>,
}

Fields

dir_path: Vec<String>

File or directory paths to scan

output_json: Option<String>

Write scan output as compact JSON to FILE

output_json_pp: Option<String>

Write scan output as pretty-printed JSON to FILE

output_json_lines: Option<String>

Write scan output as JSON Lines to FILE

output_yaml: Option<String>

Write scan output as YAML to FILE

output_debian: Option<String>

Write scan output in machine-readable Debian copyright format to FILE (requires –license, –copyright, and –license-text)

output_html: Option<String>

Write scan output as HTML report to FILE

output_spdx_tv: Option<String>

Write scan output as SPDX tag/value to FILE

output_spdx_rdf: Option<String>

Write scan output as SPDX RDF/XML to FILE

output_cyclonedx: Option<String>

Write scan output as CycloneDX JSON to FILE

output_cyclonedx_xml: Option<String>

Write scan output as CycloneDX XML to FILE

custom_output: Option<String>

Write scan output to FILE formatted with the custom template

custom_template: Option<String>

Use this template FILE with –custom-output

max_depth: usize

Maximum recursion depth (0 means no depth limit)

processes: ProcessMode

timeout: f64

quiet: bool

verbose: bool

strip_root: bool

full_root: bool

exclude: Vec<String>

Exclude patterns (ScanCode-compatible alias: –ignore)

include: Vec<String>

cache_dir: Option<String>

cache_clear: bool

incremental: bool

max_in_memory: MemoryMode

Maximum number of file and directory scan details kept in memory. Use 0 for unlimited memory or -1 for disk-only spill during the scan.

info: bool

Collect file information such as checksums, type hints, and source/script flags.

from_json: bool

Load one or more existing ScanCode-style JSON scans instead of rescanning inputs.

package: bool

Scan input for application package and dependency manifests, lockfiles and related data

system_package: bool

Scan input for installed system package databases (RPM, dpkg, apk, etc.)

package_in_compiled: bool

Scan supported compiled Go and Rust binaries for embedded package metadata.

package_only: bool

Scan for system and application package data and skip license/copyright detection and top-level package creation.

no_assemble: bool

Disable package assembly (merging related manifest/lockfiles into packages)

license_dataset_path: Option<String>

Path to a custom license dataset root containing manifest.json, rules/, and licenses/. If not specified, uses the built-in embedded license index.

reindex: bool

Force rebuild of the license index cache, ignoring any existing cache.

no_license_index_cache: bool

Build the license index in memory for this run without reading or writing persistent cache files.

license_text: bool

Include matched text in license detection output

license_text_diagnostics: bool

license_diagnostics: bool

unknown_licenses: bool

license_score: u8

license_url_template: String

filter_clues: bool

ignore_author: Vec<String>

ignore_copyright_holder: Vec<String>

only_findings: bool

mark_source: bool

classify: bool

summary: bool

license_clarity_score: bool

license_references: bool

license_policy: Option<String>

Evaluate file license detections against a YAML license policy file.

tallies: bool

tallies_key_files: bool

tallies_with_details: bool

facet: Vec<String>

tallies_by_facet: bool

generated: bool

license: bool

Scan input for licenses

copyright: bool

email: bool

Scan input for email addresses

max_email: usize

Report only up to INT emails found in a file. Use 0 for no limit.

url: bool

Scan input for URLs

max_url: usize

Report only up to INT URLs found in a file. Use 0 for no limit.

show_attribution: bool

Show attribution notices for embedded license detection data

export_license_dataset: Option<String>

Export the effective built-in license dataset to DIR and exit.

Implementations

impl Cli

pub fn output_targets(&self) -> Vec<OutputTarget>

pub fn output_header_options(&self) -> JsonMap<String, JsonValue>

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.