seeknal docs¶

Search and browse Seeknal CLI documentation from the terminal.

Synopsis¶

seeknal docs [QUERY] [OPTIONS]

Description¶

The docs command provides searchable access to CLI documentation directly from your terminal. It searches all doc topics in docs/cli/ using full-text search powered by ripgrep.

When given an exact topic name (matching a filename stem like repl, env, run), it displays that topic directly. Otherwise, it performs a full-text search across all documentation files.

Candidate 2.13.0 wheels bundle these topics under the installed package. Installed topics take precedence over a current project's docs/cli, so the command works outside a repository. Source checkouts fall back to repository topics when bundled topics are absent. This does not fetch newer docs from GitHub or update the installed package.

Options¶

Flag	Type	Default	Description
`QUERY`	TEXT	None	Search query or exact topic name
`--list`, `-l`	FLAG	False	List all available documentation topics
`--json`	FLAG	False	Output results as JSON (useful for tooling)
`--max-results`, `-n`	INTEGER	50	Maximum number of search results

Examples¶

List all topics¶

seeknal docs --list

Search for a topic¶

seeknal docs repl
seeknal docs iceberg-upsert
seeknal docs upgrade

Full-text search¶

seeknal docs "materialization"

JSON output¶

seeknal docs --json "environment"
seeknal docs --json iceberg-upsert

Limit results¶

seeknal docs "transform" --max-results 5

Prerequisites¶

Full-text search requires ripgrep (rg). If not installed, the command will show platform-specific installation instructions:

macOS: brew install ripgrep
Linux: apt install ripgrep or snap install ripgrep
Windows: choco install ripgrep or scoop install ripgrep

Exact topic matches work without ripgrep.