RLM-RS CLI Reference

Complete command-line interface reference for rlm-cli.

Global Options

These options apply to all commands:

Option	Environment	Description
`-d, --db-path <PATH>`	`RLM_DB_PATH`	Path to SQLite database (default: `.rlm/rlm-state.db`)
`-v, --verbose`		Enable verbose output
`--format <FORMAT>`		Output format: `text` (default) or `json`
`-h, --help`		Print help information
`-V, --version`		Print version

Commands

Database Management

`init`

Initialize the RLM database. Creates the database file and schema if they don't exist.

rlm-cli init [OPTIONS]

Options:

Option	Description
`-f, --force`	Force re-initialization (destroys existing data)

Examples:

# Initialize new database
rlm-cli init

# Re-initialize (destroys existing data)
rlm-cli init --force

`status`

Show current RLM state including database info, buffer count, and statistics.

rlm-cli status

Example Output:

RLM Status
==========
Database: .rlm/rlm-state.db (245 KB)
Buffers: 3
Total chunks: 42
Variables: 2

JSON Output:

rlm-cli status --format json

`reset`

Delete all RLM state (buffers, chunks, variables). Use with caution.

rlm-cli reset [OPTIONS]

Options:

Option	Description
`-y, --yes`	Skip confirmation prompt

Examples:

# Interactive reset (prompts for confirmation)
rlm-cli reset

# Non-interactive reset
rlm-cli reset --yes

Buffer Operations

`load`

Load a file into a buffer with automatic chunking and embedding generation.

Embeddings are automatically generated during load for semantic search support.

rlm-cli load [OPTIONS] <FILE>

Arguments:

Argument	Description
`<FILE>`	Path to the file to load

Options:

Option	Default	Description
`-n, --name <NAME>`	filename	Custom name for the buffer
`-c, --chunker <STRATEGY>`	`semantic`	Chunking strategy: `fixed`, `semantic`, `code`, `parallel`
`--chunk-size <SIZE>`	`3000`	Chunk size in characters (~750 tokens)
`--overlap <SIZE>`	`500`	Overlap between chunks in characters

Chunking Strategies:

Strategy	Best For	Description
`semantic`	Markdown, prose	Splits at sentence/paragraph boundaries
`code`	Source code	Language-aware chunking at function/class boundaries
`fixed`	Logs, binary, raw text	Splits at exact character boundaries
`parallel`	Large files (>10MB)	Multi-threaded fixed chunking

Code Chunker Supported Languages: Rust, Python, JavaScript, TypeScript, Go, Java, C/C++, Ruby, PHP

Examples:

# Load with default settings (semantic chunking)
rlm-cli load document.md

# Load with custom name
rlm-cli load document.md --name my-docs

# Load with fixed chunking and custom size
rlm-cli load logs.txt --chunker fixed --chunk-size 50000

# Load large file with parallel chunking
rlm-cli load huge-file.txt --chunker parallel --chunk-size 100000 --overlap 1000

`list` (alias: `ls`)

List all buffers in the database.

rlm-cli list

Example Output:

ID  Name           Size      Chunks  Created
1   document.md    125,432   4       2024-01-15 10:30:00
2   config.json    2,048     1       2024-01-15 10:35:00
3   logs.txt       1,048,576 26      2024-01-15 10:40:00

JSON Output:

rlm-cli list --format json

`show`

Show detailed information about a specific buffer.

rlm-cli show [OPTIONS] <BUFFER>

Arguments:

Argument	Description
`<BUFFER>`	Buffer ID (number) or name

Options:

Option	Description
`-c, --chunks`	Include chunk details

Examples:

# Show buffer by name
rlm-cli show document.md

# Show buffer by ID
rlm-cli show 1

# Show buffer with chunk details
rlm-cli show document.md --chunks

`delete` (alias: `rm`)

Delete a buffer and its associated chunks.

rlm-cli delete [OPTIONS] <BUFFER>

Arguments:

Argument	Description
`<BUFFER>`	Buffer ID or name to delete

Options:

Option	Description
`-y, --yes`	Skip confirmation prompt

Examples:

# Delete with confirmation
rlm-cli delete document.md

# Delete without confirmation
rlm-cli delete 1 --yes

`add-buffer`

Create a new buffer from text content. Useful for storing intermediate results.

rlm-cli add-buffer <NAME> [CONTENT]

Arguments:

Argument	Description
`<NAME>`	Name for the new buffer
`[CONTENT]`	Text content (reads from stdin if omitted)

Examples:

# Add buffer with inline content
rlm-cli add-buffer summary "This is the summary of chunk 1..."

# Add buffer from stdin
echo "Content from pipe" | rlm-cli add-buffer piped-content

