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_csv: Option<String>,
    pub output_html: Option<String>,
    pub output_html_app: 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: i32,
    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 max_in_memory: Option<usize>,
    pub from_json: bool,
    pub no_assemble: bool,
    pub filter_clues: bool,
    pub only_findings: bool,
    pub mark_source: bool,
    pub copyright: bool,
    pub email: bool,
    pub max_email: usize,
    pub url: bool,
    pub max_url: usize,
}

Fields

dir_path: Vec<String>

Directory path 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_csv: Option<String>

[DEPRECATED in Python] Write scan output as CSV to FILE

output_html: Option<String>

Write scan output as HTML report to FILE

output_html_app: Option<String>

[DEPRECATED in Python] Write scan output as HTML app 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: i32

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

max_in_memory: Option<usize>

from_json: bool

no_assemble: bool

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

filter_clues: bool

only_findings: bool

mark_source: bool

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.

Implementations

impl Cli

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

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.