# Junhyeonglee92 Oh My Obsidian Omo Project Add > omo-project-add — link project ↔ vault - Skill: `tomevault-io/junhyeonglee92-oh-my-obsidian-omo-project-add` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/junhyeonglee92-oh-my-obsidian-omo-project-add` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/junhyeonglee92-oh-my-obsidian-omo-project-add/raw - Safety review: pending (external: skill-scanner PASS, skillspector PASS) - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Coding & Dev Tools - Author: tomevault-io (https://skillmd.com/u/tomevault-io) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/tomevault-io/junhyeonglee92-oh-my-obsidian-omo-project-add --- # omo-project-add — link project ↔ vault Register the current git project with the oh-my-obsidian vault. Writes a single `project-name: ` line into the project's instruction file so the `wiki-staleness-check` hook works, and scaffolds the project page under the vault. **Non-destructive**: when `projects//` already exists, the skill treats it as a **Link-to-existing** situation (safe to re-run after `git clone` on another machine). **Why this key is literal**: `hooks/wiki-staleness-check.sh` detects the project by grepping for the literal string `project-name:`. Do **not** customize this key on individual machines — it is a cross-machine contract shared by the hook and the skill, so every clone of the same project must use the identical line. ## Harness compatibility When running in Codex and `AskUserQuestion` is unavailable, use the harness' normal user-input flow if available. If no choice UI exists, ask one concise plain-text question only when the decision is required; otherwise make the conservative default choice documented in this skill. ## When to activate - `/omo-project-add` or `/omo-project-add ` - "link this project to the vault", "register the project in the wiki" - "이 프로젝트 위키에 연동해줘", "omo 프로젝트 등록", "프로젝트 위키 시작" - Right after `git clone` when you want to re-attach the project to an existing vault page ## Preflight ### 1. Vault readiness check ```bash CONFIG=~/.config/oh-my-obsidian/config.json [ -f "$CONFIG" ] || { echo "Vault not initialized. Run /omo-init first." exit 1 } VAULT=$(node -e "process.stdout.write(require('$CONFIG').vaultPath)") [ -d "$VAULT/projects" ] || mkdir -p "$VAULT/projects" ``` ### 2. Must be inside a git repo ```bash REPO_ROOT=$(git -C "$PWD" rev-parse --show-toplevel 2>/dev/null) [ -z "$REPO_ROOT" ] && { echo "Current directory is not a git repo. Run this from the project root." exit 1 } ``` ### 3. Refuse to register the vault itself ```bash case "$REPO_ROOT" in "$VAULT"|"$VAULT"/*) echo "Refusing: the vault itself cannot be registered as a project." exit 0 ;; esac ``` ### 4. Auto-detection ```bash DETECTED_NAME=$(basename "$REPO_ROOT") REPO_URL=$(git -C "$REPO_ROOT" config --get remote.origin.url 2>/dev/null || echo "") ``` ## Procedure ### Step 1: Confirm the project name (AskUserQuestion) **Question 1 — project name**: - header: `Project` - question: "Confirm the project name. (Used as the slug under `projects/` in the vault.)" - multiSelect: false - options: - label: `Use '' (Recommended)` / description: "repo folder name as-is — kebab-case" - label: `Other` (tool-provided) / description: enter a custom name Pick = `PROJECT_NAME`. kebab-case is recommended (warn but allow when the user enters spaces / uppercase). ### Step 2: Check for an existing wiki folder ```bash WIKI_PROJECT_DIR="$VAULT/projects/$PROJECT_NAME" ``` If the folder already exists, ask via **AskUserQuestion**: **Question 2 — existing wiki**: - header: `Existing wiki` - question: "`projects/$PROJECT_NAME/` already exists. Link to it?" - options: - label: `Link to existing (Recommended)` / description: "Leave the wiki folder alone and just register in the project instruction file (already-created on another machine)" - label: `Cancel` / description: "Restart with a different name" On Cancel → return to Step 1 for a new name, or exit. ### Step 3: Update the project instruction file Use the harness-native instruction file: - Claude Code: `CLAUDE.md` - Codex: `AGENTS.md` If both files already exist, update the one that already contains `## oh-my-obsidian` or `project-name:`. If neither contains an OMO section, use the harness-native file. This avoids writing Codex project state into `CLAUDE.md` or Claude Code project state into `AGENTS.md`. ```bash if [ -n "${CODEX_HOME:-}" ] || [ -n "${CODEX_SANDBOX:-}" ]; then DEFAULT_INSTRUCTIONS="$REPO_ROOT/AGENTS.md" else DEFAULT_INSTRUCTIONS="$REPO_ROOT/CLAUDE.md" fi INSTRUCTIONS_FILE="$DEFAULT_INSTRUCTIONS" for candidate in "$REPO_ROOT/CLAUDE.md" "$REPO_ROOT/AGENTS.md"; do if [ -f "$candidate" ] && grep -qE '(^## oh-my-obsidian$|project-name[[:space:]]*:)' "$candidate"; then INSTRUCTIONS_FILE="$candidate" break fi done ``` | Detected | Action | |-------------------------------------------|-------------------------------------------------------------------------------------| | File missing | Create from the "instruction section template" below | | No `## oh-my-obsidian` section | Append the section to the end of the file | | Section present but `project-name:` missing | Add the line inside the existing section | | `project-name: ` already present | Confirm via Q3 below | **Question 3 — existing project name** (only when the existing value differs from `PROJECT_NAME`): - header: `Replace name` - question: "`` already has 'project-name: '. How should we handle it?" - options: - label: `Replace with '$PROJECT_NAME'` / description: "Overwrite the existing value with the new name" - label: `Skip` / description: "Leave the instruction file as-is and go to Step 4" If the existing value matches, skip Q3 (no-op). **Question 4 — legacy key** (only when a `위키 경로:` line is detected): - header: `Legacy key` - question: "`` has a '위키 경로: ...' line (legacy format). Remove it?" - options: - label: `Remove` / description: "Clean up the pre-plugin remnant (recommended)" - label: `Keep` / description: "Leave it (does not affect the staleness hook)" ### Instruction section template ```markdown ## oh-my-obsidian - project-name: ``` The `wiki-staleness-check` hook reads the `project-name:` line from `CLAUDE.md` or `AGENTS.md` and resolves `/projects//index.md` as the staleness target. Never use an absolute path. ### Step 4: Scaffold the vault project page When not `Link to existing` (or the folder never existed): ```bash mkdir -p "$WIKI_PROJECT_DIR/worklog" "$WIKI_PROJECT_DIR/decisions" touch "$WIKI_PROJECT_DIR/worklog/.gitkeep" touch "$WIKI_PROJECT_DIR/decisions/.gitkeep" ``` If `index.md` is missing, create it following the **`_ops/templates/wiki-project.md`** structure (substitute Templater tokens: `{{date:YYYY-MM-DD}}` → today, `{{title}}` → `PROJECT_NAME`): ```markdown --- type: project created: updated: status: active project-status: planning repo-url: "" tech-stack: [] tags: [] aliases: [] --- # ## Current state - **Progress**: - **Open items**: - **Next**: ## Architecture (Core structure summary. Move detailed content into separate concept / guide pages.) ## Related links - **Entities**: - **Concepts**: - **Decisions**: ``` `` is resolved in Step 5. ### Step 5: Decide the one-line description (AskUserQuestion) Attempt auto-extraction from the project README: ```bash AUTO_DESC=$(awk '/^[^#-]/ && NF { print; exit }' "$REPO_ROOT/README.md" 2>/dev/null | head -c 120) ``` (First meaningful line, skipping blanks / comments / lists.) **Question 5 — description**: - header: `Description` - question: "One-line description for the wiki index. (auto: '$AUTO_DESC')" - options: - label: `Use auto` / description: "the README first line as-is" - label: `Other` (free input) / description: user types a new description If `AUTO_DESC` is empty or meaningless, hide the `Use auto` option and leave only `Other`. Selection = `DESCRIPTION`. ### Step 6: Register in wiki/index.md For `Link to existing` the entry may already be there — check first: ```bash grep -q "\[\[$PROJECT_NAME/index" "$VAULT/wiki/index.md" 2>/dev/null && { echo "Already registered in index, skipping." } || { # Append one line under the Projects section # Format: - [[/index|]] — } ``` Edit target: under `## Projects`, append one line to the end of the list. Also bump the `updated: YYYY-MM-DD` frontmatter to today. ### Step 7: Append to wiki/log.md ``` | YYYY-MM-DD | create | [[/index|]] | project wiki registered: (mode=) | ``` ### Step 8: Offer to analyze now (AskUserQuestion) For hand-off or fresh onboarding, generating the understanding docs immediately means later sessions can rely on them. **Question 6 — analyze now**: - header: `Analyze now` - question: "Run repo analysis now and generate `docs/architecture.md` + `docs/usage.md`? (You can always re-run via `/omo-project-analyze` later.)" - multiSelect: false - options: - label: `Yes (Recommended)` / description: "read the repo and produce the two understanding docs — chain into /omo-project-analyze" - label: `Skip` / description: "call /omo-project-analyze manually later" On `Yes`: continue by **executing the `/omo-project-analyze` Procedure** in the current session, passing `PROJECT_NAME` so it does not have to re-resolve. ### Step 9: Report Short report (in the user's working language): ``` Project linked. Project: Repo: Mode: fresh (new folder) | link-existing (linked to existing folder) Modified / created files: - / (section / line added) - /projects//index.md (scaffolded) - /projects//{worklog,decisions}/ - /wiki/index.md (Projects registered) - /wiki/log.md (create log) Effect: - On every git commit in this project, the wiki-staleness-check hook will compare index.md's `updated` with recent feat/fix/refactor commits and warn if the vault is out of date. Next steps: - /omo-project-analyze to write the understanding docs (if Step 8 was Skip) - /omo-ingest to add related material - projects//worklog/YYYY-MM-DD.md for daily work - projects//decisions/dec-NNN-*.md for ADRs ``` ## Input guards | Problem | Response | |------------------------------------------|--------------------------------------------------------------------------------------| | Vault not initialized | Point to `/omo-init` and exit | | Not a git repo | Explain and exit (no manual-path override) | | Invoked inside the vault | Warn and exit | | Project name looks like an absolute path | Reject; ask for a slug | | Project name has spaces / uppercase | Warn (kebab-case recommended) but allow if the user insists | ## References - `/schema/wiki-rules.md` — project-management procedure - `/schema/page-types.md` — Project page required / optional sections - `/templates/_ops/templates/wiki-project.md` — page structure blueprint - `/hooks/wiki-staleness-check.sh` — reads the `project-name:` line registered by this skill ## Anti-patterns - Putting an **absolute path** into the project instruction file (do not recreate the old `위키 경로:` form). - Overwriting existing `projects//` contents (destructive — violates the skill's design). - **Adding** a legacy `위키 경로:` key (only detect/remove — never write new). - Registering the vault itself as a project. - Replacing an existing `project-name: ` without user consent. --- > Source: [JunHyeongLee92/oh-my-obsidian](https://github.com/JunHyeongLee92/oh-my-obsidian) — distributed by [TomeVault](https://tomevault.io).