Agent skill

Obsidian PKM Vault Upgrade

by ballred in 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.

MITAuto-check: notesKnowledge Management

Install Obsidian PKM Vault Upgrade

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

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

GitHub CLI
$ gh skill install ballred/obsidian-claude-pkm upgrade --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/upgrade .claude/skills/upgrade && 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
upgrade
GitHub stars
1.9k
Token cost
~1.1k tokens
SKILL.md length
408 words
Files
1
Skills in repo
13
Repo updated
First seen
Licence
MIT

At a glance

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.

  • Works in 5 steps: Check for Updates → Create Backup → Diff Review → …
  • Updating an obsidian-claude-pkm vault to a newer release
  • SKILL.md covers Usage, What Gets Updated (System Files), What Never Gets Touched (Your… and Upgrade Process, plus 5 more sections
  • Calls git

What it does

The skill separates system files from your content. System files it may update include skill definitions, agent configs, hooks, rules, output styles, settings.json, the root CLAUDE.md and note templates. Daily notes, goals, projects, archives, the inbox, CLAUDE.local.md and vault-config.json are never touched, and /upgrade check previews the changes without modifying anything.

It reads the current version from CLAUDE.md and compares it with the upstream repository using git fetch when the vault is a git repo, otherwise asking you to download the latest vault-template by hand. A timestamped backup is made first, each differing file is summarized for a yes, skip or stop answer, and CLAUDE.md and settings.json are merged so your own sections and permissions survive. Afterward the hook scripts are made executable and a summary is shown.

When your agent uses it

  • Updating an obsidian-claude-pkm vault to a newer release
  • Previewing what an update would change before applying it
  • Merging new settings and hooks without losing personal customizations

Example prompts

  • “Run /upgrade check and tell me what changed upstream before touching anything.”
  • “Upgrade my vault, show me each diff and let me skip the hooks.”
  • “Update the vault but keep my Personal Mission section in CLAUDE.md.”

Requirements

  • A vault created from the obsidian-claude-pkm template
  • git access to the upstream repository, or a manually downloaded vault-template
  • Pre-approved tools (allowed-tools): Read, Write, Edit, Glob, Grep, Bash

Workflow steps

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

  1. Check for Updates
  2. Create Backup
  3. Diff Review
  4. Apply Changes
  5. Post-Upgrade

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:

    • Read
    • Write
    • Edit
    • Glob
    • Grep
    • Bash

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git

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

  • Network

    No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.

    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 PKM Vault Upgrade loads about 1.1k tokens when it runs. Until then it costs about 39 tokens; SKILL.md has 408 words of instructions outside code blocks.

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

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: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NotePre-approves every shell command (allowed-tools: Bash)SKILL.md
    allowed-tools: Read, Write, Edit, Glob, Grep, Bash

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). 408 words, ~1,108 tokens.

