Struct Args 

pub struct Args {
    pub root: String,
    pub output: Option<String>,
    pub copy_to_clipboard: bool,
    pub include: Option<Vec<String>>,
    pub exclude: Option<Vec<String>>,
    pub checkout: Option<String>,
    pub keep_blank_lines: bool,
    pub no_ignore: bool,
}

Command line arguments for repocat.

Fields

root: String

GitHub repo URL or local folder path

output: Option<String>

Output to file name, if provided. Else, output to stdout.

copy_to_clipboard: bool

If set, outputs using OSC 52 escape sequences to copy to clipboard directly.

include: Option<Vec<String>>

Glob patterns to include files. Typically used to indicate file extensions to focus on. (e.g., “.rs,.toml”)

exclude: Option<Vec<String>>

Glob patterns to exclude files (e.g., “.md,.txt”)

checkout: Option<String>

A specific branch, tag, or commit to checkout after cloning e.g. –checkout “my-branch” or –checkout “abc123”

keep_blank_lines: bool

If set, blank lines will be preserved in the output

no_ignore: bool

If set, repocat will not ignore hidden or binary files. (In other words, it won’t use the default ignore rules from ripgrep.)

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

fn clone(&self) -> Args

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for Args

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 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.

impl Parser for Args

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.