Skip to content
| Marketplace
Sign in
Visual Studio Code>Other>peter-syncNew to Visual Studio Code? Get it now.
peter-sync

peter-sync

Hong Kong Programming Society

|
1 install
| (0) | Free
Bidirectional folder sync from VS Code using the peter-sync CLI
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

peter-sync

VS Code sidebar for the peter-sync CLI. Add folder pairs, sync them once, or watch them continuously.

The extension does not reimplement sync. It reads ~/.peter-sync/settings.json and runs peter-sync add|remove|sync|watch.

Requirements

Install the CLI first:

pip install peter-sync

If peter-sync is not on PATH, set peter-sync.cliPath to the executable, for example:

/Users/peter/workspace/peter-sync/.venv/bin/peter-sync

You can also use python -m peter_sync.

Features

  • Activity bar view of saved folder pairs
  • Add a pair with a name, two folder pickers, and optional excluded folders
  • Edit excluded folders from a pair's context menu (node_modules matches anywhere)
  • Sync one pair or all pairs
  • Watch one pair or all pairs (polls at peter-sync.watchInterval)
  • Stop watch from the view title or a watching pair
  • Open the settings JSON file
  • Status bar item and peter-sync output channel

Run from source

  1. Open this folder in VS Code.
  2. Press F5 (Run Extension).
  3. In the Extension Development Host, open the peter-sync activity bar icon.
  4. Add a pair, then Sync or Watch.

Settings

  • peter-sync.cliPath: executable or python -m peter_sync (default peter-sync)
  • peter-sync.settingsPath: optional settings JSON; empty uses ~/.peter-sync/settings.json
  • peter-sync.watchInterval: seconds between watch polls (default 2)

Commands

  • peter-sync: Add Pair
  • peter-sync: Sync All
  • peter-sync: Watch All
  • peter-sync: Stop Watch
  • peter-sync: Refresh
  • peter-sync: Open Settings File

Pair-specific Sync / Watch / Remove / Edit Excludes actions are on each tree item.

Known Issues

Watch is a long-running CLI process. Stopping it sends SIGTERM to that process. If the CLI is missing, commands fail with a message to install it or set peter-sync.cliPath.

Package

npm install
npm run compile

Then press F5 in VSCode to launch an Extension Development Host.

Packaging

npm install -g @vscode/vsce
vsce package
vsce publish

publish to cursor

npm install -g ovsx
ovsx publish -p <token>

Install the generated .vsix via "Extensions: Install from VSIX...".

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2026 Microsoft