Download SKILL.mdSave it as .claude/skills/upgrade/SKILL.md (or your agent's skills folder).
name
upgrade
description
Update vault to the latest version of obsidian-claude-pkm. Creates backup, shows diffs, preserves your content. Use when a new version is available.
allowed-tools
Read, Write, Edit, Glob, Grep, Bash
model
sonnet
user-invocable
true

Upgrade Skill

Updates your vault's system files to the latest version while preserving all your personal content.

Usage

/upgrade          # Interactive upgrade with backup and diff review
/upgrade check    # Preview what's changed without making modifications

What Gets Updated (System Files)

  • .claude/skills/*/SKILL.md — Skill definitions
  • .claude/agents/*.md — Agent configurations
  • .claude/hooks/*.sh — Automation scripts
  • .claude/rules/*.md — Convention rules
  • .claude/output-styles/*.md — Output style definitions
  • .claude/settings.json — Permissions and hook config
  • CLAUDE.md — Root context file (merged carefully)
  • Templates/*.md — Note templates

What Never Gets Touched (Your Content)

  • Daily Notes/** — Your daily journal entries
  • Goals/** — Your goal files and reviews
  • Projects/** — Your project folders and CLAUDE.md files
  • Archives/** — Your archived content
  • Inbox/** — Your captured items
  • CLAUDE.local.md — Your personal overrides
  • vault-config.json — Your preferences

Upgrade Process

Step 1: Check for Updates

Read the current version from CLAUDE.md (look for "System Version:" line).

Compare with the upstream repo. If using git:

bash
git fetch origin
git log HEAD..origin/main --oneline

If not a git repo or no remote, inform user they need to download the latest vault-template/ manually.

Step 2: Create Backup

Before any changes, create a timestamped backup:

bash
BACKUP_DIR=".backup/upgrade-$(date +%Y%m%d-%H%M%S)"
mkdir -p "$BACKUP_DIR"
cp -r .claude "$BACKUP_DIR/"
cp CLAUDE.md "$BACKUP_DIR/"
cp -r Templates "$BACKUP_DIR/" 2>/dev/null

Tell the user: "Backup created at $BACKUP_DIR"

Step 3: Diff Review

For each system file that differs from upstream:

  1. Show a summary of what changed (additions, removals, modifications)
  2. Ask user to confirm: "Apply this update? (yes/skip/stop)"
  3. If yes: apply the change
  4. If skip: leave this file unchanged
  5. If stop: halt the upgrade (backup remains, partial changes preserved)
Step 4: Apply Changes

For each confirmed file:

  • Copy the new version from upstream
  • For CLAUDE.md: merge carefully — preserve user customizations (Personal Mission, Current Focus sections) while updating system sections (Skills table, version number)
  • For settings.json: merge — add new permissions/hooks, preserve existing customizations
Show full SKILL.md (155 more words)Show less
Step 5: Post-Upgrade
  1. Make hook scripts executable: chmod +x .claude/hooks/*.sh
  2. Show summary of changes applied
  3. Update version in CLAUDE.md
  4. Suggest running /onboard to reload context

Check Mode (/upgrade check)

When invoked with "check":

  1. Compare system files against upstream
  2. List files that would be updated with brief change description
  3. Show version numbers (current → available)
  4. Do NOT make any changes
  5. Suggest running /upgrade to apply

Output Format

markdown
## Upgrade Check

**Current version:** 3.0 (The Cascade)
**Available version:** 3.1

### Files to Update
| File | Change Summary |
|------|---------------|
| `.claude/skills/daily/SKILL.md` | Added cascade context surfacing |
| `.claude/agents/goal-aligner.md` | Added memory: project |
| `.claude/hooks/session-init.sh` | Added priority surfacing |

### New Files
- `.claude/skills/review/SKILL.md` — Smart review router
- `.claude/hooks/skill-discovery.sh` — Auto-list skills

### No Changes Needed
- `.claude/rules/` — Already up to date

Run `/upgrade` to apply these updates (backup will be created first).

Safety Features

  • Complete backup before any modification
  • File-by-file confirmation
  • Can be stopped at any point
  • User content folders are never touched
  • CLAUDE.local.md personal overrides preserved
  • Backup includes restoration instructions

Error Handling

  • If no git remote: guide user to download latest vault-template manually
  • If backup fails: abort entire upgrade
  • If a file copy fails: report error, continue with next file
  • Always leave vault in a usable state

Integration

Works with:

  • /onboard — Reload context after upgrade
  • Session init hook — Will reflect updated priorities

© 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/upgrade of ballred/obsidian-claude-pkm.

Open the folder on GitHubat commit ef1e4da

Compare with similar skills

Obsidian PKM Vault Upgrade 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 PKM Vault Upgrade compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Obsidian PKM Vault Upgrade this skillballred/obsidian-claude-pkm1.9k—~1.1kAutomated safety check: NotesMIT
Bounded AutoresearchAgriciDaniel/claude-obsidian15k—~1.6kAutomated safety check: PassMIT
Obsidian Canvas BoardsAgriciDaniel/claude-obsidian15k—~1.4kAutomated safety check: PassMIT
Obsidian Wiki Vault SetupAgriciDaniel/claude-obsidian15k—~1.3kAutomated safety check: PassMIT
Second BrainNicholasSpisak/second-brain735—~1.5kAutomated safety check: NotesNone
Obsidian Wiki Log FoldAgriciDaniel/claude-obsidian15k—~1.2kAutomated safety check: PassMIT

Similar skills

  • Bounded Autoresearch

    AgriciDaniel/claude-obsidian

    Runs a bounded, source-grounded research loop that drafts a cited dossier and can propose a separately reviewed merge into an Obsidian vault.

    15k GitHub stars~1.6k tokensUpdated 27 days ago
    Knowledge ManagementAuto-check passed
  • 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 27 days ago
    Knowledge ManagementAuto-check passed
  • Obsidian Wiki Vault Setup

    AgriciDaniel/claude-obsidian

    Sets up or adopts a separate Obsidian knowledge vault through the claude-obsidian core script and routes follow-up work to the right wiki sub-skill.

    15k GitHub stars~1.3k tokensUpdated 27 days ago
    Knowledge ManagementAuto-check passed
  • Second Brain

    NicholasSpisak/second-brain

    Set up a new Obsidian knowledge base with the LLM Wiki pattern.

    735 GitHub stars~1.5k tokensUpdated 6 mo ago
    Knowledge ManagementAuto-check: notes
  • 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 27 days ago
    Knowledge ManagementAuto-check passed
  • Obsidian StudyVault Builder

    bevibing/tutor-skills

    Converts PDFs, text, web pages or a codebase into an Obsidian vault of study notes, practice questions, or a developer onboarding guide.

    1.3k GitHub stars~1.9k tokensUpdated 7 mo ago
    Knowledge ManagementAuto-check: notes

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 Vault Adoption

    ballred/obsidian-claude-pkm

    Scans an existing Obsidian vault, maps its folders to PKM roles with your confirmation and generates configuration for the Claude PKM system without a template.

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

Works with

Questions about Obsidian PKM Vault Upgrade

What does Obsidian PKM Vault Upgrade do?

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. The skill separates system files from your content.md and note templates.

When should I use Obsidian PKM Vault Upgrade?

Obsidian PKM Vault Upgrade fits situations like: updating an obsidian-claude-pkm vault to a newer release; previewing what an update would change before applying it; merging new settings and hooks without losing personal customizations.

How do I install Obsidian PKM Vault Upgrade in Claude Code?

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

How do I install Obsidian PKM Vault Upgrade in Codex?

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

Can I use Obsidian PKM Vault Upgrade 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 upgrade -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/upgrade, .gemini/skills/upgrade, .github/skills/upgrade and .opencode/skills/upgrade in your project.

What does Obsidian PKM Vault Upgrade need to run?

Going by SKILL.md and its folder, Obsidian PKM Vault Upgrade needs the command-line tools its instructions call (git). Our summary lists: A vault created from the obsidian-claude-pkm template; git access to the upstream repository, or a manually downloaded vault-template. Its frontmatter pre-approves these tools: Read, Write, Edit, Glob, Grep, Bash.

Does Obsidian PKM Vault Upgrade access the network?

SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Obsidian PKM Vault Upgrade safe to install?

Our automated static check of SKILL.md found notes only (pre-approves every shell command (allowed-tools: bash)), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Obsidian PKM Vault Upgrade use?

Obsidian PKM Vault Upgrade 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 PKM Vault Upgrade use?

About 1.1k tokens (SKILL.md is roughly 4.4k 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 PKM Vault Upgrade?

Skills that share tags, products or a category with Obsidian PKM Vault Upgrade: Bounded Autoresearch (AgriciDaniel/claude-obsidian, 15k stars), Obsidian Canvas Boards (AgriciDaniel/claude-obsidian, 15k stars), Obsidian Wiki Vault Setup (AgriciDaniel/claude-obsidian, 15k stars) and Second Brain (NicholasSpisak/second-brain, 735 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Obsidian PKM Vault Upgrade?

ballred (a GitHub user) maintains it in ballred/obsidian-claude-pkm, which has 1,876 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.