Instruction Manual · Apple silicon · macOS Tahoe

kepano/obsidian-skills Instruction Manual

Agent Skills for Obsidian workflows and open formats, including Obsidian Markdown, Bases, JSON Canvas, the Obsidian CLI, and Defuddle web-page cleanup.

Beginner-friendlyCopy-paste examplesFirst-party sources checked

What kepano/obsidian-skills is—in plain language

Agent Skills for Obsidian workflows and open formats, including Obsidian Markdown, Bases, JSON Canvas, the Obsidian CLI, and Defuddle web-page cleanup.

Mental model: This repository extends a host application. The host loads its commands, skills, hooks, or agents; most day-to-day use happens inside that host rather than by launching a separate app.
InterfacesAgent Skills, Claude plugin
Primary languageMarkdown
Typical useAsk the host agent to create or edit an Obsidian artifact, or explicitly request Defuddle for clean page Markdown

Your first 15 minutes

  1. Complete the linked Installation Guide and its verification step.
  2. Create a disposable test folder or use non-sensitive sample data.
  3. Run the small example below and observe what files, ports, or prompts appear.
  4. Read the result before approving writes, network calls, account access, or costs.
  5. Only then repeat the workflow with a real project.
Starter workflow
# In your agent, ask:
Create a test note using Obsidian-flavored Markdown with one wikilink and one callout.

Complete indexed functionality map

Each card below corresponds to a component identified in the repository research. Open a component record for its path, purpose, capabilities, dependencies, risks, and relationships.

obsidian-markdown

skill

Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian syntax.

skills/obsidian-markdown/SKILL.md
Open component record →

obsidian-bases

skill

Create and edit Obsidian Bases files with views, filters, formulas, properties, and summaries.

skills/obsidian-bases/SKILL.md
Open component record →

json-canvas

skill

Create and edit JSON Canvas files containing nodes, edges, groups, and spatial relationships.

skills/json-canvas/SKILL.md
Open component record →

obsidian-cli

skill

Operate an Obsidian vault through the Obsidian CLI, including supported plugin and theme-development tasks.

skills/obsidian-cli/SKILL.md
Open component record →

defuddle

skill

Extract clean, readable Markdown from a web page with Defuddle while removing navigation and other clutter that wastes context.

skills/defuddle/SKILL.md
Open component record →

Upstream feature-by-feature guide

These capabilities are derived from the current first-party README and supporting documentation. Names follow upstream terminology so you can search the source documentation precisely.

Upstream capability

npx skills

Upstream treats this as a distinct part of kepano/obsidian-skills. In plain language, use this area when your task concerns npx skills. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Manually

Upstream treats this as a distinct part of kepano/obsidian-skills. In plain language, use this area when your task concerns manually. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Skills

Upstream treats this as a distinct part of kepano/obsidian-skills. In plain language, use this area when your task concerns skills. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

How to use the main workflows

1

Choose the smallest relevant function

Start with one capability card instead of asking the repository to do everything at once. This makes permissions, inputs, and output easier to understand.

2

Prepare a disposable input

Use a sample URL, copied repository, test document, or sandbox account. Keep production credentials and irreplaceable files out of the first run.

3

Run, observe, and stop

Watch Terminal output or the host application's activity view. If the behavior differs from the README, stop with Control + C or cancel inside the host before retrying.

4

Inspect the result

Check generated files, diffs, API responses, logs, or previews. Never assume “command finished” means the result is correct.

5

Save a repeatable recipe

Record the working command and non-secret configuration in your project's README. Store secrets in the documented environment file or password manager.

Copy-paste recipes from upstream documentation

These examples are selected from the repository's first-party documentation. Replace obvious placeholders, keep quotation marks intact, and run them only in the context indicated by the surrounding explanation.

Open the live upstream manual
open "https://github.com/kepano/obsidian-skills#readme"

Configuration, accounts, and files

Configuration files

Agent host skill configuration

A configuration file changes behavior without changing source code. Make one change at a time and keep a backup before editing JSON, TOML, YAML, or environment files.

Important directories

skills/

Paths identify where the relevant implementation or generated files live. Paths beginning with ~ are inside your home folder.

Credentials

None for the skills; target sites may require their own access

Prefer temporary, least-privileged credentials. Never commit .env, tokens, cookies, private keys, or session exports.

External services

Optional web pages fetched by Defuddle

Check pricing, data retention, rate limits, and account permissions before enabling optional integrations.

Safe operating habits

  • Use test data first and keep a current backup or Git commit.
  • Read commands before pasting. A README is useful evidence, not a substitute for judgment.
  • Review agent-generated file changes with git diff before committing.
  • Keep local services bound to 127.0.0.1 unless you intentionally secure and expose them.
  • Do not give plugins or MCP servers broader filesystem, browser, GitHub, or cloud access than their current task requires.
  • Confirm API costs and model names before running large batches.
  • Stop and investigate repeated authentication failures instead of pasting a token into multiple places.

Reference and source trail

The manual reflects first-party files checked on August 18, 2026. It explains the indexed repository rather than promising that every optional third-party integration is available or safe.