Getting Started

Install dotweave and set up your first sync in a few minutes.

Prerequisites

npm install -g @tinyrack/dotweave

If this is your first time using dotweave, follow these steps to create a new sync directory.

Initialize

Create a new sync directory with a fresh age key for encrypting secrets.
```
dotweave init
```
This sets up ~/.config/dotweave/ with a Git repository and an age identity.

Track your files

Tell dotweave which files to sync. For example:

dotweave track ~/.zshrc
dotweave track ~/.config/starship.toml
dotweave track ~/.config/nvim

For sensitive files like SSH keys, use secret mode:

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

Push to the sync directory

Copy your tracked files into the sync directory:
```
dotweave push
```

Commit and push with Git

Open the sync directory and push to a remote:

dotweave cd
git add -A && git commit -m "Initial sync"
git remote add origin <your-repo-url>
git push -u origin main

On a new machine, clone your existing sync directory:

Clone and initialize
```
dotweave init <your-repo-url> --key "AGE-SECRET-KEY-1..."
```
This clones the repository into ~/.config/dotweave/repository/. When connecting an existing sync repository, you must provide the same age private key used to decrypt its secret files:
```
dotweave init <your-repo-url> --promptKey
```
Pull your files

Restore all tracked files to their local paths:
```
dotweave pull
```

Now that you’re set up, explore the guides: