Documentation & Libraries

Calcit includes built-in commands to navigate the language guidebook and discover community libraries.

Guidebook Access (`docs`)

The docs subcommand allows you to read the language guidebook (like this one) without leaving the terminal.

Reading Chapters

# List all chapters in the guidebook
calcit docs list

# Read a specific file (fuzzy matching supported)
calcit docs read run.md

# List headings in a file (best first step before narrowing)
calcit docs read run.md

# Jump by heading keyword(s)
calcit docs read run.md quick start

# Search for keywords across all chapters
calcit docs search "polymorphism"

calcit docs read supports fuzzy heading matching to jump straight to a section:

# Display the "Quick start" section of run.md
calcit docs read run.md "Quick start"

# Exclude subheadings from the output
calcit docs read run.md "Quick start" --no-subheadings

Precision Reading (`read-lines`)

Use read-lines for large files where you need a specific range:

# Read 50 lines starting from line 100 of common-patterns.md
calcit docs read-lines common-patterns.md --start 100 --lines 50

Pattern 1: Discover headings first, then narrow

calcit docs read query.md
calcit docs read query.md usages

Pattern 2: Search globally, then open exact chapter

calcit docs search trait
calcit docs read traits.md

Library Discovery (`libs`)

The libs subcommand helps you find and understand Calcit modules.

Searching Registry

# Search for libraries related to "web"
calcit libs search web

Reading Readmes

You can read the documentation of any official library, even if not installed locally:

# Show README of 'respo' module
calcit libs readme respo

# Read a specific markdown file inside package
calcit libs readme respo -f Skills.md

Scanning for Documentation

# List all markdown files inside the local 'memof' module
calcit libs scan-md memof

Collaborative validation (`check-md`)

docs check-md is used to verify that code blocks in your markdown documentation are correct and runnable:

calcit docs check-md README.md

It supports specific block types:

cirru: Run and validate.
cirru.no-run: Validate syntax and preprocessing without running.
cirru.no-check: Skip checking (illustrative).

Calcit Guide