index
Pour Documentation
For LLMs: Start here. Navigate to a directory index for scoped exploration, or jump directly to a core document below.
For Humans: See above… but use the graph to guide your exploration!
Directory Indexes (00 index/)
| Directory | Index | Contents |
|---|---|---|
02 references/ |
REFERENCES | Library API references and external docs |
04 architecture/ |
ARCHITECTURE | Design spec, ADRs |
05 notes/ |
NOTES | Active development notes |
07 stories/ |
STORIES | Vision and manifesto |
08 specs/ |
SPECS | Feature and component specifications |
Core Documents
- pour-design-spec — Complete design specification (source of truth)
- the_pour_manifesto — Why we build Pour
Quick Reference
Common Commands
cargo build # compile
cargo run # run dashboard
cargo run -- coffee # run a specific module
cargo test # run all tests
cargo clippy # lint
cargo fmt # format
Key File Locations
| Area | File |
|---|---|
| Entry point | src/main.rs |
| Config schema | ~/.config/pour/config.toml |
| Cache | ~/.cache/pour/state.json |
Architecture Overview
Pour writes to Obsidian via a hybrid transport layer:
- API — HTTP via reqwest to Obsidian Local REST API (
http://127.0.0.1:27124) - File System — Direct
std::fsfallback if API unavailable
Dynamic Data Fetching (3-tier fallback)
API query -> disk scan -> ~/.cache/pour/state.json cache -> freetext input
Last Updated: 2026-03-31
Documentation Version: v0.1.0