README file from
GithubCodex Vault Agent
Codex Vault Agent is an Obsidian desktop plugin for collecting reviewed evidence from a chosen vault scope, then asking a local Codex CLI session to synthesize only the selected evidence into a report, dashboard, link audit, or metadata audit.
What It Does
- Builds a local evidence set from a selected folder, backlinks, outlinks, and optional broader scopes.
- Uses Dataview when available for structured metadata access.
- Lets you include or exclude candidate notes before any synthesis happens.
- Starts Codex through the installed local Codex CLI using the user's existing Codex login.
- Sends Codex only the reviewed evidence packet, not the whole vault.
- Creates the final note only after explicit user approval.
Requirements
- Obsidian desktop.
- Codex CLI installed and logged in for synthesis.
- Dataview is recommended. The plugin still uses Obsidian metadata when Dataview is not installed.
Settings
- Default folder: starting folder for new query runs. Leave blank to search the entire vault.
- Output folder: where compiled report notes are created.
- Default max evidence rows: starting candidate limit for collection runs.
- Default metadata fields: frontmatter fields checked for metadata gaps.
- Default subfolders: starting subfolder behavior for new runs.
- Enable Codex synthesis: optional local Codex CLI synthesis layer.
- Codex executable: command or path used to start
codex app-server.
Privacy Model
Collection runs locally in Obsidian. Codex synthesis is optional and only receives the selected evidence rows, query plan, scope summary, and report type. The plugin does not silently choose vault scope and does not silently edit existing notes.
Disclosures
- Account requirement: Codex synthesis requires a locally installed Codex CLI that is already logged in. Collection, review, and deterministic report compilation work without Codex.
- Network use: When Codex synthesis is run, the local Codex CLI may contact the Codex service using the user's existing login. The plugin sends only the reviewed evidence packet, query plan, scope summary, and selected report type to that Codex session.
- Local process: On desktop, the plugin starts
codex app-serverfrom the configured executable path. This is only done when the user clicks Connect Codex. - No telemetry or ads: The plugin does not include client-side telemetry, analytics, advertising, or self-update code.
- No silent edits: The plugin creates a report note only after explicit user approval and does not silently modify existing notes.
Getting Started
- Install or build the plugin.
- Open Vault Agent from the ribbon or command palette.
- Choose a folder scope.
- Write an Ask and apply it to the query plan if needed.
- Run collection.
- Review and select evidence.
- Connect Codex and run synthesis.
- Preview or create the compiled note.
Release Files
Each release should include:
main.jsstyles.cssmanifest.json
The repository should also include versions.json, README.md, and LICENSE.
Community Release Notes
This plugin is desktop-only because it starts a local Codex CLI process through Node. The Codex connection is optional: collection, review, and deterministic report compilation still work without it.
Do not publish data.json; it stores local user settings and workflow state.