Agent skill

Obsidian Link Checker

by ballred in ballred/obsidian-claude-pkm

Scans an Obsidian vault for broken wiki-links, verifies that each target note exists, and suggests close matches, all without modifying any file.

MITAuto-check passedKnowledge Management

Install Obsidian Link Checker

skills CLI
$ npx skills add ballred/obsidian-claude-pkm --skill check-links -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install ballred/obsidian-claude-pkm check-links --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/ballred/obsidian-claude-pkm.git skills-src && mkdir -p .claude/skills && cp -r skills-src/vault-template/.claude/skills/check-links .claude/skills/check-links && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
check-links
GitHub stars
1.9k
Token cost
~710 tokens
SKILL.md length
282 words
Files
1
Skills in repo
13
Repo updated
First seen
Licence
MIT

At a glance

Scans an Obsidian vault for broken wiki-links, verifies that each target note exists, and suggests close matches, all without modifying any file.

  • Works in 5 steps: Extract all wiki-links → Build unique target list → Verify each target exists → …
  • Auditing a vault for link rot
  • SKILL.md covers Usage, How to Execute, Edge Cases and No Broken Links, plus 1 more section
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

The skill finds wiki-links, the ones written in double square brackets, that point at notes that do not exist. It greps the markdown files for link patterns, leaves out the .claude and .obsidian folders, strips heading anchors, block references and aliases so only the note name remains, and then uses Glob to check that a matching file exists for each unique target. It only reads, so nothing in the vault changes.

Broken links are reported grouped by the file they appear in. For each one, the skill looks for a similar filename and suggests it, for example a corrected spelling of Project Alpha, or says that no matching file was found. Embedded attachments, external links and template placeholders are skipped, and empty links are reported as malformed rather than broken. A clean vault gets a short confirmation with the number of files and links checked.

When your agent uses it

  • Auditing a vault for link rot
  • After renaming or deleting notes that other notes link to
  • Before exporting or publishing a vault

Example prompts

  • “Check for broken links in my vault.”
  • “I just renamed a dozen notes. Find any wiki-links that now point nowhere.”
  • “Find dead wiki-links and suggest what they should point to.”

Requirements

  • Pre-approved tools (allowed-tools): Grep, Glob, Read

Workflow steps

5 steps, taken from the step headings in SKILL.md.

  1. Extract all wiki-links
  2. Build unique target list
  3. Verify each target exists
  4. Report results
  5. Suggest fixes

What it can do on your machine

Read from SKILL.md and the folder at commit ef1e4da. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Grep
    • Glob
    • Read

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Obsidian Link Checker loads about 710 tokens when it runs. Until then it costs about 38 tokens; SKILL.md has 282 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~38
When it runs · the whole SKILL.md, loaded when a task matches
~710

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from ballred/obsidian-claude-pkm at commit ef1e4da, republished under its MIT licence (© ballred). 282 words, ~710 tokens.

