Struct Cli 

pub struct Cli {

    pub command: Option<Box<Command>>,
    pub pattern: Option<String>,
    pub path: Option<String>,
    pub json: bool,
    pub csv: bool,
    pub tsv: bool,
    pub headers: bool,
    pub columns: Option<String>,
    pub raw_csv: bool,
    pub preview: Option<usize>,
    pub no_color: bool,
    pub theme: ThemeName,
    pub sort: Option<SortField>,
    pub pager: bool,
    pub no_pager: bool,
    pub pager_cmd: Option<String>,
    pub kind: Option<SymbolKind>,
    pub lang: Option<String>,
    pub ignore_case: bool,
    pub exact: bool,
    pub count: bool,
    pub max_depth: usize,
    pub hidden: bool,
    pub follow: bool,
    pub fuzzy: bool,
    pub fuzzy_algorithm: String,
    pub fuzzy_threshold: f64,
    pub fuzzy_max_candidates: usize,
    pub json_stream: bool,
    pub fuzzy_fields: bool,
    pub fuzzy_field_distance: usize,
    pub limit: Option<usize>,
    pub list_languages: bool,
    pub debug_cache: bool,
    pub qualified_names: bool,
    pub validate: ValidationMode,
    pub auto_rebuild: bool,
    pub threshold_dangling_refs: Option<f64>,
    pub threshold_orphaned_files: Option<f64>,
    pub threshold_id_gaps: Option<f64>,
    pub text: bool,
    pub semantic: bool,
    pub no_fallback: bool,
    pub context: usize,
    pub max_text_results: usize,
}

sqry - Semantic Query for Code

Search code by what it means, not just what it says. Uses AST analysis to find functions, classes, and symbols with precision.

Fields

command: Option<Box<Command>>

Subcommand (optional - defaults to search if pattern provided)

pattern: Option<String>

Search pattern (shorthand for ‘search’ command)

Supports regex patterns by default. Use –exact for literal matching.

path: Option<String>

Search path (defaults to current directory)

json: bool

Output format as JSON

csv: bool

Output format as CSV (comma-separated values)

RFC 4180 compliant CSV output. Use with –headers to include column names. By default, formula-triggering characters are prefixed with single quote for Excel/LibreOffice safety. Use –raw-csv to disable this protection.

tsv: bool

Output format as TSV (tab-separated values)

Tab-delimited output for easy Unix pipeline processing. Newlines and tabs in field values are replaced with spaces.

headers: bool

Include header row in CSV/TSV output

Requires –csv or –tsv to be specified.

columns: Option<String>

Columns to include in CSV/TSV output (comma-separated)

Available columns: name, qualified_name, kind, file, line, column, end_line, end_column, language, preview

Example: –columns name,file,line

Requires –csv or –tsv to be specified.

raw_csv: bool

Output raw CSV without formula injection protection

By default, values starting with =, +, -, @, tab, or carriage return are prefixed with single quote to prevent Excel/LibreOffice formula injection attacks. Use this flag to disable protection for programmatic processing where raw values are needed.

Requires –csv or –tsv to be specified.

preview: Option<usize>

Show code context around matches (number of lines before/after)

no_color: bool

Disable colored output

theme: ThemeName

Select output color theme (default, dark, light, none)

sort: Option<SortField>

Sort results (opt-in)

pager: bool

Enable pager for output (auto-detected by default)

Forces output to be piped through a pager (like less). In auto mode (default), paging is enabled when:

• Output exceeds terminal height
• stdout is connected to an interactive terminal

no_pager: bool

Disable pager (write directly to stdout)

Disables auto-paging, writing all output directly to stdout. Useful for scripting or piping to other commands.

pager_cmd: Option<String>

Custom pager command (overrides $SQRY_PAGER and $PAGER)

Specify a custom pager command. Supports quoted arguments. Examples: –pager-cmd “less -R” –pager-cmd “bat –style=plain” –pager-cmd “more”

kind: Option<SymbolKind>

Filter by symbol type (function, class, struct, etc.)

Applies to search mode (top-level shorthand and sqry search). For structured queries, use sqry query "kind:function AND ..." instead.

