How gaurgle/notez works
notez is a local-first notes and todo manager exposed through a Rust CLI/TUI, with notez-core providing the shared scope and data model. The main workflow is CLI dispatch into note, tree, search, or todo operations; scope resolution and aggregation determine which vault files are visible, and interactive edits persist locally. The README documents project/global/personal/scratch scopes, project docs, tags, migration, and Git sync. Some command implementations were not excerpted, so their connections are shown only where documented; epoz is a separate repository.
Main entry points: main.rs Command Dispatch · aggregate.rs Note Aggregation · todo.rs Todo Command · tree.rs Tree Browser Command
Components 22
CLI and TUI
- Command Dispatch
crates/notez-cli/src/main.rs - CLI Surface
crates/notez-cli/src/cli/mod.rs - Note Commands
crates/notez-cli/src/commands/add.rs - Edit and Rename
crates/notez-cli/src/commands/edit.rs - Tree Browser Command
crates/notez-cli/src/commands/tree.rs - Tree Browser TUI
crates/notez-cli/src/tui/tree.rs - Search Command
crates/notez-cli/src/commands/search.rs - Todo Command
crates/notez-cli/src/commands/todo.rs - Todo Board TUI
crates/notez-cli/src/tui/todo.rs
Scope and Notes
- Scope Model
crates/notez-core/src/core/scope.rs - Scope Resolution
crates/notez-core/src/core/resolve.rs - Note Aggregation
crates/notez-core/src/core/aggregate.rs - Full-Text Search
crates/notez-core/src/search.rs
Todo and Tags
- Todo Board Logic
crates/notez-core/src/todo/mod.rs - Tags and Filters
crates/notez-core/src/tags.rs
Configuration
- Config and Paths
crates/notez-core/src/config/mod.rs - Project Registry
crates/notez-core/src/config/registry.rs
Vault Operations
- Vault Sync
crates/notez-core/src/sync.rs - Legacy Migration
crates/notez-core/src/migrate.rs - Local Note Vault
Other components
- CLI User
- Git Remote
Connections 28
- CLI User → Command Dispatch: invokes
crates/notez-cli/src/main.rs - Command Dispatch → CLI Surface: parses
crates/notez-cli/src/main.rs - Command Dispatch → Note Commands: dispatches
crates/notez-cli/src/main.rs - Command Dispatch → Tree Browser Command: dispatches
crates/notez-cli/src/main.rs - Command Dispatch → Todo Command: dispatches
crates/notez-cli/src/main.rs - Command Dispatch → Edit and Rename: dispatches
crates/notez-cli/src/main.rs - Note Commands → Local Note Vault: writes notes
README.md - Edit and Rename → Note Aggregation: selects in-scope notes
README.md - Tree Browser Command → Note Aggregation: assembles entries
crates/notez-core/src/core/aggregate.rs - Tree Browser Command → Tree Browser TUI: opens browser
crates/notez-cli/src/tui/tree.rs - Tree Browser TUI → Tags and Filters: loads tag flags
crates/notez-cli/src/tui/tree.rs - Search Command → Full-Text Search: searches notes
README.md - Full-Text Search → Note Aggregation: collects entries
crates/notez-core/src/search.rs - Full-Text Search → Local Note Vault: reads content
crates/notez-core/src/search.rs - Todo Command → Todo Board Logic: assembles board
- Todo Command → Todo Board TUI: opens board
crates/notez-cli/src/tui/todo.rs - Todo Board TUI → Todo Board Logic: mutates tasks
crates/notez-cli/src/tui/todo.rs - Todo Board Logic → Tags and Filters: uses tag model
crates/notez-core/src/todo/mod.rs - Todo Command → Local Note Vault: saves edited sources
README.md - Note Aggregation → Scope Model: labels entries
crates/notez-core/src/core/aggregate.rs - Note Aggregation → Project Registry: walks projects
crates/notez-core/src/core/aggregate.rs - Note Aggregation → Config and Paths: uses configured roots
crates/notez-core/src/core/aggregate.rs - Scope Resolution → Scope Model: resolves scope
crates/notez-core/src/core/resolve.rs - Config and Paths → Local Note Vault: locates vault
crates/notez-core/src/config/mod.rs - Project Registry → Config and Paths: uses config paths
crates/notez-core/src/config/registry.rs - Vault Sync → Local Note Vault: syncs global vault
README.md - Vault Sync → Git Remote: pulls and pushes
README.md - Legacy Migration → Local Note Vault: converts layout
README.md