Registry / devops / omnisync

omnisync

JSON →
library2.5.0jsnpmunverified

OmniSync v2.5.0 is an open-source CLI tool for migrating entire workstations or servers to new machines. It creates a portable 'briefcase' containing installed packages, dotfiles, SSH keys, VS Code extensions, Docker containers, and secrets, then restores them on a target machine. Unlike rsync or Ansible, OmniSync offers a guided TUI and zero-config setup. It supports apt, pip, npm, cargo package managers and includes AES-256-GCM encryption for secrets. Actively maintained on GitHub with monthly releases, it requires Node.js >=18 for the npm package.

devops
npm install omnisync
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · OMNISYNC
O
omnisync
devopsjavascriptv2.5.0
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

omnisync
✓ npm install -g omnisync
The tool is a CLI, not a library. Install globally via npm, or use the install.sh script.

Installs OmniSync globally, shows help, packs the current machine, and restores on a new machine.

npm install -g omnisync omni --help # Pack current machine into a briefcase omni pack --all --output /backups/my-briefcase.omni # Restore on new machine (after copying briefcase) omni restore /backups/my-briefcase.omni # Use interactive TUI omni
Debug
Known issues
gotchaThe install script hash in README is for v2.3.2, not latest. Always verify against GitHub releases.
fix
Check https://github.com/sxrubyo/omnisync/releases for current SHA256 before running install.sh
affects: >=2.0.0
breakingSecrets pack encryption uses AES-256-GCM. Losing the passphrase means permanent data loss.
fix
Store passphrase in a password manager. There is no recovery mechanism.
affects: >=1.0.0
deprecatedThe --all flag in v2.4.0+ is now default behavior. Explicit --all will be removed in v3.0.
fix
Use `omni pack` without --all, or omit the flag.
affects: >=2.4.0
gotchaOmniSync requires Python 3.10+ for install.sh script, but npm package requires Node >=18.
fix
Ensure Python 3.10+ is available if using install.sh, or use npm package on Node 18+.
affects: >=2.0.0
breakingDocker container migration only works if Docker socket is accessible. Containers are not exported if Docker is not running.
fix
Ensure Docker daemon is running and user has socket access before packing.
affects: >=1.0.0
Errors
Common errors & fixes
Error: Cannot find module 'omnisync'
OmniSync is not a Node library; it's a CLI tool.
fix
Do not require/import it. Use `npm install -g omnisync` and run `omni` from shell.
sha256sum: install.sh: FAILED
Checksum mismatch due to outdated README hash or modified script.
fix
Download fresh script from GitHub releases and verify against the official SHA256 listed there.
Permission denied (publickey) when running omni pack --ssh
SSH agent or keys not configured properly on source machine.
fix
Ensure SSH agent is running and keys are added: eval $(ssh-agent) && ssh-add
Upgrade
Version history
2.5.0latest on npm
Audit
Dependencies
nodeoptionalRuntime requirement for npm-installed CLI
Agent activity
9 hits · last 30 days
node
8
Resources
githubhttps://github.com/sxrubyo/omnisync ↗
packageomnisync ↗
homepagehttps://github.com/sxrubyo/omnisync#readme ↗
omnisync — npm install omnisync · libregistry