# Add buffer from file via stdin
cat results.txt | rlm-cli add-buffer results

`export-buffers`

Export all buffers to a file (JSON format).

rlm-cli export-buffers [OPTIONS]

Options:

Option	Description
`-o, --output <FILE>`	Output file path (stdout if omitted)
`-p, --pretty`	Pretty-print JSON output

Examples:

# Export to stdout
rlm-cli export-buffers --format json

# Export to file
rlm-cli export-buffers --output backup.json --pretty

Content Operations

`peek`

View a slice of buffer content without loading the entire buffer.

rlm-cli peek [OPTIONS] <BUFFER>

Arguments:

Argument	Description
`<BUFFER>`	Buffer ID or name

Options:

Option	Default	Description
`--start <OFFSET>`	`0`	Start offset in bytes
`--end <OFFSET>`	`start + 3000`	End offset in bytes

Examples:

# View first 3000 bytes (default)
rlm-cli peek document.md

# View specific range
rlm-cli peek document.md --start 1000 --end 5000

# View from offset to default length
rlm-cli peek document.md --start 10000

`grep`

Search buffer content using regular expressions.

rlm-cli grep [OPTIONS] <BUFFER> <PATTERN>

Arguments:

Argument	Description
`<BUFFER>`	Buffer ID or name
`<PATTERN>`	Regular expression pattern

Options:

Option	Default	Description
`-n, --max-matches <N>`	`20`	Maximum matches to return
`-w, --window <SIZE>`	`120`	Context characters around each match
`-i, --ignore-case`		Case-insensitive search

Examples:

# Basic search
rlm-cli grep document.md "error"

# Case-insensitive search
rlm-cli grep document.md "TODO" --ignore-case

# Regex pattern with context
rlm-cli grep logs.txt "ERROR.*timeout" --window 200 --max-matches 50

# Search by buffer ID
rlm-cli grep 1 "function.*async"

Chunking Operations

`chunk-indices`

Calculate and display chunk boundaries for a buffer without writing files.

rlm-cli chunk-indices [OPTIONS] <BUFFER>

Arguments:

Argument	Description
`<BUFFER>`	Buffer ID or name

Options:

Option	Default	Description
`--chunk-size <SIZE>`	`3000`	Chunk size in characters
`--overlap <SIZE>`	`500`	Overlap between chunks

Examples:

# Show chunk boundaries with defaults
rlm-cli chunk-indices document.md

# Custom chunk size
rlm-cli chunk-indices document.md --chunk-size 20000 --overlap 1000

`write-chunks`

Split a buffer into chunk files for processing.

rlm-cli write-chunks [OPTIONS] <BUFFER>

Arguments:

Argument	Description
`<BUFFER>`	Buffer ID or name

Options:

Option	Default	Description
`-o, --out-dir <DIR>`	`.rlm/chunks`	Output directory
`--chunk-size <SIZE>`	`3000`	Chunk size in characters
`--overlap <SIZE>`	`500`	Overlap between chunks
`--prefix <PREFIX>`	`chunk`	Filename prefix

Output Files: Files are named {prefix}_{index}.txt (e.g., chunk_0.txt, chunk_1.txt).

Examples:

# Write chunks with defaults
rlm-cli write-chunks document.md

# Custom output directory and prefix
rlm-cli write-chunks document.md --out-dir ./output --prefix doc

# Custom chunk size for smaller chunks
rlm-cli write-chunks large.txt --chunk-size 20000 --overlap 500

Search Operations

`search`

Search chunks using hybrid semantic + BM25 search with Reciprocal Rank Fusion (RRF).

rlm-cli search [OPTIONS] <QUERY>

Arguments:

Argument	Description
`<QUERY>`	Search query text

Options:

Option	Default	Description
`-k, --top-k <N>`	`10`	Maximum number of results
`-t, --threshold <SCORE>`	`0.3`	Minimum similarity threshold (0.0-1.0)
`-m, --mode <MODE>`	`hybrid`	Search mode: `hybrid`, `semantic`, `bm25`
`--rrf-k <K>`	`60`	RRF k parameter for rank fusion
`-b, --buffer <BUFFER>`		Filter by buffer ID or name
`-p, --preview`		Include content preview in results
`--preview-len <N>`	`150`	Preview length in characters

Search Modes:

Mode	Description
`hybrid`	Combines semantic and BM25 scores using RRF (recommended)
`semantic`	Vector similarity search using embeddings
`bm25`	Traditional full-text search with BM25 scoring

Examples:

# Basic hybrid search
rlm-cli search "database connection errors"

# Search with more results
rlm-cli search "API endpoints" --top-k 20

