Documentation
Quickstart
Get syncing in under 5 minutes
One-Line Install
curl -fsSL configsync.dev/install | sh
To install and connect in one step, pass your API token:
curl -fsSL "configsync.dev/install?token=cs_xxx" | sh
Or use the guided setup command after installing:
configsync setup --token cs_xxx
1. Install
npm install -g @inventivehq/configsync
Requires Node.js 18 or later.
2. Initialize
configsync init
This creates ~/.configsync/ and prompts you to set a master password. This password encrypts all your data locally and is never transmitted.
3. Connect to Cloud (Optional)
To sync across machines, create an account at configsync.dev, generate an API token from the dashboard, then:
configsync login --token cs_your_token_here
4. Add Your Stuff
# Add tool modules (auto-detects files)
configsync add module ssh
configsync add module vscode
configsync add module git
# Add individual config files
configsync add config ~/.zshrc
configsync add config ~/.gitconfig
# Add a project (auto-detects .env, git, secrets)
configsync add project ~/git/myapp
# Scan and track installed packages
configsync scan
configsync add module without a name to see all detected modules on your machine.5. Push
configsync push -m "initial setup"
Everything is encrypted locally, then the encrypted blob is uploaded. The server never sees your plaintext data.
6. Pull on Another Machine
# Install and login on the new machine
npm install -g @inventivehq/configsync
configsync login --token cs_your_token_here
# Preview what will be restored
configsync pull --dry-run
# Pull and restore everything
configsync pull
# Also install missing packages
configsync pull --install
7. Keep in Sync
# Auto-push when files change
configsync watch
Verify Installation
# Check everything is working
configsync doctor
# See what you're tracking
configsync list
configsync status