Installation

Installation

Quick install

curl -fsSL https://raw.githubusercontent.com/CtrlUserKnown/dots/main/install.sh | sh

The installer is a portable POSIX sh script that:

1. Clones the repo to ~/.dots (or updates it if already present).
2. Downloads a prebuilt binary for your OS/arch from the releases, falling back to a cargo build --release if no matching release is found.
3. Puts dots on your PATH (via ~/.dots/bin).
4. Runs dots init to create default config.

Options

install.sh [--branch <name>] [--version <tag>] [--dir <path>]

Flag	Purpose
--branch <name>	Install from a specific branch (default main)
--version <tag>	Pin to a specific release tag, e.g. --version v1.6.0
--dir <path>	Install to a custom directory (default ~/.dots)

Building from source

You need a Rust toolchain. dots has no platform-locked native dependencies (pure-Rust TLS, no OpenSSL or keychain), so it builds the same way everywhere.

git clone https://github.com/CtrlUserKnown/dots ~/.dots
cd ~/.dots
cargo build --release          # binary at target/release/dots

Then add it to your PATH, e.g.:

cp target/release/dots ~/.dots/bin/dots
export PATH="$HOME/.dots/bin:$PATH"      # add to your shell rc

macOS-specific notes (Apple Silicon and Intel) are in BUILD_MACOS.md.

Requirements

• OS: macOS or Linux.
• Package manager (for dots install): Homebrew, apt, or dnf. dots auto-detects which is present.
• git: required for install and for update checks.

Uninstall

curl -fsSL https://raw.githubusercontent.com/CtrlUserKnown/dots/main/uninstall.sh | bash

This removes the dots binary and known symlinks. See uninstall.sh.