Getting Started · Dotweave

Prerequisites

winget install 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 the dotweave app-data directory 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

Tip

After setting up, check out the Directory Structure guide to see where dotweave stores your config and synced files.

On a new machine, clone your existing sync directory:

Clone and initialize
```
dotweave init <your-repo-url> --key-file ~/dotweave.agekey
```
This clones the repository into the dotweave app-data directory under 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>
```
Pull your files
Restore all tracked files to their local paths:
```
dotweave pull
```

Note

If your sync directory contains encrypted secrets, you need the same age private key on all machines. See Syncing Secrets for details.

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