Quick Start

Installation

npm

npm install -g @tinyrack/devsync

pnpm

pnpm add -g @tinyrack/devsync

yarn

yarn global add @tinyrack/devsync

After installation, verify it’s working:

devsync --version

---

Start with a new repository

1. Initialize Devsync

   devsync init

   You’ll be asked for an age private key. Press Enter to generate a new one automatically.

   After initialization, the following structure is created under ~/.config/devsync/:

   • Directory~/.config/devsync/

     • Directorysync/ Git repository where synced files are stored

       • …
     • Directoryage/

       • keys.txt age private key used to decrypt secret files
     • settings.json Global settings (active profile, etc.)

   Caution

   age/keys.txt is the private key used to decrypt your secret files. If you lose it, encrypted files cannot be recovered. Back it up somewhere safe.

2. Track files

   Register the files or directories you want to sync:

   devsync track ~/.gitconfig
   devsync track ~/.zshrc
   devsync track ~/.config/nvim

   For sensitive files, use --mode secret to store them encrypted in the repository:

   devsync track ~/.ssh/config --mode secret

3. Push to the sync repository

   devsync push

   This mirrors your local files into ~/.config/devsync/sync/. No git commit is created at this point.

4. Publish to a remote Git repository

   Use devsync cd to enter the sync repository directory, then run git commands directly:

   devsync cd

   git remote add origin https://github.com/yourname/dotfiles.git
   git add .
   git commit -m "Initial sync"
   git push -u origin main
   exit

---

Connect an existing repository

If you’re setting up a new machine and already have a dotfiles repository, pass the repository URL to init:

devsync init https://github.com/yourname/dotfiles.git

You’ll be prompted to enter your age private key. Enter the key you backed up from your original machine.

Note

The age private key is a string starting with AGE-SECRET-KEY-. If you have the key in a file, you can pass it directly with --key:

devsync init https://github.com/yourname/dotfiles.git --key AGE-SECRET-KEY-...

After cloning, restore your files to their original paths:

devsync pull

Devsync automatically decrypts secret files with your age key.