Quickstart

1. Install tuck

If you already have Go 1.26 or newer:

go install github.com/trippwill/tuck/cmd/tuck@latest

For released binaries:

curl -fsSLo install.sh https://raw.githubusercontent.com/trippwill/tuck/main/install.sh
less install.sh
sh install.sh

2. Register a source

A source is the dotfiles repository tuck reads packages from:

tuck source add ~/dotfiles --init --default

This writes ~/dotfiles/.tuck.toml if it does not exist and records the source in machine-local state.

3. Adopt an existing file

Adopt plans the move first:

tuck adopt zsh ~/.zshrc

Apply after reviewing the plan:

tuck adopt zsh ~/.zshrc --apply

4. Deploy a package

Plan deployment:

tuck package use zsh

Apply it:

tuck package use zsh --apply

5. Check status

tuck status ~/.zshrc
tuck package status zsh

Notes

• Mutating target-tree commands are dry-run by default.
• Use --root for root-context files under /.
• Use --json for machine-readable output.
• package can be shortened to pkg.