LLM Index

<index_dir> is mandatory for all commands and specifies the directory containing the mindex database. If not provided, show error and terminate execution.

All commands use uvx to run mindex from the remote Git repo — no permanent installation needed.

Base command

uvx --from git+https://github.com/varlabz/mindex mindex --index-dir <index_dir> <subcommand> [options]

Query (default action)

Use query strategy to search in the index.

• For full-text search using mindex search.
• For search in a file use mindex fsearch.
• For reading file content in chunks use mindex read.
• Try different query requests to find the best results.
• Try different tools parameters to fine-tune the search.
• Return relevant result in short form if not requested for detailed result explicitly.

Add Files to Index

Add one or more files to the searchable index. Supports glob patterns to batch-index multiple files at once. Files are stored with their full absolute path, content, size, and a SHA-256 hash. Re-adding an existing file updates its content and timestamp.

mindex --index-dir <index_dir> add <file_or_glob>

Examples

# Add a single file
mindex --index-dir <index_dir> add notes/sqlite.md

# Add all markdown files in a directory
mindex --index-dir <index_dir> add 'docs/**/*.md'

# Add file with tilde expansion
mindex --index-dir <index_dir> add ~/projects/readme.md

Search

Full-text search across all indexed files using FTS5. Use FTS5 query syntax for advanced search capabilities (e.g., exact phrases with quotes, boolean operators). Minimum query length: 3 characters. Shorter queries will be rejected. Optionally filter results by file path using a glob pattern.

mindex --index-dir <index_dir> search "<query>" [path_glob] [options]

Options:

Examples

# Search all indexed files
mindex --index-dir <index_dir> search "sqlite fts5"

# Search with result limit
mindex --index-dir <index_dir> search "agent memory" --limit 20

# Search filtered by file path (glob)
mindex --index-dir <index_dir> search "memory" "notes/*.md"

# Plain text output
mindex --index-dir <index_dir> search "transformer architecture" --format text

# Exact phrase search with quotes
mindex --index-dir <index_dir> search '"exact phrase match"'

FTS5 Query Syntax Variations

mindex supports the full FTS5 query language for powerful text search:

Advanced Examples

# Prefix search — matches words starting with "pyth"
mindex --index-dir <index_dir> search 'pyth*'

# Boolean AND — both terms must appear
mindex --index-dir <index_dir> search 'python AND rust'

# Boolean OR — either term may appear
mindex --index-dir <index_dir> search 'python OR rust'

# Boolean NOT — must have python, must not have java
mindex --index-dir <index_dir> search 'python NOT java'

# Grouped complex query
mindex --index-dir <index_dir> search '(python OR rust) AND cli'

# OR-group (implicit OR via space in parens)
mindex --index-dir <index_dir> search '(python rust) AND cli'

# Combine with path filter
mindex --index-dir <index_dir> search 'python' '*.py' -n 10

# Phrase search with path filter
mindex --index-dir <index_dir> search '"async"' "*.rs"

Search Inside a File (fsearch)

Search within a specific indexed file using FTS5. Returns multiple matching snippets with character positions and context (~40 characters on each side). Useful for focused searches when you know which file contains the information you need.

mindex --index-dir <index_dir> fsearch "<query>" <file_path> [options]

Options:

Examples

# Search within a specific file
mindex --index-dir <index_dir> fsearch "fts5 tokenizer" notes/sqlite.md

# Search with result limit
mindex --index-dir <index_dir> fsearch "fts5" notes/sqlite.md --limit 5

# Plain text output
mindex --index-dir <index_dir> fsearch "fts5" notes/sqlite.md --format text

# Search with tilde expansion and limit with text output
mindex --index-dir <index_dir> fsearch "fts5" ~/notes/sqlite.md --format text --limit 10

Read File Content

Read the content of an indexed file, optionally from a specific position. Can be used to read large files in chunks by specifying --position and --size to avoid loading the entire file at once. Reads from the index database — the file must be indexed first with add. Don't set --size to big numbers more than 10000 to avoid loading a lot of data at once.

mindex --index-dir <index_dir> read <file_path> [options]

Options:

Examples

# Read first 4000 characters (default)
mindex --index-dir <index_dir> read notes/sqlite.md

# Read first 500 characters
mindex --index-dir <index_dir> read notes/sqlite.md --size 500

# Read content starting at character 1000, 2000 chars
mindex --index-dir <index_dir> read notes/sqlite.md --position 1000 --size 2000

# Read next chunk (continuation)
mindex --index-dir <index_dir> read notes/sqlite.md --position 2000 --size 2000

Info

Show metadata about indexed files — path, size, last updated timestamp. Useful for checking whether a file is indexed, listing files matching a glob pattern, or reviewing file properties without reading the full content.

mindex --index-dir <index_dir> list <file_or_glob> [options]
# or use the `ls` alias
mindex --index-dir <index_dir> ls <file_or_glob> [options]

Options:

Examples

# Show info for a specific file
mindex --index-dir <index_dir> list notes/sqlite.md

# List info for files matching a glob pattern
mindex --index-dir <index_dir> list 'notes/*.md'

# Plain text output
mindex --index-dir <index_dir> list notes/sqlite.md --format text

Lint Index

Check the integrity of the index — verifies all indexed files still exist on disk and optionally belong to a specific directory.

mindex --index-dir <index_dir> lint [directory] [options]

Options:

Examples

# Lint all indexed files
mindex --index-dir <index_dir> lint

# Lint files in a specific directory
mindex --index-dir <index_dir> lint notes/

Remove File from Index (dangerous)

Remove one or more files from the index (does not delete the actual file on disk). Supports glob patterns to batch-remove multiple files at once. It's dangerous to use this command, as it permanently removes entries from the index.

mindex --index-dir <index_dir> rm <file_or_glob>

Examples

# Remove single file from index
mindex --index-dir <index_dir> rm notes/old-notes.md

# Batch-remove all files matching a pattern
mindex --index-dir <index_dir> rm 'temp/*.md'

Tips