doc
Access built-in documentation, guides, and the ImandraX API reference directly from the terminal. Designed for both human developers and LLM-driven coding agents.
Tip: Running
codelogician doc --helpdisplays the full documentation tree with all available sections.
codelogician doc COMMAND [OPTIONS]Subcommands
| Command | Description |
|---|---|
dump | Save the skill/ documentation directory to a specified path |
search | Search documentation, error corpus, and prelude reference |
doc dump
Save the skill/ documentation directory to a specified path.
codelogician doc dump DIR_PATHArguments:
| Argument | Description |
|---|---|
DIR_PATH | Directory path to copy skill/ docs into (required) |
Example:
codelogician doc dump ./iml-docsdoc search
Search across documentation, error corpus, and prelude reference.
codelogician doc search COMMAND [OPTIONS]Subcommands:
| Command | Description |
|---|---|
md <query> | Fuzzy match markdown file names and descriptions |
error <query> | Search error_corpus.json (common IML errors and fixes) |
prelude <query> | Search prelude.json (built-in modules and functions) |
schema | Print the JSON schema for --json requests |
Options:
| Option | Description |
|---|---|
-n <N> | Maximum number of results (default: 10) |
--json '{...}' | JSON search request |
Example:
# Search markdown files
codelogician doc search md "region decomposition"
# Search error corpus
codelogician doc search error "type error"
# Search prelude (modules/functions)
codelogician doc search prelude "List"
# Limit results
codelogician doc search md "verification" -n 3
# JSON search
codelogician doc search md --json '{"query": "test", "max_results": 5}'