Github sync

Skill Howie126313/obsidian-vault-kit/skills/github-sync

Claude Code plugin for full-lifecycle Obsidian knowledge management — vault lint, Karpathy-style query, Ebbinghaus spaced repetition, article ingestion, and GitHub sync.

Install

npx -y skills add Howie126313/obsidian-vault-kit --skill github-sync

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

3 stars3 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Sync local Obsidian vault to GitHub — auto-update README.md and push. Triggers: /github-sync, "sync to github", "push to github", "update repo"

SKILL.md

3.0 KB, as published. Nobody here has run it

GitHub Sync — Subagent Dispatcher

When this skill is triggered, do not execute sync steps yourself. Immediately use the Agent tool to launch an independent subagent in the background to handle the entire sync workflow.

Dispatch

Call the Agent tool with the following parameters:

Agent({
  description: "GitHub Sync",
  model: "sonnet",
  run_in_background: true,
  mode: "bypassPermissions",
  prompt: <full content of the sync-workflow block below>
})

After dispatching, inform the user that sync has started in the background. They can continue other work and will be notified on completion.

sync-workflow

Pass the following content as the Agent prompt (copy verbatim, do not modify):

<sync-workflow> You are a GitHub Sync automation agent. Follow these steps strictly to sync the Obsidian vault to GitHub.

Step 1: Environment Detection & Status Check

1a. Detect project root and remote (run in parallel):

git rev-parse --show-toplevel    # project root
git remote get-url origin        # remote URL
git branch --show-current        # current branch

1b. Check Git status:

git status
git diff --stat

If there are no changes (no unstaged modifications, no untracked files), output "Nothing to sync" and end.

Step 2: Analyze Changes and Update README.md

2a. Categorize all changed files into three groups:

Added: new articles or directories
Modified: updated content
Deleted: removed content

2b. Update README.md:

Read current README.md content
Use Glob("**/*.md") to scan the project directory structure, count Markdown files (exclude .claude/ directory)
Update knowledge base sections based on added/deleted articles and directories
Update statistics (Markdown file count, directory categories) and custom Skills list (if changed)
Preserve existing README.md format and style

Update principle: only update sections with actual changes, do not rewrite unnecessarily.

Step 3: Commit and Push

git add all changes (including README.md), exclude .playwright-mcp/ log files
Generate a commit message based on changes, format: type: brief description
- Types: add, update, delete, refactor, fix (use the most prominent type if multiple apply)
- Append to commit message: \n\nCo-Authored-By: Claude Sonnet 4.6 <[email protected]>
git commit (use HEREDOC format for the commit message)
git push origin $BRANCH

Step 4: Output Results

Output a brief sync report including:

Summary of changes synced (what was added/modified/deleted)
README.md update details
Push status (success/failure; if failed, analyze the cause)

Notes

If conflicts are encountered, output conflict details — do not force overwrite
Do not stage files under the .playwright-mcp/ directory </sync-workflow>