LLM Wiki

LLM Wiki

is mandatory for all commands and specifies the directory where the wiki index is stored. If not provided, show error and terminate execution.

SCHEMA.md is required in before performing any operations. If it does not exist, show error and terminate execution.

Read the SCHEMA.md template file to understand the structure and rules for the wiki index in before using any commands. Must follow precisely the instructions defined in SCHEMA.md in .

All commands use uvx to run mindex-cli on the fly — no permanent installation needed.

Base command:

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

Ingest File

Add a file in the searchable index. The file name for the summary is the same as the original file with replaced directory dividers on '-' (e.g., raw/sqlite.md → summary/raw-sqlite.md). A Summary file must be stored in the summary/ in directory.

• must contain a title, summary, reference to the original file, and relevant tags.
• summary should be concise and informative, highlighting key points from the original file.
• reference to the original file (e.g., [Original](raw/sqlite.md)).
• tags in summary file (e.g., #database #sqlite). Update index file.

mindex-cli --index-dir <index_dir> add <file.md>
mindex-cli --index-dir <index_dir> add <summary_file.md>

Examples

# simple case
mindex-cli --index-dir <index_dir> add raw/sqlite.md
mindex-cli --index-dir <index_dir> add summary/raw-sqlite.md

# with long path
mindex-cli --index-dir <index_dir> add raw/notes/sqlite.md
mindex-cli --index-dir <index_dir> add summary/raw-notes-sqlite.md

# with absolute path
mindex-cli --index-dir <index_dir> add /home/user/wiki/raw/sqlite.md
mindex-cli --index-dir <index_dir> add summary/home-user-wiki-summary-sqlite.md

Search (default command)

Full-text search across all indexed markdown 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. Search in index file. Search in summaries for more concise results, then expand to raw files if needed. Search in raw files for more detailed information if summaries don't provide enough context. Search in file with mindex-cli file command for more focused search within a specific file. Read specific files with mindex-cli read command to get full content when you find relevant summaries or search results. Change search request if don't get relevant results — try different keywords, use quotes for exact phrases.

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

Options:

Examples

# Search everywhere
mindex-cli --index-dir <index_dir> search "sqlite fts5"

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

# Search with tag `summary` for search in summaries
mindex-cli --index-dir <index_dir> search "memory"

# Search with tag `raw` for search in original files
mindex-cli --index-dir <index_dir> search "memory"

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

Search Inside a File

Search within a specific indexed file using FTS5. Useful for focused searches when you know which file contains the information you need.

mindex-cli --index-dir <index_dir> file <file.md> "<query>" [options]

Options:

Examples

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

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

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

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 into memory at once.

mindex-cli --index-dir <index_dir> read <file.md> [options]

Options:

Examples

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

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

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

Info

Show metadata about indexed files — path, size, last updated timestamp, and tag. Useful for checking whether a file is indexed, listing files by tag, listing files matching a glob pattern, or reviewing file properties without reading the full content. The file argument supports glob patterns (e.g., *.md) to filter by path.

mindex-cli --index-dir <index_dir> info [file.md] [options]

Options:

Examples

# Show file info (JSON output)
mindex-cli --index-dir <index_dir> info raw/sqlite.md

# Show file info (text output)
mindex-cli --index-dir <index_dir> info raw/sqlite.md --format text

# List all files with a specific tag
mindex-cli --index-dir <index_dir> info

# List all files with a specific tag (text output)
mindex-cli --index-dir <index_dir> info --format text

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

# List all indexed files (no file argument)
mindex-cli --index-dir <index_dir> info

Lint Index Directory

• Check the integrity of the wiki index, ensuring all indexed files exist on disk and belong to the correct directory as defined in SCHEMA.md.
• Don't use --fix to delete records. Need to confirm deletion before records are deleted.

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

# lint files in a specific directory
mindex-cli --index-dir <index_dir> lint <directory>

# plain text output
mindex-cli --index-dir <index_dir> lint --format text

# fix: delete records for files that no longer exist
mindex-cli --index-dir <index_dir> lint --fix

# fix: delete records for missing files in a specific directory
mindex-cli --index-dir <index_dir> lint <directory> --fix

Remove File from Index (dangerous)

Remove one or more files from the index (does not delete the actual file). Supports glob patterns (e.g., *.md) to batch-remove multiple files at once.

mindex-cli --index-dir <index_dir> rm <file.md>

Options:

Examples

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

# Batch-remove all summary files
mindex-cli --index-dir <index_dir> rm 'summary/*.md'

Tips