dotfiles
A CLI tool to install dotfiles configurations from YAML. Includes personal configs for Neovim, Tmux, Zsh, Ghostty, Kitty, i3, and Polybar.
Installation
From PyPI
pip install dotfiles-installer
# macOS
dotfiles configs/mac.yaml
# Linux
dotfiles configs/linux.yaml
From Source
git clone https://github.com/riceriley59/dotfiles.git
cd dotfiles
pip install -e .
# macOS
dotfiles configs/mac.yaml
# Linux
dotfiles configs/linux.yaml
Structure
├── configs/ # YAML configs (mac.yaml, linux.yaml)
├── dotfiles/ # Installer CLI package
├── files/ # Dotfiles to install
│ ├── config/ # ~/.config/* (nvim, ghostty, kitty, i3, polybar)
│ ├── zsh/ # ~/.zshrc, ~/.zsh_profile
│ ├── tmux/ # ~/.tmux.conf
│ └── bin/ # ~/.local/scripts
└── tests/ # Test suite
What Gets Installed
| Config | Destination | Notes |
|---|---|---|
| zsh | $HOME |
Requires oh-my-zsh |
| tmux | $HOME |
Requires TPM |
| nvim | ~/.config/nvim |
Requires ripgrep |
| ghostty | ~/.config/ghostty |
|
| kitty | ~/.config/kitty |
|
| scripts | ~/.local/scripts |
Requires fzf |
| i3 | ~/.config/i3 |
Linux only |
| polybar | ~/.config/polybar |
Linux only |
Development
pip install -e ".[dev]"
pytest
1 maintainer
Release files for dotfiles-installer 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dotfiles_installer-0.1.0.tar.gz | 9.4 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dotfiles_installer-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.4 MB
Release files / dotfiles_installer-0.1.0.tar.gz
| Download URL | dotfiles_installer-0.1.0.tar.gz |
|---|---|
| Size | 9.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f2e1212b995cc0a8d0bc390d67f7cc9ec2f062cbc01853cf78717a23a3db180f
|
|
BLAKE2b-256 checksum How to use checksums |
e1b88d2dc9dc1646e45ad70244dd829022a12704da09f9272a0ca00755fad451
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 30, 2026.
Transparency logRelease files / dotfiles_installer-0.1.0-py3-none-any.whl
| Download URL | dotfiles_installer-0.1.0-py3-none-any.whl |
|---|---|
| Size | 11.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8329342dc93455629cd7fe83415ff0770ddfd858610d1576fafe02fbb6a43d6d
|
|
BLAKE2b-256 checksum How to use checksums |
f227720e79f08ff317be1795c841bfce6ed16daede002dba53e1e0aae59aea8e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 30, 2026.
Transparency log
