fuxi
dotfile organization made easy
Caution
Please be careful when using this program as it is still not fully tested
What is this?
fuxi is a CLI tool to help manage, create, and restore backups of your dotfiles using GitHub
Why?
Keeping track of dotfiles can be hard sometimes so why not automate most of the process
How do i use it?
Requirements
- git (should be configured with your Git provider, ex. Github)
Installation
cargo install fuxi-cli
If instalation fails on Windows, use the following command:
cargo install fuxi-cli --target x86_64-pc-windows-gnu
Building from source
git clone https://github.com/ImShyMike/fuxi.git
cd fuxi
cargo build --release
Usage
Quickstart guide
1. Initialize with a repository
Start by creating a repository (can be private) and get it's local path.
fuxi init your_username/repo_name REPO_PATH_HERE
2. Create a profile
fuxi profile create main
Profiles can be used to store separate dotfile configs.
3. Add paths
fuxi path add ~/.wakatime.cfg ~/.zshrc
4. Create a backup snapshot
fuxi backup -m "Update wakatime config" --push
5. Save repository state without copying files
fuxi save -m "Sync configuration"
This is can be used after manual tweaks inside the backup repository.
6. Apply a backup
fuxi apply latest
Replace latest with a specific backup ID or commit hash as needed. Include --dryrun to preview the actions without modifying any files.
Available commands
| Command | Purpose |
|---|---|
fuxi version |
Print the currently installed CLI version. |
fuxi config [-r] |
Show the config file path (config.toml under your OS config directory). Use -r for the raw path only. |
fuxi init |
Register the remote repository (username/repo) and the local folder that will store backups. Creates the folder and initializes Git if needed. |
fuxi profile list |
Display every profile and the paths mapped to it. |
fuxi profile create |
Create an empty profile. The first profile created becomes the active one automatically. |
fuxi profile switch |
Set the active profile. |
fuxi profile delete |
Remove a profile and its path list from the config. |
fuxi path list |
Show the paths tracked by the currently selected profile. |
fuxi path add |
Register one or more filesystem paths to track. Directories are copied recursively; files are copied one-to-one. |
fuxi path remove |
Stop tracking one or more paths. |
fuxi backup [-m |
Copy tracked paths into the repository under |
fuxi save [-m |
Commit pending repository changes and push them upstream. Use --force to skip the confirmation prompt. |
fuxi list |
Show the Git commit history for the backup repository. |
fuxi apply |
Fetch and pull the given backup, then copy the stored files back to their original locations. --dryrun prints the actions without making changes. |
License
This project is licensed under the AGPLv3
