Skip to content

mdeous/dots

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

105 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

dots

CI CodeQL PyPI Python

Yet another dotfiles management tool.

✨ Features

  • πŸ”— Dotfiles stored in a central folder and symlinked to their real location
  • πŸ” Automatic git versioning on every change
  • πŸ’» Per-machine configuration via hostname-based config sections
  • ⚠️ Conflict detection and resolution during sync
  • πŸ”’ Encryption for sensitive files

πŸ“‹ Requirements

  • Python 3.12+
  • git

πŸ“¦ Installation

Install with uv:

uv tool install dotsman

To update to the latest version:

uv tool upgrade dotsman

βš™οΈ Configuration

The configuration file should be located at ~/.dots.conf.

Settings are organized in sections named after the machine's hostname. The [DEFAULT] section provides fallback values used when no hostname-specific section exists.

Available settings

Key Description Default
repo_dir Path to the dotfiles repository ~/dots
age_identity Path to an age identity file for encryption none
ignored_files Comma-separated list of glob patterns to skip during sync none

Example

[DEFAULT]
repo_dir = ~/dots

[work-laptop]
repo_dir = ~/dotfiles
ignored_files = .bashrc, .config/personal/*

[home-desktop]
age_identity = ~/.age/dots.key

πŸš€ Usage

Global options

dots [--config PATH] [--verbose] [--version] COMMAND
Option Short Description
--config -c Path to config file (default: ~/.dots.conf)
--verbose -v Display debug information
--version -V Display version and exit

dots add <file> (alias: a)

Add a file to the repository. The file is copied into the repo and replaced with a symlink.

dots add ~/.bashrc
dots add ~/.config/git/config
Option Short Description
--encrypt -e Encrypt the file with age before storing in repo

When --encrypt is used, the file is stored as a .age file in the repo (encrypted at rest), with a decrypted working copy in a gitignored .decrypted/ directory. The symlink points to the decrypted copy so the file remains usable. Requires age_identity to be set in the config.

If the file is already tracked as plaintext, --encrypt encrypts it and removes the tracked plaintext file.

dots remove <file> (aliases: rm, rem, del, delete)

Remove a file from the repository. The symlink is replaced with the original file.

dots remove ~/.bashrc

dots list (aliases: l, ls)

List all files in the repository and their sync status.

dots list

dots sync (alias: s)

Synchronize the repository with the filesystem. Creates missing symlinks and detects conflicts.

dots sync
Option Short Description
--force-relink -r Overwrite links that point to the wrong target
--force-add -a Overwrite the repo version with the local file
--force-link -l Overwrite the local file with the repo version

--force-add and --force-link are mutually exclusive. Without force flags, dots prompts interactively when conflicts are found.

πŸ”’ Encryption

Sensitive dotfiles can be encrypted at rest using age. Encrypted files are safe to push to public repositories.

Setup

  1. Generate an age identity:

    age-keygen -o ~/.age/dots.key
  2. Add the identity path to your config (~/.dots.conf):

    [DEFAULT]
    age_identity = ~/.age/dots.key
  3. Add files with encryption:

    dots add --encrypt ~/.config/secrets.env

How it works

  • Encrypted files are stored in the repo with a .age extension (e.g., secrets.env.age)
  • Decrypted working copies live in a gitignored .decrypted/ directory inside the repo
  • Symlinks point to the decrypted copies, so files are usable as normal
  • dots sync detects changes to decrypted files and re-encrypts them automatically
  • On a new machine, dots sync decrypts all .age files and creates symlinks
  • If the age identity is not configured, encrypted files are skipped with a warning during sync

πŸ“œ License

BSD 3-Clause. See LICENSE for details.

About

Yet another dotfiles management tool.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages