Struct Config

pub struct Config {

    pub prompt: Option<String>,
    pub paths: Option<Vec<PathBuf>>,
    pub include: Option<Vec<String>>,
    pub ignore: Option<Vec<String>>,
    pub repo: Option<String>,
    pub read_stdin: bool,
    pub output_file: Option<PathBuf>,
    pub max_tokens: Option<usize>,
    pub llm_tool: LlmTool,
    pub quiet: bool,
    pub verbose: bool,
    pub config: Option<PathBuf>,
    pub progress: bool,
    pub copy: bool,
    pub enhanced_context: bool,
    pub trace_imports: bool,
    pub include_callers: bool,
    pub include_types: bool,
    pub semantic_depth: usize,
    pub custom_priorities: Vec<Priority>,
    pub config_token_limits: Option<TokenLimits>,
    pub config_defaults_max_tokens: Option<usize>,
}

High-performance CLI tool to convert codebases to Markdown for LLM context

Fields

prompt: Option<String>

The prompt to send to the LLM for processing

paths: Option<Vec<PathBuf>>

One or more directory paths to process IMPORTANT: Use get_directories() to access the correct input paths.

include: Option<Vec<String>>

Include files and directories matching glob patterns IMPORTANT: Use get_directories() to access the correct input paths.

ignore: Option<Vec<String>>

Ignore files and directories matching glob patterns

repo: Option<String>

GitHub repository URL to analyze (e.g., https://github.com/owner/repo)

read_stdin: bool

Read prompt from stdin

output_file: Option<PathBuf>

The path to the output Markdown file. If used, won’t call the LLM CLI

max_tokens: Option<usize>

Maximum number of tokens for the generated codebase context

llm_tool: LlmTool

LLM CLI tool to use for processing

quiet: bool

Suppress all output except for errors and the final LLM response

verbose: bool

Enable verbose logging

config: Option<PathBuf>

Path to configuration file

progress: bool

Show progress indicators during processing

copy: bool

Copy output to system clipboard instead of stdout

enhanced_context: bool

Enable enhanced context with file metadata

trace_imports: bool

Enable import tracing for included files

include_callers: bool

Include files that call functions from specified modules

include_types: bool

Include type definitions used by specified files

semantic_depth: usize

Maximum depth for semantic dependency traversal

custom_priorities: Vec<Priority>

Custom priority rules loaded from config file (not a CLI argument)

config_token_limits: Option<TokenLimits>

Token limits loaded from config file (not a CLI argument)

config_defaults_max_tokens: Option<usize>

Maximum tokens from config defaults (not a CLI argument)

Implementations

impl Config

pub fn validate(&self) -> Result<(), ContextCreatorError>

Validate the configuration

pub fn load_from_file(&mut self) -> Result<(), ContextCreatorError>

Load configuration from file if specified

pub fn get_prompt(&self) -> Option<String>

Get the prompt from the explicit prompt flag

pub fn get_directories(&self) -> Vec<PathBuf>

Get all directories from paths argument When using –include patterns, this returns the default directory (current dir) unless explicit paths are also provided (flexible combinations)

pub fn get_include_patterns(&self) -> Vec<String>

Get include patterns if specified

pub fn get_ignore_patterns(&self) -> Vec<String>

Get ignore patterns if specified

pub fn get_effective_max_tokens(&self) -> Option<usize>

Get effective max tokens with precedence: explicit CLI > token limits (if prompt) > config defaults > hard-coded defaults (if prompt) > None

pub fn get_effective_context_tokens(&self) -> Option<usize>

Get effective context tokens with prompt reservation This accounts for prompt tokens when calculating available space for codebase context

pub fn should_read_stdin(&self) -> bool

Check if we should read from stdin

Trait Implementations

impl Args for Config

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 Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Config

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 Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for Config

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 Config

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.