API Reference

CLI argument types, serialization helpers, and command entry points.

Argument types

class agentgrep.FindArgs
class
class
class agentgrep.FindArgs

Bases: object

Typed arguments for agentgrep find.

fd-shaped: pattern_mode defaults to regex like fd does. -F selects literal-substring (which was the previous default before the fd alignment landed); -g selects glob; --exact selects exact adapter_id matching. type_filter constrains by record kind; extensions restricts to paths with matching suffixes.

pattern: str | None
attribute
attribute
pattern: str | None
agents: tuple[AgentName, ...]
attribute
attribute
agents: tuple[AgentName, ...]
limit: int | None
attribute
attribute
limit: int | None
output_mode: OutputMode
attribute
attribute
output_mode: OutputMode
color_mode: ColorMode
attribute
attribute
color_mode: ColorMode
pattern_mode: FindPatternMode
attribute
attribute
pattern_mode: FindPatternMode
type_filter: FindTypeFilter
attribute
attribute
type_filter: FindTypeFilter
extensions: tuple[str, ...]
attribute
attribute
extensions: tuple[str, ...]
case_mode: CaseMode
attribute
attribute
case_mode: CaseMode
list_details: bool
attribute
attribute
list_details: bool
print0: bool
attribute
attribute
print0: bool
absolute_path: bool
attribute
attribute
absolute_path: bool
full_path: bool
attribute
attribute
full_path: bool
progress_mode: ProgressMode
attribute
attribute
progress_mode: ProgressMode
compiled: CompiledQuery | None
attribute
attribute
compiled: CompiledQuery | None
raw_query: str
attribute
attribute
raw_query: str
__init__(pattern, agents, limit, output_mode, color_mode, pattern_mode='regex', type_filter='all', extensions=(), case_mode='smart', list_details=False, print0=False, absolute_path=False, full_path=False, progress_mode='auto', compiled=None, raw_query='')
method
method
__init__(pattern, agents, limit, output_mode, color_mode, pattern_mode='regex', type_filter='all', extensions=(), case_mode='smart', list_details=False, print0=False, absolute_path=False, full_path=False, progress_mode='auto', compiled=None, raw_query='')
Parameters:

  • pattern (str | None)

  • agents (tuple[AgentName, ...])

  • limit (int | None)

  • output_mode (OutputMode)

  • color_mode (ColorMode)

  • pattern_mode (FindPatternMode)

  • type_filter (FindTypeFilter)

  • extensions (tuple[str, ...])

  • case_mode (CaseMode)

  • list_details (bool)

  • print0 (bool)

  • absolute_path (bool)

  • full_path (bool)

  • progress_mode (ProgressMode)

  • compiled (CompiledQuery | None)

  • raw_query (str)

Return type:

None

Serialization

agentgrep.serialize_search_record(record)
function
function
agentgrep.serialize_search_record(record)

Serialize a search record to a JSON-compatible mapping.

Parameters:

record (SearchRecord)

Return type:

SearchRecordPayload

agentgrep.serialize_find_record(record)
function
function
agentgrep.serialize_find_record(record)

Serialize a find record to a JSON-compatible mapping.

Parameters:

record (FindRecord)

Return type:

FindRecordPayload

agentgrep.serialize_source_handle(source)
function
function
agentgrep.serialize_source_handle(source)

Serialize a source handle to a JSON-compatible mapping.

Parameters:

source (SourceHandle)

Return type:

SourceHandlePayload

agentgrep.build_envelope(command, query_data, results)
function
function
agentgrep.build_envelope(command, query_data, results)

Build a JSON envelope.

Parameters:
Return type:

EnvelopePayload

Entry points

agentgrep.run_find_command(args)
function
function
agentgrep.run_find_command(args)

Execute agentgrep find.

Routes through either the live streaming path (stream_find_results(), used for text / NDJSON / --print0) or the eager list path (print_find_results(), used for --json and --list-details). See _find_path_is_eager() for the routing decision.

The --ui overlay translates the find filters into a SearchQuery seeded with the same agent / type narrowing, then opens the Textual explorer. This mirrors the tig model: same query semantics, different presentation.

Parameters:

args (FindArgs)

Return type:

int

agentgrep.run_ui_command(args)
function
function
agentgrep.run_ui_command(args)

Execute agentgrep ui.

Parameters:

args (UIArgs)

Return type:

int

agentgrep.main(argv=None)
function
function
agentgrep.main(argv=None)

Run the CLI.

Parameters:

argv (Sequence[str] | None)

Return type:

int