oh-my-obsidian

◯ ─────────── ◯



O H - M Y - O B S I D I A N

◯ ─────────── ◯

Stop forgetting. Start remembering.
_{Give your AI coding agents a permanent, evolving second brain.}

English | 한국어

Quick Start · Why · How It Works · Commands · The Agents

Oh-my-obsidian gives Claude Code and Codex persistent, Obsidian-backed project memory.

AI coding agents are capable but lose context between sessions. Oh-my-obsidian stores project decisions and session notes as Markdown in an Obsidian vault, then helps Claude Code and Codex retrieve the relevant context later. Guided setup, vault maintenance, and approval-based Git sync keep that memory usable without hiding where it lives.

Why Oh-My-Obsidian?

Most AI coding agents start every session with a blank slate.

Quick Start

Claude Code Quick Start

# 1. Add our custom marketplace
/plugin marketplace add https://github.com/hongdangmoo49/oh-my-obsidian

# 2. Install the plugin
/plugin install oh-my-obsidian@omob

Install via Official Marketplace — (Pending Approval) If installed from the official Claude registry:

/plugin install oh-my-obsidian

(For local development: claude --plugin-dir /path/to/oh-my-obsidian)

Initialize — Run the interactive Socratic setup wizard:

> /oh-my-obsidian:setup

Codex Quick Start

Codex reads the repository marketplace from:

.agents/plugins/marketplace.json

Add the marketplace from GitHub:

codex plugin marketplace add hongdangmoo49/oh-my-obsidian

Then open Codex and install oh-my-obsidian from the plugin directory:

/plugins

Then ask Codex:

Set up an Obsidian vault for this project.

After setup, you can continue with Codex using natural-language prompts or an
explicit skill name such as:

What did we decide last time about the vault layout?
Save this session to the Obsidian vault.
Show me the vault health check.
Add a note to the vault for today's API decisions.
$oh-my-obsidian-recall Find our prior vault-layout decision.

The plugin will:

1. Check for the Obsidian desktop app on your system.
2. Conduct a Socratic interview to understand your project (domain, tech stack, team size).
3. Generate a tailored folder structure via the vault-architect agent.
4. Offer an optional Obsidian Git choice (safe, manual, or team-sync) after separate approvals.
5. For Codex, offer approval-gated official hooks and optional session history restore after validation.

Codex Plugin

Codex support is shipped from a separate plugin root:

plugins/oh-my-obsidian/

Use the Codex-native marketplace file:

.agents/plugins/marketplace.json

When users add hongdangmoo49/oh-my-obsidian as a Codex marketplace source,
Codex reads this marketplace and exposes the bundled oh-my-obsidian plugin.
Do not reuse .claude-plugin/marketplace.json for Codex.

Typical Codex start flow:

1. run codex plugin marketplace add hongdangmoo49/oh-my-obsidian
2. run codex, then open /plugins and install oh-my-obsidian
3. ask Codex: Set up an Obsidian vault for this project.

The Codex plugin keeps the same product shape: guided setup, recall,
session-save, vault management, and official Codex hooks for project-local
memory context. In Codex, these flows are typically used through natural-language
prompts or explicit skill invocation rather than Claude-style slash commands.

Feature Matrix

How It Works

Oh-my-obsidian acts as a bridge between the AI (Claude Code), the Knowledge Base (Obsidian), and the Team (Git).

In Codex, the same loop is driven through skill-guided prompts rather than the
Claude command surface shown below.

    [ Claude Code ] <---> [ oh-my-obsidian ] <---> [ Obsidian Vault ]
           |                                             |
           +----------------( Git Sync )-----------------+

Commands

Use these commands directly inside your Claude Code session.

In Codex, use the equivalent natural-language prompts or explicitly invoke the
installed skill surface, such as $oh-my-obsidian-setup,
$oh-my-obsidian-recall, $oh-my-obsidian-session-save, and
$oh-my-obsidian-vault-manager.

The Agents

Oh-my-obsidian uses specialized sub-agents to handle complex reasoning tasks. They do the heavy lifting so you don't have to.

Team Onboarding

Once a vault is initialized with Git sync, onboarding a new team member takes seconds.
The setup command automatically generates cross-platform installation scripts in the vault.

# Team member clones the repo, then runs:
cd scripts/team-setup
./install.sh     # Mac/Linux
.\install.ps1    # Windows

🔧 Prerequisites

Items that users must manually prepare to run the plugin normally:

• Node.js 18 or higher must be installed on your system.
• Git should be installed for repository-local Codex hooks and optional vault sync.
• You need a project-specific Obsidian vault path. Setup can create a new vault
  or attach a compatible existing vault; Git initialization and Obsidian Git sync
  are optional approval-gated steps.

⚙️ Under the Hood

During setup, the plugin can help with the following tasks, but each sensitive
step is permission-gated and may be skipped. Package-manager installs, shell
profile edits, config-pointer creation, third-party downloads, community plugin
enablement, and auto-sync choices all require separate approval.

1. Obsidian Desktop App Detection and Install Guidance: The setup checks whether Obsidian is available in the current environment. Automatic install is only offered when the platform/context supports it and only after explicit approval. Container and WSL flows have stricter limits.
2. Obsidian Git Plugin Choices: After the vault exists, setup can offer safe, manual, or team-sync Obsidian Git options. Download, enablement, and sync behavior are separate approvals, not defaults.
3. Local Script Generation and Environment Setup Guidance: Setup generates onboarding scripts and can help users set OBSIDIAN_VAULT, but shell profile edits or Codex config-pointer creation are opt-in and approval-gated.

For Codex follow-up skills, vault resolution checks explicit OBSIDIAN_VAULT
first, then approved Codex hook pointers (<repo>/.codex/oh-my-obsidian.local.json
and ~/.codex/oh-my-obsidian.local.json), then the optional approved config
pointer at ~/.oh-my-obsidian/config.json.

For the beginner Codex path, the recommended repo-local hooks setup creates the
project-local pointer and protects it with <repo>/.codex/.gitignore, so
machine-specific vault paths are not committed and users do not need to configure
environment variables first.

Permission Boundaries

Both Claude Code and Codex flows require explicit approval before:

• package-manager installs
• shell profile mutation
• third-party Obsidian Git downloads
• community plugin enablement
• auto-sync or team-sync behavior
• git remote changes or push operations
• overwrites, moves, deletes, or reconcile actions

Codex-only approval boundary:

• creation of Codex config pointers
• official Codex hooks installation or .codex/* edits

Plugin Structure

oh-my-obsidian/
├── .claude-plugin/plugin.json   # Claude plugin manifest
├── commands/                    # Claude command surface
├── skills/                      # Claude/root skills
├── agents/                      # Claude sub-agents
├── hooks/                       # Claude session hooks
├── scripts/                     # Shared/root installation scripts
├── .mcp.json                    # MCP server config (optional)
├── .agents/plugins/marketplace.json
└── plugins/oh-my-obsidian/      # Codex plugin surface

"A second brain for your AI."

Oh-my-obsidian

MIT License