Core Concepts
Understanding how Chisel structures information will help you get the most out of the tool suite.
The .chisel Workspace
Section titled “The .chisel Workspace”Every Chisel project revolves around the .chisel/ directory. This is where your knowledge base and specs live. Keeping this data in your repo ensures it follows your code’s lifecycle (branches, reverts, and history).
Text-as-Source-of-Truth
Section titled “Text-as-Source-of-Truth”Unlike tools that hide your data in a database, Chisel uses standard files:
- Docs: Nested Markdown files in
.chisel/docs/. - Specs: Lifecycle-driven Markdown files in
.chisel/specs/{active,shipped,archived}/.
The Hybrid Engine
Section titled “The Hybrid Engine”While the source of truth is text, Chisel maintains a local SQLite FTS5 index (.chisel/index.db).
- Performance: Instant search results even with thousands of documents and specs.
- AI Readiness: The index provides the foundation for semantic search and RAG (Retrieval-Augmented Generation) workflows.
Human vs Machine Modes
Section titled “Human vs Machine Modes”Every Chisel command supports two outputs:
- Human (Default): A rich, interactive TUI optimized for developer speed.
- Machine (
--machine): A token-dense YAML output optimized for LLM context windows and script automation.