@techsavvyash/vync-installer
v0.0.3
Published
CLI installer for Vync Obsidian plugin
Maintainers
Readme
Vync Installer
CLI tool to install the Vync Obsidian plugin from the latest GitHub release.
Usage
Using npx (recommended)
npx @techsavvyash/vync-installer <vault-path>Using bunx
bunx @techsavvyash/vync-installer <vault-path>Examples
# Linux/macOS
npx @techsavvyash/vync-installer ~/Documents/MyVault
# Windows
npx @techsavvyash/vync-installer "C:\Users\YourName\Documents\MyVault"What it does
The installer will:
- Fetch the latest release from the Vync GitHub repository
- Download
main.js,manifest.json, andstyles.css - Install them to
<vault-path>/.obsidian/plugins/vync/
After Installation
- Open Obsidian
- Go to Settings → Community Plugins
- Enable "Vync"
- Configure your Google Drive credentials
Requirements
- Node.js 18+ or Bun
- A valid Obsidian vault (must contain
.obsidiandirectory)
Troubleshooting
Error: Vault path does not exist
- Make sure you provide the correct path to your vault directory
Error: Not a valid Obsidian vault
- The provided path must be the root directory of your vault
- It should contain a
.obsidianfolder
Error: Required file not found in release
- The latest release might not have all required files
- Check the releases page
Development
To build the installer locally:
cd packages/installer
bun install
bun run buildTo test locally:
node dist/index.js /path/to/vaultPublishing
This package is published to npm. To publish a new version:
- Update version in
package.json - Run
npm publish --access public
Or use the automated GitHub Actions workflow (see main README).
License
MIT
