Documentation
README
Sync Upstream ObsidianOS
Shortcut to run .scripts/sync-upstream.sh.
Usage
| Command | What it does |
|---|---|
/sync-upstream-obsidianos |
Preview and merge upstream updates |
/sync-upstream-obsidianos preview |
Preview only โ show what's new without merging |
Workflow
1. Check prerequisites
- Verify
upstreamremote exists:git remote get-url upstream. If missing, tell the user to add it:git remote add upstream <url-to-upstream-repo> - Verify working tree is clean (
git status --short). If dirty, ask the user to commit or stash first.
2. Preview
Run .scripts/sync-upstream.sh --preview and show the output (new commits and changed files).
This is the opening of the README. Read the full README on GitHub.