A CLI tool to install dotfiles configurations from YAML
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file dotfiles_installer-0.1.0.tar.gz.
File metadata
- Download URL: dotfiles_installer-0.1.0.tar.gz
- Upload date:
- Size: 9.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f2e1212b995cc0a8d0bc390d67f7cc9ec2f062cbc01853cf78717a23a3db180f
|
|
| MD5 |
8ab2f44050bdcfca320e3ca2a2696a3b
|
|
| BLAKE2b-256 |
e1b88d2dc9dc1646e45ad70244dd829022a12704da09f9272a0ca00755fad451
|
Provenance
The following attestation bundles were made for dotfiles_installer-0.1.0.tar.gz:
Publisher:
publish.yaml on riceriley59/dotfiles
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
dotfiles_installer-0.1.0.tar.gz -
Subject digest:
f2e1212b995cc0a8d0bc390d67f7cc9ec2f062cbc01853cf78717a23a3db180f - Sigstore transparency entry: 872259890
- Sigstore integration time:
-
Permalink:
riceriley59/dotfiles@42dac14ed5313a8e7a71bad2eb69a2ddc95fe8ea -
Branch / Tag:
refs/tags/0.1.0 - Owner: https://github.com/riceriley59
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@42dac14ed5313a8e7a71bad2eb69a2ddc95fe8ea -
Trigger Event:
push
-
Statement type:
File details
Details for the file dotfiles_installer-0.1.0-py3-none-any.whl.
File metadata
- Download URL: dotfiles_installer-0.1.0-py3-none-any.whl
- Upload date:
- Size: 11.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8329342dc93455629cd7fe83415ff0770ddfd858610d1576fafe02fbb6a43d6d
|
|
| MD5 |
0d4f15b20ae65052d09aa89ee297fd50
|
|
| BLAKE2b-256 |
f227720e79f08ff317be1795c841bfce6ed16daede002dba53e1e0aae59aea8e
|
Provenance
The following attestation bundles were made for dotfiles_installer-0.1.0-py3-none-any.whl:
Publisher:
publish.yaml on riceriley59/dotfiles
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
dotfiles_installer-0.1.0-py3-none-any.whl -
Subject digest:
8329342dc93455629cd7fe83415ff0770ddfd858610d1576fafe02fbb6a43d6d - Sigstore transparency entry: 872259896
- Sigstore integration time:
-
Permalink:
riceriley59/dotfiles@42dac14ed5313a8e7a71bad2eb69a2ddc95fe8ea -
Branch / Tag:
refs/tags/0.1.0 - Owner: https://github.com/riceriley59
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@42dac14ed5313a8e7a71bad2eb69a2ddc95fe8ea -
Trigger Event:
push
-
Statement type: