README file from
GithubStarVault
GitHub starred repositories sync and management tool for Obsidian.
Features
- GitHub Sync: One-click sync your GitHub starred repositories to local
- Smart Search: Full-text search by repository name and description
- Custom Tags: Add, edit, and manage tags for repositories
- Multi-filter: Filter by programming language
- Flexible Sorting: Sort by stars, forks, or last updated time
- Soft Delete: Safely hide repositories, restore anytime
Installation
- Download the latest release from GitHub Releases
- Copy
main.js,manifest.json, andstyles.cssto your vault's plugin folder:<Vault>/.obsidian/plugins/starvault/ - Enable the plugin in Settings → Community plugins
Setup
- Go to Settings → StarVault
- Enter your GitHub Personal Access Token
- Create a token at GitHub Settings → Developer settings → Personal access tokens
- Required scope:
repo(full control of private repositories) orread:user(for public repos only)
- Click "Sync GitHub Stars" to start syncing
Usage
Sidebar
- Repository Cards: Display name, description, language, stars, forks
- Tags: Show up to 3 tags, with "+N" indicator for overflow
- Search: Filter repositories by name or description
- Filter: Filter by language or status (All / Archived)
- Sort: Sort by Stars, Forks, or Last Updated
Detail View
- View full repository information
- Add or edit custom tags
- Soft delete (move to archive)
- Open in browser
Commands
| Command | Description |
|---|---|
| Sync GitHub Stars | Sync all starred repositories |
| Toggle Sidebar | Show or hide the sidebar |
Data Storage
All data is stored locally in your vault using IndexedDB:
- Repository information
- Custom tags
- Soft delete status
No data is sent to any external server.
Keyboard Shortcuts
| Shortcut | Action |
|---|---|
Ctrl+P |
Quick search |
Esc |
Close detail view |
Support
- Report bugs: GitHub Issues
- Feature requests: GitHub Discussions
License
MIT