Quick Start

Get started with FindeRS in minutes. This guide covers the most common usage patterns.

Basic Concepts

FindeRS has two main operations:

You can use them separately or together.

Find all Python files in the current directory:

finder -f ".py"

Find all Markdown files:

finder -f ".md"

Find files in a specific directory:

finder src/ -f ".rs"

Search for “TODO” in all files:

finder -s "TODO"

Case-insensitive search:

finder -s "error" -i

Find “TODO” comments in Python files:

finder -f ".py" -s "TODO"

Find “FIXME” in Rust files within the src directory:

finder src/ -f ".rs" -s "FIXME"

Shows file path, line number, and matching content:

finder -s "TODO"

Output:

src/lib.rs:42: // TODO: implement this feature
src/main.rs:15: // TODO: add better error handling

List only the file paths (like grep -l):

finder -s "TODO" -l

Output:

src/lib.rs
src/main.rs

Show match count per file (like grep -c):

finder -s "TODO" -c

Output:

src/lib.rs:3
src/main.rs:2

Structured output for scripts:

finder -s "error" --json

Output:

[
  {
    "path": "src/lib.rs",
    "matches": [
      {"line": 42, "content": "handle error cases"}
    ]
  }
]

Colors are automatic - on by default when outputting to a terminal, off when piping.

Force colors on (useful with less -R):

finder -s "pattern" --colour | less -R

Force colors off:

finder -s "pattern" --no-colour

Respect NO_COLOR environment variable:

NO_COLOR=1 finder -s "pattern"

finder -s "error" --json | jq '.[] | .path'

finder -s "TODO" -c | awk -F: '{sum+=$2} END {print sum}'

vim $(finder -f "config" -l)

finder -f "config"

finder -s "api_key" -i

finder -f ".log" | xargs ls -lh

finder -f ".ts" -s "interface"  # TypeScript
finder -f ".go" -s "func"        # Go
finder -f ".py" -s "class"       # Python