4.7 KiB
Obsidian Integration Model
Purpose
Use Obsidian as a visual navigation and manual review layer over canonical project knowledge.
Obsidian should not become a second memory store.
Recommended Vault
Open the workspaces/<profile>/project-knowledge/ folder as the Obsidian vault:
<workspace-root>/workspaces/<profile>/project-knowledge/
This keeps one source of truth:
- OpenCode and agents maintain project knowledge in Markdown
- Obsidian reads and edits the same Markdown files
- Git tracks intentional memory and configuration changes
- runtime evidence and generated artifacts stay outside the vault
- agent operating rules live outside the vault in
agent-memory/
Source Of Truth
Canonical project knowledge lives in:
workspaces/<profile>/project-knowledge/00-start/workspaces/<profile>/project-knowledge/01-current/workspaces/<profile>/project-knowledge/02-work-items/workspaces/<profile>/project-knowledge/03-context/workspaces/<profile>/project-knowledge/04-people/workspaces/<profile>/project-knowledge/05-decisions/workspaces/<profile>/project-knowledge/06-daily/workspaces/<profile>/project-knowledge/07-maps/
Technical runtime remains outside the vault:
agent-memory/.opencode/scripts/core/profiles/workspaces/<profile>/inbox/scripts/*/generated/- archives and local virtual environments
Communication evidence may exist under workspaces/<profile>/inbox/ or connector generated/ folders, but promoted memory belongs in the profile's project knowledge vault.
What To Version
Version portable Obsidian configuration only when it improves the workspace for every clone:
workspaces/<profile>/project-knowledge/.obsidian/app.jsonworkspaces/<profile>/project-knowledge/.obsidian/core-plugins.jsonworkspaces/<profile>/project-knowledge/.obsidian/graph.jsonworkspaces/<profile>/project-knowledge/.obsidian/appearance.jsonworkspaces/<profile>/project-knowledge/.obsidian/daily-notes.jsonworkspaces/<profile>/project-knowledge/.obsidian/templates.jsonworkspaces/<profile>/project-knowledge/.obsidian/bookmarks.json
Do not version local runtime state:
workspaces/<profile>/project-knowledge/.obsidian/workspace*.jsonworkspaces/<profile>/project-knowledge/.obsidian/workspace-mobile*.jsonworkspaces/<profile>/project-knowledge/.obsidian/plugins/workspaces/<profile>/project-knowledge/.obsidian/snippets/workspaces/<profile>/project-knowledge/.obsidian/cache/
Recommended graph and search exclusions:
workspaces/<profile>/inbox/archives/scripts/**/generated/scripts/**/.venv/.opencode/node_modules/- Python caches and compiled files
Linking Policy
Prefer standard Markdown links for shared workspace files because they remain portable across:
- OpenCode
- VS Code
- GitHub
- Obsidian
- other Markdown tooling
Use Obsidian wiki-links only for Obsidian-only notes when there is a clear navigation benefit.
Agent Rules
The agent may update Obsidian navigation notes when they improve project discoverability.
The agent should not treat Obsidian runtime layout changes as project context.
If Obsidian metadata or properties are added, use them selectively for high-value notes such as work items, decisions, and index pages. Do not mass-convert existing files just to add metadata.
Use map notes under workspaces/<profile>/project-knowledge/07-maps/ as graph hubs. This keeps the graph navigable without forcing every file into Obsidian-specific wiki-link syntax.
Bases
Keep Bases simple and property-driven:
- work items filter on
type: work-item - people filter on
type: person - decisions filter on
type: decision - daily notes filter on
type: daily - systems filter on
type: system - workstreams filter on
type: workstream
Do not use Bases for raw inboxes, generated evidence, scripts, or runtime logs.
CLI Wrappers
Use scripts/memory/ as the project-agnostic memory interface.
Use scripts/obsidian/ only as the current Obsidian adapter:
cli.shruns the official Obsidian CLI from the configured vault directory.uri.shgenerates encoded Obsidian URIs.open.sh <project-knowledge-relative-path>opens a note through Obsidian URI.daily.shopens the configured daily note through Obsidian URI.search.sh <query>opens Obsidian search through Obsidian URI.
The memory interface can use Obsidian CLI when available and fall back to direct Markdown operations when it is not.
The agent should depend on scripts/memory/memory.sh for portable operations:
create <type> <slug> [title]search <query> [folder]base-query <base-name> [format]health
This keeps Obsidian replaceable while still making the current vault easier to use.