Struct KnowledgeBase 

pub struct KnowledgeBase { /* private fields */ }

Markdown knowledge base application layer.

Wraps VirtualFs for sandboxed file I/O, BacklinkIndex for link tracking, and provides all app-layer features (chat, journal, habits, checklist, etc.).

No kernel dependencies. Can be used standalone by any channel.

Implementations

impl KnowledgeBase

pub fn new(root: PathBuf) -> Result<Self>

Create a new KnowledgeBase for the given root directory.

pub fn for_space(space_dir: &Path) -> Result<Self>

Create a new KnowledgeBase scoped to a Space’s subdirectory.

pub fn root(&self) -> PathBuf

Get the root path of the knowledge base.

pub fn on_file_change<F>(&self, f: F)

where F: Fn(&str, FileChange) + Send + Sync + 'static,

Register a callback to be invoked on every file change.

The callback receives (path, FileChange). Multiple callbacks can be registered.

pub fn note_read(&self, path: &str) -> Result<Option<String>>

Read a note’s content.

pub fn note_write(&self, path: &str, content: &str) -> Result<()>

Write a note — creates or overwrites.

Writes the .md file via VirtualFs, updates the backlink index, and notifies registered on_file_change callbacks.

pub fn note_delete(&self, path: &str) -> Result<()>

Delete a note.

pub fn note_restore(&self, path: &str, content: &str) -> Result<()>

Restore a note’s content without triggering file-change callbacks.

Used when reverting to a previous git version — writes the file and updates the backlink index, but does not fire on_file_change callbacks. This prevents an infinite loop where restore → write → callback → git commit → … repeats.

pub fn note_move(&self, old_path: &str, new_path: &str) -> Result<()>

Move/rename a note.

pub fn note_tree(&self, dir: &str) -> Result<Vec<FileEntry>>

List notes in a directory.

pub fn search(&self, query: &str, limit: usize) -> Result<Vec<NoteHit>>

Search notes by file name fuzzy matching.

Note: Semantic search is handled by KnowledgeLens, not by this method.

pub fn backlinks_for(&self, path: &str) -> Vec<Backlink>

Get backlinks for a note.

pub fn link_graph(&self) -> LinkGraph

Get the full link graph for visualization.

pub fn index_all(&self) -> Result<usize>

Index all markdown files in the knowledge base.

Walks the entire directory tree and builds the backlink index. Returns the number of files indexed.

pub fn chat_append(&self, message: &str) -> Result<()>

Append a timestamped message to Chat.md.

pub fn chat_messages(&self) -> Result<Vec<String>>

Parse Chat.md into structured message blocks.

pub fn chat_delete(&self, msg_hash: &str) -> Result<bool>

Delete a specific chat message by its content hash.

pub fn chat_rename(&self, msg_hash: &str, new_body: &str) -> Result<bool>

Rename a specific chat message by its content hash.

pub fn chat_move_to(&self, msg_hash: &str, target_path: &str) -> Result<bool>

Move a chat message to a target file as a checklist item.

pub fn journal_add_record(&self, record: &str) -> Result<()>

Add a timestamped record to today’s journal entry.

pub fn journal_add_emoji(&self, emoji: &str) -> Result<()>

Add an emoji to today’s journal header.

pub fn journal_today_path(&self) -> String

Get today’s journal file path (e.g., “journal/2026.05 May.md”).

pub fn habits(&self, year: i32) -> Result<Habits>

Read habit tracking data for a given year.

pub fn habits_last_week(&self) -> Result<Habits>

Get last week’s habit data.

pub fn habits_write(&self, year: i32, habits: &Habits) -> Result<()>

Write habit data for a year.

pub fn config(&self) -> Result<KnowledgeConfig>

Read the knowledge base config (config.json).

pub fn set_config(&self, config: &KnowledgeConfig) -> Result<()>

Write the knowledge base config.

pub fn checklist_items( &self, path: &str, ) -> Result<(Vec<String>, HashMap<String, bool>)>

Parse checklist items from a file.

pub fn checklist_incomplete(&self, path: &str) -> Result<Vec<String>>

Get incomplete checklist items from a file.

pub fn checklist_add(&self, path: &str, item: &str, checked: bool) -> Result<()>

Add a checklist item to a file.

pub fn checklist_complete(&self, path: &str, item_hash: &str) -> Result<bool>

Complete a checklist item by hash.

pub fn checklist_remove(&self, path: &str, item_or_hash: &str) -> Result<bool>

Remove a checklist item by text or hash.

pub fn checklist_remove_completed(&self, path: &str) -> Result<(String, String)>

Remove all completed checklist items.

pub fn run_nightly_cleanup(&self) -> Result<NightlyReport>

Run nightly cleanup.

pub fn run_scheduled_tasks(&self) -> Result<Vec<String>>

Move due scheduled tasks to Chat.

pub fn today_report(&self) -> Result<TodayReport>

Get today’s completion report.

pub fn done_today(&self) -> Result<Vec<FileEntry>>

Get list of files completed today.

pub fn markdown_to_html(&self, md: &str) -> String

Convert markdown to HTML.

pub fn auto_emoji(&self, text: &str) -> String

Find an emoji for a keyword.

pub fn world_clock(&self, timezone_names: &[&str]) -> Vec<TimezoneEntry>

Generate world clock report for given timezone names.

pub fn mark_agent_write(&self, path: &str)

Mark a file as having been written by an agent.

pub fn is_agent_write(&self, path: &str) -> bool

Check if a file was written by an agent.

pub fn clear_agent_write(&self, path: &str)

Clear the agent-write marker for a file.

pub fn extract_text_imgs_links(&self, text: &str) -> ExtractResult

Extract text, images, and links from markdown content.

pub fn extract_headings(&self, content: &str) -> Vec<String>

Extract headings from content for tag generation.

Trait Implementations

impl Debug for KnowledgeBase

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.