Skip to main content

NeutronSync command line client. Use to securely sync your dot files.

Project description

Neutron Sync CLI Client


Neutron Sync is a synchronization tool that helps you synchronize your small configuration files often referred to as dot files. Since these files are often sensitive and contain things such as encryption keys and passwords, files are encrypted before being stored remotely. Only you own the key that can decrypt the files. Additionally, if you use the default remote store, then files are encrypted again at rest. Thus files are encrypted twice for extra security.


  • Upload encrypted files to remote storage.
  • Pull files that are missing or out sync.
  • Push files that have changed.
  • Multiple profile support: personal, work, etc
  • Key exchange setup process on new machines


pipx install nsync-cli

pipx recommended but pip install also works


pipx upgrade nsync-cli


One Time Setup

nsync login
nsync keygen

!!!Note!!! Be sure to keep .config/nsync/config.json safe. This file has your encryption key without it you can not decrypt your files.

Everyday Usage

# Add new files to sync
nsync add path/to/file

# Pull files that need to be updated
nsync pull

# Add files to sync
# add command supports file globs like ".ssh/*" and "./ssh/**/*"
# with the second example being recursive.
nsync add "./ssh/**/*"

# Push updated files
nsync push

For more documentation see our wiki.

Key Exchange

To help speed up the setup of multiple machines, the CLI client supports a key exchange process.

See the key exchange documentation for more info.


  • Files synced are assumed to be small configuration files. Larger files (>1mb) may choke or slow down sync processes.

Open Source

Visit our Github to contribute the project.

Running Your Own Server

To use your own server update your config file, replace the server_url value: "server_url": "". Your config file is located at ~/.config/nsync/config.json

See the Neutron Server project for information on how to host your own server.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for nsync-cli, version 1.6.0
Filename, size File type Python version Upload date Hashes
Filename, size nsync_cli-1.6.0-py3-none-any.whl (14.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size nsync-cli-1.6.0.tar.gz (11.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page