Obsidian logo

Obsidian

CommunityPopular
steipete
obsidian

Obsidian vault: search/read/write notes, backlinks, Bases, Canvas.

Overview

Publishersteipete
Repositoryagent-scripts
Skill nameobsidian
Stars
6.6K
Forks
547
Bundled files
Instructions only
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by steipete on GitHub. Read the source before you install it.

Installation

Install the Obsidian AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/steipete/agent-scripts.git /tmp/agent-scripts
mkdir -p .claude/skills
cp -r /tmp/agent-scripts/skills/obsidian .claude/skills/obsidian
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Obsidian in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Obsidian on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Obsidian is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Obsidian

Use this for local Obsidian vault work. An Obsidian vault is a normal folder of Markdown files plus .obsidian/ config.

Sources

  • App config: ~/Library/Application Support/obsidian/obsidian.json
  • Default vault name: obsidian
  • Usual local vault path: ~/obsidian
  • Official CLI: obsidian
  • Vault commands resolve the vault from cwd; run them from ~/obsidian.

First Checks

bash
command -v obsidian
obsidian version
obsidian vaults
cd ~/obsidian
obsidian commands filter=search:

Global commands like version and vaults work outside a vault. Vault-content commands may print Vault not found. outside ~/obsidian. Use obsidian commands, not obsidian help, for CLI discovery.

If obsidian says CLI is disabled:

  1. Prefer asking the user to enable Settings -> General -> Advanced -> Command line interface.
  2. If you already confirmed the app config shape, ~/Library/Application Support/obsidian/obsidian.json uses "cli": true.
  3. Restart Obsidian after changing app-level CLI config.

Read Workflow

Prefer official CLI for Obsidian-aware lookups:

bash
cd ~/obsidian
obsidian search query="OpenClaw" format=json
obsidian search:context query="OpenClaw" limit=20 format=json
obsidian read path="Folder/Note.md"
obsidian file path="Folder/Note.md"
obsidian outline path="Folder/Note.md" format=json
obsidian backlinks path="Folder/Note.md" format=json
obsidian links path="Folder/Note.md"
obsidian properties path="Folder/Note.md" format=json

Use direct filesystem reads when you already know the path and need exact bytes:

bash
sed -n '1,220p' "$HOME/obsidian/Folder/Note.md"
rg -n "term" "$HOME/obsidian"

Report which source you used when freshness or vault choice matters.

Write Workflow

Choose the narrowest write path:

  • New note: obsidian create path="Folder/Note.md" content="...".
  • Append/prepend daily notes: obsidian daily:append content="...".
  • Simple note edits: use apply_patch on the Markdown file.
  • Rename/move notes: prefer obsidian move path="Old.md" to="Folder/New.md" so links can update.
  • Opening UI after a write: add open only when useful or requested.

Common commands:

bash
cd ~/obsidian
obsidian create path="Notes/New.md" content="# New\n\nBody"
obsidian append path="Notes/New.md" content="More text"
obsidian move path="Notes/New.md" to="Archive/New.md"
obsidian daily:path
obsidian daily:read
obsidian daily:append content="- Follow-up item"

For multi-line content, prefer editing the .md file with apply_patch once the path is known. Avoid fragile shell quoting for long prose.

Bases, Canvas, Plugins

Use CLI discovery first:

bash
cd ~/obsidian
obsidian bases
obsidian base:views path="Projects.base"
obsidian base:query path="Projects.base" view="Active" format=json
obsidian plugins format=json
obsidian plugins:enabled format=json
obsidian commands filter=workspace:

For .canvas, .base, and .json files, read/edit as structured data when possible. Keep formatting stable and validate JSON after edits.

Safety

  • Do not bulk rewrite the vault. Use targeted paths and review diffs.
  • Do not edit .obsidian/ unless the user asks or the task is explicitly settings/plugin work.
  • Do not delete notes unless explicitly asked; prefer trash over permanent delete.
  • Do not create hidden dot-folder notes through the Obsidian URI/CLI path.
  • Preserve frontmatter and wikilinks unless the task is to refactor them.
  • If multiple vaults exist, do not guess; use obsidian vaults and obsidian.json.

Frequently asked questions

What does the Obsidian AI skill do?

Obsidian vault: search/read/write notes, backlinks, Bases, Canvas.

Why use Obsidian on TypingMind?

Because you install it once and use it with any model. Obsidian is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Obsidian in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/steipete/agent-scripts/tree/main/skills/obsidian. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Obsidian?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Obsidian?

As many as you like. As long as a model supports skills, you can use Obsidian with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Obsidian AI skill free?

Yes. It is published on GitHub by steipete under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