# Semantic-only search
rlm-cli search "authentication flow" --mode semantic

# Search specific buffer
rlm-cli search "error handling" --buffer logs

# Search with content preview
rlm-cli search "auth" --preview --preview-len 200

# JSON output for programmatic use
rlm-cli --format json search "your query" --top-k 10

Output (JSON format):

{
  "count": 2,
  "mode": "hybrid",
  "query": "your query",
  "results": [
    {"chunk_id": 42, "score": 0.0328, "semantic_score": 0.0499, "bm25_score": 1.6e-6},
    {"chunk_id": 17, "score": 0.0323, "semantic_score": 0.0457, "bm25_score": 1.2e-6}
  ]
}

Extract chunk IDs: jq -r '.results[].chunk_id'

Agentic Workflow Operations

`update-buffer`

Update an existing buffer with new content, re-chunking and optionally re-embedding.

rlm-cli update-buffer [OPTIONS] <BUFFER> [CONTENT]

Arguments:

Argument	Description
`<BUFFER>`	Buffer ID or name
`[CONTENT]`	New content (reads from stdin if omitted)

Options:

Option	Default	Description
`-e, --embed`		Automatically embed new chunks after update
`--strategy <STRATEGY>`	`semantic`	Chunking strategy
`--chunk-size <SIZE>`	`3000`	Chunk size in characters
`--overlap <SIZE>`	`500`	Overlap between chunks

Examples:

# Update from stdin
cat updated.txt | rlm-cli update-buffer main-source

# Update with inline content
rlm-cli update-buffer my-buffer "new content here"

# Update and re-embed
rlm-cli update-buffer my-buffer --embed

# Update with custom chunking
cat new_code.rs | rlm-cli update-buffer code-buffer --strategy code

`dispatch`

Split chunks into batches for parallel subagent processing. Returns batch assignments with chunk IDs for orchestrator use.

rlm-cli dispatch [OPTIONS] <BUFFER>

Arguments:

Argument	Description
`<BUFFER>`	Buffer ID or name

Options:

Option	Default	Description
`--batch-size <N>`	`10`	Number of chunks per batch
`--workers <N>`		Number of worker batches (alternative to batch-size)
`-q, --query <QUERY>`		Filter to chunks matching this search query
`--mode <MODE>`	`hybrid`	Search mode for query filtering
`--threshold <SCORE>`	`0.3`	Minimum similarity threshold for filtering

Examples:

# Dispatch all chunks in batches of 10
rlm-cli dispatch my-buffer

# Create 4 batches for 4 parallel workers
rlm-cli dispatch my-buffer --workers 4

# Only dispatch chunks relevant to a query
rlm-cli dispatch my-buffer --query "error handling"

# JSON output for orchestrator
rlm-cli --format json dispatch my-buffer

Output (JSON format):

{
  "buffer_id": 1,
  "total_chunks": 42,
  "batch_count": 5,
  "batches": [
    {"batch_id": 0, "chunk_ids": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]},
    {"batch_id": 1, "chunk_ids": [11, 12, 13, 14, 15, 16, 17, 18, 19, 20]}
  ]
}

`aggregate`

Combine findings from analyst subagents. Reads JSON findings, filters by relevance, groups, and outputs a synthesizer-ready report.

rlm-cli aggregate [OPTIONS]

Options:

Option	Default	Description
`-b, --buffer <BUFFER>`		Read findings from a buffer (stdin if omitted)
`--min-relevance <LEVEL>`	`low`	Minimum relevance: `none`, `low`, `medium`, `high`
`--group-by <FIELD>`	`relevance`	Group by: `chunk_id`, `relevance`, `none`
`--sort-by <FIELD>`	`relevance`	Sort by: `relevance`, `chunk_id`, `findings_count`
`-o, --output-buffer <NAME>`		Store results in a new buffer

Input Format (JSON array of analyst findings):

[
  {"chunk_id": 12, "relevance": "high", "findings": ["Bug found"], "summary": "Critical issue"},
  {"chunk_id": 27, "relevance": "medium", "findings": ["Minor issue"], "summary": "Needs review"}
]

Examples:

# Aggregate from stdin
cat findings.json | rlm-cli aggregate

# Read from buffer
rlm-cli aggregate --buffer analyst-findings

# Filter to high relevance only
rlm-cli aggregate --min-relevance high

# Store aggregated results
rlm-cli aggregate --output-buffer synthesis-input

# JSON output
rlm-cli --format json aggregate

Chunk Operations

`chunk get`

Get a chunk by ID (primary pass-by-reference mechanism for subagents).

rlm-cli chunk get [OPTIONS] <ID>

Arguments:

