DotfilesForge

Mirror

Is Project is a mirror of my own hosted Forgejo Instance. If you have Problems or want to ask something please head to here.

Disclaimer

This Project is still activly being developed. Breaking changes can occur often. The first Release will be Stable but will not necessarily be without bugs.

If you find a Problem or Bug. Please create a Issue on the Forgejo Instance where you explain and also add Context. If you want to have other specific Installers you can also add them and then open a Pull Request so it will be added into the Project.

Description

This Python CLI Tool trys to deliver a always repeatable install of your Dotfiles and the needed programs. It is configured with a Toml Config File that is read in. Tools to install can be also added if not yet in this Repository since all Tools should follow the same Base Models. If you add a Tool for yourself we would like if you also add a Pull Request so it can be included for everyone else if possible.

Installation

To install this package you can clone this Repository and use uv to run or install it as tool.

Run this in the cloned Repository to execute the script:

uv run dotfilesforge [COMMAND]

Run this in the cloned Repository to install the script as CLI Tool:

uv tool install .

Config

Configs can be saved under:

• ~/.dotfiles/dotfilesforge.toml
• ~/dotfilesforge.toml
• ~/.config/dotfilesforge/config.toml

This is how a config could look:

[paths]
git_repos = "~/git"
dotfiles = "~/.dotfiles"
appimages = "~/.dotfiles/AppImage"

[tools.ghostty]
enabled=true
version="tip"
#Optional defaults to true
wsl=false

[tools.neovim]
enabled=true
version="0.11.6"
install_method="default"

[shell]
name="zsh" # What Shell you want to install

[packages]
pacman=['blueprint-compiler', 'ninja', 'gcc']

[dotfiles_repo]
repo_name="test/test"
repo_host="custom" # github, gitlab
#Optional when not wanted https for cloning
#repo_modus="ssh"
#Only Used if repo_host is custom
repo_url="gitlab.noctiswolfshadow.com"

Available Tools

The most tested version most time is just default. If you dont know what to choose the best is also default

Laravel and rustup only support default. The Method is just more described in the table for correctness.

Tool Name	Install Methods	Default
Ghostty	Git, Package	Git
Neovim	Git, Package, Binary	Git
Opencode	Binary	Binary
Composer	Binary	Binary
FZF	Package, Binary	Package
rustup	Binary	Binary
yazi	Git, Package	Git
Laravel	Composer	Composer
Zig	Binary	Binary
Obsidian	AppImage	AppImage