# smolbren

## Docs

- [smolbren exit codes for shell scripting](https://smolbren.com/cli/exit-codes.md): smolbren uses structured exit codes so scripts and agents can handle errors programmatically. Reference for all exit codes and their meanings.
- [smolbren get — fetch a single note by ID](https://smolbren.com/cli/get.md): Retrieve a note's metadata and optionally its full body text by note ID. The note ID is the vault-relative path without the .md extension.
- [smolbren index — build and update the search index](https://smolbren.com/cli/index.md): Build or update the smolbren search index for a vault. Supports incremental updates by default; use --full for a complete rebuild.
- [smolbren links and backlinks — traverse graph edges](https://smolbren.com/cli/links.md): Fetch outgoing links (links) and incoming links (backlinks) for any note. Filter by edge type to focus on specific relationship kinds.
- [smolbren output format: single-line JSON on stdout](https://smolbren.com/cli/output-format.md): Every smolbren command prints exactly one line of compact JSON to stdout. Errors go to stderr as structured JSON with an error and code field.
- [smolbren CLI overview and global flags](https://smolbren.com/cli/overview.md): Overview of all smolbren commands and global flags. Every command outputs single-line JSON to stdout; errors go to stderr with a structured code field.
- [smolbren query — Cypher queries over the knowledge graph](https://smolbren.com/cli/query.md): Execute Cypher queries over the graph built from your vault's frontmatter types and wikilink edges. Pass parameters with --param key=value.
- [smolbren search — BM25 full-text search over your vault](https://smolbren.com/cli/search.md): Run BM25 full-text search over indexed note bodies and titles. Filter by note type and control the number of results with --type and --limit.
- [smolbren types and edges — inspect the vault ontology](https://smolbren.com/cli/types.md): List all note types with counts (types) and all edge relationship types with counts (edges). Use these to discover your vault's ontology before writing queries.
- [smolbren vault — manage your registered vaults](https://smolbren.com/cli/vault.md): Register, list, and remove Markdown vaults with smolbren vault add, list, and remove. Vaults are named references to your Markdown directories.
- [How smolbren indexes your vault](https://smolbren.com/concepts/indexing.md): smolbren uses incremental indexing with content hashing to keep your vault's search index fast and up to date with minimal overhead.
- [Ontologies: types and edges auto-discovered from frontmatter](https://smolbren.com/concepts/ontology.md): smolbren builds an ontology from your notes' frontmatter automatically. The type key defines node labels; wikilink values define typed graph edges.
- [Search modes: full-text and graph queries](https://smolbren.com/concepts/search.md): smolbren provides BM25 full-text search over note bodies and Cypher graph queries over the typed edge graph built from your frontmatter.
- [What is a Vault? Managing your Markdown sources](https://smolbren.com/concepts/vaults.md): A vault is a directory of Markdown files that smolbren indexes. Learn how to register, list, and remove vaults, and how data is stored locally.
- [smolbren config file reference](https://smolbren.com/configuration/config-file.md): Configure smolbren vaults and defaults via ~/.smolbren/config.json. Reference for all supported fields, paths, and example configurations.
- [Environment variables for smolbren](https://smolbren.com/configuration/environment-variables.md): Override smolbren configuration with SMOLBREN_* environment variables. Useful for CI, containers, and multi-vault scripting workflows.
- [Index and search your Obsidian vault with smolbren](https://smolbren.com/guides/obsidian-setup.md): Register your Obsidian vault with smolbren, build the initial index, and start searching your notes with BM25 and Cypher from the terminal.
- [Traverse your vault knowledge graph with Cypher queries](https://smolbren.com/guides/querying-graph.md): Use Cypher queries to traverse the typed edge graph built from your vault's frontmatter wikilinks. Includes patterns for common knowledge-graph lookups.
- [Use smolbren in shell scripts and AI agent pipelines](https://smolbren.com/guides/scripting-agents.md): Automate smolbren from scripts and AI agents: every command prints single-line JSON, uses structured exit codes, and pipes cleanly into jq.
- [Install smolbren: prerequisites, cargo install, first run](https://smolbren.com/installation.md): Install smolbren via Cargo, satisfy the Rust toolchain and protoc prerequisites, and confirm the binary is ready to use on your machine.
- [smolbren: ontology-first search for Markdown notes](https://smolbren.com/introduction.md): smolbren turns your Markdown vault into a queryable knowledge graph. Learn what it does, who it is for, and how its key concepts fit together.
- [Get started with smolbren: index and search your vault](https://smolbren.com/quickstart.md): Install smolbren, register your vault, build the index, and run your first search and Cypher graph query in well under five minutes.