Download SKILL.mdSave it as .claude/skills/check-links/SKILL.md (or your agent's skills folder).
name
check-links
description
Find broken wiki-links in the vault. Read-only analysis — scans for [[links]] and verifies target files exist. No writes, no dependencies.
allowed-tools
Grep, Glob, Read
user-invocable
true

Finds broken [[wiki-links]] across your vault by extracting link targets and verifying that each target file exists. Read-only — never modifies files.

Usage

/check-links

Or ask:

  • "Check for broken links in my vault"
  • "Find dead wiki-links"
  • "Are there any broken links?"

How to Execute

Use Grep to find all [[...]] patterns in markdown files:

Grep:
  pattern: "\\[\\[([^\\]|]+)"
  glob: "*.md"
  output_mode: content
  -n: true

This captures the link target (before any | alias). Exclude .claude/ and .obsidian/ directories from results.

Step 2: Build unique target list

From the grep results, extract the unique link targets. For each match like [[My Note]] or [[My Note|display text]], the target is My Note.

Strip:

  • Heading anchors: [[Note#heading]] → target is Note
  • Block references: [[Note^block-id]] → target is Note
  • Aliases: [[Note|alias]] → target is Note
Step 3: Verify each target exists

For each unique target, use Glob to check if a matching file exists:

Glob:
  pattern: "**/<target>.md"

A link is broken if no file matches. A link is valid if at least one file matches.

Step 4: Report results

Group broken links by source file:

markdown
## Broken Links Report

### Daily Notes/2024-01-15.md
- [[Projet Alpha]] — no matching file found
- [[Old Goal]] — no matching file found

### Projects/Project Beta.md
- [[Meeting Notes Jan]] — no matching file found

---

**Summary:** 3 broken links across 2 files (out of 45 total links checked)
Step 5: Suggest fixes

For each broken link, try to find a close match:

  1. Use Glob with a partial pattern: **/*<partial-target>*.md
  2. If a similar filename exists, suggest it:
    - [[Projet Alpha]] — Did you mean [[Project Alpha]]?
  3. If no close match, just report "no matching file found"

Edge Cases

  • Embedded images (![[image.png]]) — skip these, they reference attachments
  • External links ([text](https://...)) — skip these, they are not wiki-links
  • Template placeholders ([[{{date}}]]) — skip anything with {{ in the target
  • Empty links ([[]]) — report as malformed, not broken

If all links are valid:

✅ All wiki-links verified — no broken links found across X files (Y links checked)

Tips

  • Run /check-links periodically to catch link rot
  • After renaming files, run this to find links that need updating
  • Combine with /search to find notes that reference deleted content

© ballred, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in vault-template/.claude/skills/check-links of ballred/obsidian-claude-pkm.

Open the folder on GitHubat commit ef1e4da

Compare with similar skills

Obsidian Link Checker next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Obsidian Link Checker compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Obsidian Link Checker this skillballred/obsidian-claude-pkm1.9k—~710Automated safety check: PassMIT
Obsidian Canvas BoardsAgriciDaniel/claude-obsidian15k—~1.4kAutomated safety check: PassMIT
Obsidian Wiki Log FoldAgriciDaniel/claude-obsidian15k—~1.2kAutomated safety check: PassMIT
Obsidian Bases EditorAgriciDaniel/claude-obsidian15k—~1.2kAutomated safety check: PassMIT
My LLM WikiMartinLwx/dotfiles140—~2.7kAutomated safety check: PassNone
Obsidian Knowledge BuilderMichael-OvO/obsidian-knowledge-agent205—~917Automated safety check: PassMIT

Similar skills

  • Obsidian Canvas Boards

    AgriciDaniel/claude-obsidian

    Creates, inspects and updates Obsidian JSON Canvas boards in a vault, with text, file, link, group and edge nodes, using safe recoverable edits.

    15k GitHub stars~1.4k tokensUpdated 29 days ago
    Knowledge ManagementAuto-check passed
  • Obsidian Wiki Log Fold

    AgriciDaniel/claude-obsidian

    Creates a bounded, extractive rollup of recent Obsidian wiki log entries, previewed by default, with one optional apply step and no changes to child pages.

    15k GitHub stars~1.2k tokensUpdated 29 days ago
    Knowledge ManagementAuto-check passed
  • Obsidian Bases Editor

    AgriciDaniel/claude-obsidian

    Explains, drafts and validates Obsidian Bases .base files, building filters, formulas and table, card or list views, and applying edits only through one inspected transaction.

    15k GitHub stars~1.2k tokensUpdated 29 days ago
    Knowledge ManagementAuto-check passed
  • My LLM Wiki

    MartinLwx/dotfiles

    Provides access to the user's personal wiki, including notes, research, project documentation, decisions, and archived knowledge.

    140 GitHub stars~2.7k tokensUpdated yesterday
    Knowledge ManagementAuto-check passed
  • Obsidian Knowledge Builder

    Michael-OvO/obsidian-knowledge-agent

    Turns PDFs, slides, syllabi, papers and transcripts into structured, teaching-quality Obsidian notes, matching how much structure is built to how much the material needs.

    205 GitHub stars~917 tokensUpdated 3 mo ago
    Knowledge ManagementAuto-check passed
  • Obsidian Project Knowledge Base

    Galaxy-Dawn/claude-scholar

    Maintains a project-scoped Obsidian research knowledge base: bootstrapping its folders, routing notes, updating hub, plan and index notes, and linting.

    5.7k GitHub stars~551 tokensUpdated 16 days ago
    Knowledge ManagementAuto-check passed

More from ballred/obsidian-claude-pkm

All 13 skills in this repo
  • Daily Notes Workflow

    ballred/obsidian-claude-pkm

    Creates today's daily note in an Obsidian vault and guides morning, midday and evening routines for planning, task review and reflection.

    1.9k GitHub stars~2k tokensUpdated 7 mo ago
    Auto-check passed
  • Cascading Goal Tracker

    ballred/obsidian-claude-pkm

    Tracks three-year, yearly, monthly, and weekly goals in linked Markdown files, calculating completion percentages and flagging stalled goals.

    1.9k GitHub stars~1.5k tokensUpdated 7 mo ago
    Auto-check passed
  • Obsidian Vault Operations

    ballred/obsidian-claude-pkm

    Reads, creates and edits notes in an Obsidian vault while preserving wiki-links, YAML frontmatter, tags and template variables.

    1.9k GitHub stars~652 tokensUpdated 7 mo ago
    Auto-check passed
  • Obsidian Project Tracker

    ballred/obsidian-claude-pkm

    Creates, tracks and archives projects linked to yearly goals in an Obsidian vault, with a status dashboard and a CLAUDE.md context file for each project.

    1.9k GitHub stars~1.1k tokensUpdated 7 mo ago
    Auto-check: notes
  • Push

    ballred/obsidian-claude-pkm

    Commit and push vault changes to Git with smart commit messages.

    1.9k GitHub starsUsed in 1 repo~745 tokens
    Auto-check: notes
  • Obsidian PKM Vault Upgrade

    ballred/obsidian-claude-pkm

    Updates an obsidian-claude-pkm vault's system files to the latest version, with a backup, per-file diff review and no changes to your own notes.

    1.9k GitHub stars~1.1k tokensUpdated 7 mo ago
    Auto-check: notes

Works with

Questions about Obsidian Link Checker

What does Obsidian Link Checker do?

Scans an Obsidian vault for broken wiki-links, verifies that each target note exists, and suggests close matches, all without modifying any file. The skill finds wiki-links, the ones written in double square brackets, that point at notes that do not exist.obsidian folders, strips heading anchors, block references and aliases so only the note name remains, and then uses Glob to check that a matching file exists for each unique target.

When should I use Obsidian Link Checker?

Obsidian Link Checker fits situations like: auditing a vault for link rot; after renaming or deleting notes that other notes link to; before exporting or publishing a vault.

How do I install Obsidian Link Checker in Claude Code?

Run `npx skills add ballred/obsidian-claude-pkm --skill check-links -a claude-code`. Or copy the skill folder (vault-template/.claude/skills/check-links in ballred/obsidian-claude-pkm) into .claude/skills/check-links in your project. Claude Code loads it when a task matches its description.

How do I install Obsidian Link Checker in Codex?

Run `npx skills add ballred/obsidian-claude-pkm --skill check-links -a codex`. Or copy the skill folder (vault-template/.claude/skills/check-links in ballred/obsidian-claude-pkm) into .agents/skills/check-links in your project. Codex loads it when a task matches its description.

Can I use Obsidian Link Checker in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add ballred/obsidian-claude-pkm --skill check-links -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/check-links, .gemini/skills/check-links, .github/skills/check-links and .opencode/skills/check-links in your project.

What does Obsidian Link Checker need to run?

SKILL.md names no scripts, command-line tools or credentials: Obsidian Link Checker is instructions for the agent only. Its frontmatter pre-approves these tools: Grep, Glob, Read.

Does Obsidian Link Checker access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Obsidian Link Checker safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Obsidian Link Checker use?

Obsidian Link Checker is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Obsidian Link Checker use?

About 710 tokens (SKILL.md is roughly 2.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Obsidian Link Checker?

Skills that share tags, products or a category with Obsidian Link Checker: Obsidian Canvas Boards (AgriciDaniel/claude-obsidian, 15k stars), Obsidian Wiki Log Fold (AgriciDaniel/claude-obsidian, 15k stars), Obsidian Bases Editor (AgriciDaniel/claude-obsidian, 15k stars) and My LLM Wiki (MartinLwx/dotfiles, 140 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Obsidian Link Checker?

ballred (a GitHub user) maintains it in ballred/obsidian-claude-pkm, which has 1,877 GitHub stars. The repository holds 13 skills in this directory. The repository was last updated on February 18, 2026.

Source: ballred/obsidian-claude-pkm on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.