lang: Option<String>

Filter by programming language

Applies to search mode (top-level shorthand and sqry search). For structured queries, use sqry query "lang:rust AND ..." instead.

ignore_case: bool

Case-insensitive search

exact: bool

Exact match (disable regex)

Applies to search mode (top-level shorthand and sqry search).

count: bool

Show count only (number of matches)

max_depth: usize

Maximum directory depth to search

hidden: bool

Include hidden files and directories

follow: bool

Follow symlinks

fuzzy: bool

Enable fuzzy search (requires index)

Applies to search mode (top-level shorthand and sqry search).

fuzzy_algorithm: String

Fuzzy matching algorithm (jaro-winkler or levenshtein)

fuzzy_threshold: f64

Minimum similarity score for fuzzy matches (0.0-1.0)

fuzzy_max_candidates: usize

Maximum number of fuzzy candidates to consider

json_stream: bool

Enable JSON streaming mode for fuzzy search

Emits results as JSON-lines (newline-delimited JSON). Each line is a StreamEvent with either a partial result or final summary. Requires –fuzzy (fuzzy search) and is inherently JSON output.

fuzzy_fields: bool

Allow fuzzy matching for query field names (opt-in). Applies typo correction to field names (e.g., “knd” → “kind”). Ambiguous corrections are rejected with an error.

fuzzy_field_distance: usize

Maximum edit distance for fuzzy field correction

limit: Option<usize>

Maximum number of results to return

Limits the output to a manageable size for downstream consumers. Defaults: search=100, query=1000, fuzzy=50

list_languages: bool

List enabled languages and exit

debug_cache: bool

Print cache telemetry to stderr after the command completes

qualified_names: bool

Display fully qualified symbol names in CLI output.

Helpful for disambiguating relation queries (callers/callees) where multiple namespaces define the same method name.

validate: ValidationMode

Index validation strictness level (off, warn, fail)

Controls how to handle index corruption during load:

• off: Skip validation entirely (fastest)
• warn: Log warnings but continue (default)
• fail: Abort on validation errors

auto_rebuild: bool

Automatically rebuild index if validation fails

When set, if index validation fails in strict mode, sqry will automatically rebuild the index once and retry. Useful for recovering from transient corruption without manual intervention.

threshold_dangling_refs: Option<f64>

Maximum ratio of dangling references before rebuild (0.0-1.0)

Sets the threshold for dangling reference errors during validation. Default: 0.05 (5%). If more than this ratio of symbols have dangling references, validation will fail in strict mode.

threshold_orphaned_files: Option<f64>

Maximum ratio of orphaned files before rebuild (0.0-1.0)

Sets the threshold for orphaned file errors during validation. Default: 0.20 (20%). If more than this ratio of indexed files are orphaned (no longer exist on disk), validation will fail.

threshold_id_gaps: Option<f64>

Maximum ratio of ID gaps before warning (0.0-1.0)

Sets the threshold for ID gap warnings during validation. Default: 0.10 (10%). If more than this ratio of symbol IDs have gaps, validation will warn or fail depending on strictness.

text: bool

Force text search mode (skip semantic, use ripgrep)

semantic: bool

Force semantic search mode (skip text fallback)

no_fallback: bool

Disable automatic fallback to text search

context: usize

Number of context lines for text search results

max_text_results: usize

Maximum text search results

Implementations

impl Cli

pub fn command_with_taxonomy() -> Command

Get the command with taxonomy headings applied

pub fn validate(&self) -> Option<&'static str>

Validate CLI arguments that have dependencies not enforceable via clap

Returns an error message if validation fails, None if valid.

pub fn search_path(&self) -> &str

Get the search path, defaulting to current directory if not specified

pub fn is_tabular_output(&self) -> bool

Check if tabular output mode is enabled

pub fn pager_config(&self) -> PagerConfig

Create pager configuration from CLI flags

Returns PagerConfig based on --pager, --no-pager, and --pager-cmd flags.

Structured Output Handling

For machine-readable formats (JSON, CSV, TSV), paging is disabled by default to avoid breaking pipelines. Use --pager to explicitly enable paging for these formats.

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.