👉 A CLI to manage your Dotfiles built with Deno 2 and Cliffy inspired by GNU Stow
demo.mov
curl -fsSL https://raw.githubusercontent.com/arthurmialon/dot/main/install.sh | bash
Dot CLI automatically creates symlinks for you.
Setup your own dotfiles repository and manage it with this CLI. You can build a simple structure with packages and files.
Examples of structure:
# Dotfiles repository
├── aws (package)
│ └── .aws
│ ├── cli
│ │ └── alias
│ ├── config
├── brew (package)
│ └── Brewfile
├── git (package)
│ ├── .gitconfig
│ └── .gitignore
├── npm (package)
│ └── .npmrc
├── starship (package)
│ └── .config
│ └── starship.toml
├── vim (package)
│ └── .vimrc
├── zed (package)
│ └── .config
│ └── zed
│ ├── keymap.json
│ └── settings.json
└── zsh (package)
├── .config
│ └── zsh
│ └── functions.zsh
└── .zshrc
Dot CLI automatically symlinked all files to your $HOME directory (or any
directory you want to target). It follows the structure inside each package.
Example for the ZSH package:
# Symlinked files
~/.zshrc -> dotfiles/zsh/.zshrc
~/.config/zsh/functions.zsh -> dotfiles/zsh/.config/zsh/functions.zsh- Link all your dotfiles automatically to any directory (default is
$HOME) - Unlink your dotfiles with a simple command so you can easily switch between configurations
- Add new files or folders to your dotfiles from local directory
- Quickly open editor to edit your dotfiles
Remote repository:
dot init [email protected]:<USERNAME>/dotfiles.gitLocal repository
dot initdot init setup the dotfiles location and the target (default:
$HOME).
The Dot CLI will ask you to set the paths to your dotfiles repository and the target directory. Then it reads the packages and files from your dotfiles repository and link them to the target directory.
You can use the --help flag everywhere to get more information about the
command.
Basic setup. Ask you to set locations to your dotfiles and the target location.
dot initWith arguments: You can clone your dotfiles repository and link all packages.
dot init [email protected]:ArthurMialon/dotfiles.gitLink all packages to your $HOME directory (can be update with configuration).
Basic:
dot linkAliases:
dot l
Options:
-v, --verboseis used to show more information about the process.-f, --forceto avoid prompt
With arguments: Link only a specific pacakge.
dot link zshSince dot link create symlink for all your pacakges, you can use dot unlink
to remove the symlinks.
Basic:
dot unlinkAliases:
dot udot remove
Options:
-v, --verboseis used to show more information about the process.-f, --forceto avoid prompt
With arguments: Link only a specific pacakge.
dot unlink zshShow the current configuration.
Basic:
dot configEdit the current configuration (source and target).
dot config editAdd new files or folder to your dotfiles. It adds the requested files to your packages and update to symlink.
Basic:
dot add .Add a the current folder to a specific package (if not exist, the package will be created).
dot add . zshAdd a specific to a specific package (if not exist, the package will be created).
dot add .zshrc zshOpen the dotfiles repository in your default editor.
Basic:
dot editAliases:
dot open
Check status of your dotfiles repository.
Basic:
dot statusPush updates to your remote dotfiles repository.
Basic:
dot pushPull updates from your remote dotfiles repository and link files.
Basic:
dot pullYou can upgrade the Dot CLI with the following command.
dot upgradeCreate a .dotignore file to avoid link some files or folders. It follows the
same rules as .gitignore. By default it always ignore the .git folder and
the .dotignore file.
# Example
# Ignore all files with the extension .md
*.md
# Ignore the script
scripts/