Argument	Description
`<ID>`	Chunk ID (globally unique across all buffers)

Options:

Option	Description
`-m, --metadata`	Include metadata in output

Examples:

# Get chunk content
rlm-cli chunk get 42

# Get chunk with metadata (JSON)
rlm-cli --format json chunk get 42 --metadata

`chunk list`

List all chunks for a buffer.

rlm-cli chunk list [OPTIONS] <BUFFER>

Arguments:

Argument	Description
`<BUFFER>`	Buffer ID or name

Options:

Option	Default	Description
`-p, --preview`		Show a content preview for each chunk
`--preview-len <N>`	`100`	Preview length in characters

Examples:

# List chunks for buffer
rlm-cli chunk list docs

# List with content preview
rlm-cli chunk list docs --preview

# List with longer preview
rlm-cli chunk list docs --preview --preview-len 200

# JSON output
rlm-cli --format json chunk list docs | jq '.[].id'

`chunk embed`

Generate embeddings for buffer chunks. Note: Embeddings are automatically generated during load, so this is typically only needed with --force to re-embed.

rlm-cli chunk embed [OPTIONS] <BUFFER>

Arguments:

Argument	Description
`<BUFFER>`	Buffer ID or name

Options:

Option	Description
`-f, --force`	Force re-embedding even if embeddings exist

Examples:

# Check if embeddings exist (will report "already embedded")
rlm-cli chunk embed docs

# Force re-embedding
rlm-cli chunk embed docs --force

`chunk status`

Show embedding status for all buffers.

rlm-cli chunk status

Example Output:

Embedding Status
================

Total: 42/42 chunks embedded

Buffer           ID    Chunks  Embedded
docs             1     15      15
logs             2     27      27

Variable Operations

`var`

Manage context-scoped variables (persisted per session/context).

rlm-cli var [OPTIONS] <NAME> [VALUE]

Arguments:

Argument	Description
`<NAME>`	Variable name
`[VALUE]`	Value to set (omit to get current value)

Options:

Option	Description
`-d, --delete`	Delete the variable

Examples:

# Set a variable
rlm-cli var current_chunk 3

# Get a variable
rlm-cli var current_chunk

# Delete a variable
rlm-cli var current_chunk --delete

`global`

Manage global variables (persisted across all contexts).

rlm-cli global [OPTIONS] <NAME> [VALUE]

Arguments:

Argument	Description
`<NAME>`	Variable name
`[VALUE]`	Value to set (omit to get current value)

Options:

Option	Description
`-d, --delete`	Delete the variable

Examples:

# Set a global variable
rlm-cli global project_name "my-project"

# Get a global variable
rlm-cli global project_name

# Delete a global variable
rlm-cli global project_name --delete

Configuration

Default Chunk Sizes

Parameter	Default	Description
`chunk_size`	3,000 chars	~750 tokens (optimized for semantic search)
`overlap`	500 chars	Context continuity between chunks
`max_chunk_size`	50,000 chars	Maximum allowed chunk size

Environment Variables

Variable	Description
`RLM_DB_PATH`	Default database path

Exit Codes

Code	Description
`0`	Success
`1`	General error
`2`	Invalid arguments

Output Formats

All commands support multiple output formats via --format:

Format	Description
`text`	Human-readable text (default)
`json`	JSON for programmatic use
`ndjson`	Newline-delimited JSON for streaming

# Status as JSON
rlm-cli status --format json

# List buffers as JSON
rlm-cli list --format json

# Search results as JSON
rlm-cli grep document.md "pattern" --format json

# NDJSON for streaming pipelines
rlm-cli --format ndjson chunk list my-buffer

FilesExpand file tree

cli-reference.md

Latest commit

History

cli-reference.md

File metadata and controls

RLM-RS CLI Reference

Global Options

Commands

Database Management

init

status

reset

Buffer Operations

load

list (alias: ls)

show

delete (alias: rm)

add-buffer

export-buffers

Content Operations

peek

grep

Chunking Operations

chunk-indices

write-chunks

Search Operations

search

Agentic Workflow Operations

update-buffer

dispatch

aggregate

Chunk Operations

chunk get

chunk list

chunk embed

chunk status

Variable Operations

var

global

Configuration

Default Chunk Sizes

Environment Variables

Exit Codes

Output Formats

See Also

`init`

`status`

`reset`

`load`

`list` (alias: `ls`)

`show`

`delete` (alias: `rm`)

`add-buffer`

`export-buffers`

`peek`

`grep`

`chunk-indices`

`write-chunks`

`search`

`update-buffer`

`dispatch`

`aggregate`

`chunk get`

`chunk list`

`chunk embed`

`chunk status`

`var`

`global`