Skip to content

README.md

Latest commit

 

History

History
90 lines (63 loc) · 3.21 KB

README.md

File metadata and controls

90 lines (63 loc) · 3.21 KB
Raw

Codex Obsidian icon

Codex Obsidian
A Grade A local-first Codex plugin for Obsidian writing, open formats, and official desktop CLI workflows.

Codex Obsidian bundles Obsidian-focused writing, Markdown, Bases, Canvas, web import, and official desktop CLI skills behind one install surface. Current Plugin Eval result: 100/100, Grade A, low risk.

Highlights

  • Plugin Eval 100/100
  • One install for Obsidian docs, open formats, web import, and CLI workflows
  • Explicit-only skill loading keeps trigger and invoke budgets small
  • Local-first: no hosted service, account system, analytics, or telemetry

What It Adds

  • codex-obsidian-writer for technical docs, ADRs, runbooks, API notes, Mermaid, Canvas, and Bases
  • codex-obsidian-markdown, codex-obsidian-bases, codex-obsidian-canvas, and codex-obsidian-web-import
  • codex-obsidian-cli plus focused CLI skills for bookmarks, admin, devtools, sync/publish, workspace, and workflows
  • One install surface instead of separate plugin and skills setup

Evaluation

Current local Plugin Eval result:

Score: 100/100
Grade: A
Risk: low
Checks: 0 fail, 0 warn, 0 info

Re-run it locally:

node /Users/parmcoder/.codex/plugins/cache/openai-curated-remote/plugin-eval/0.1.2/scripts/plugin-eval.js analyze plugins/codex-obsidian --format markdown

Install

From a local clone:

codex plugin marketplace add .
codex plugin add codex-obsidian@codex-obsidian

From GitHub:

codex plugin marketplace add parmcoder/codex-obsidian
codex plugin add codex-obsidian@codex-obsidian

This bundled plugin already includes the vendored Obsidian skill content adapted from greg-asher/codex-obsidian and kepano/obsidian-skills, so no second install is required for the bundled experience.

Skill Matrix

  • Writing and doc structure: codex-obsidian-writer
  • Vault markdown and open formats: codex-obsidian-markdown, codex-obsidian-bases, codex-obsidian-canvas
  • Web cleanup and import: codex-obsidian-web-import
  • Official desktop CLI note workflows: codex-obsidian-cli
  • Focused CLI surfaces: codex-obsidian-cli-bookmarks, codex-obsidian-cli-admin, codex-obsidian-cli-devtools, codex-obsidian-cli-sync-publish, codex-obsidian-cli-workspace, codex-obsidian-cli-workflows

Example Prompts

  • Use codex-obsidian-writer to turn this architecture sketch into an ADR.
  • Use codex-obsidian-markdown to clean up this note's frontmatter and wikilinks.
  • Use codex-obsidian-cli to read Projects/Plan.md from my vault.

Repository Layout

.agents/plugins/marketplace.json
plugins/codex-obsidian/.codex-plugin/plugin.json
plugins/codex-obsidian/skills/

Attribution

This repo vendors and adapts upstream skill content from:

See THIRD_PARTY.md for bundled components and license notes.