A collection of configuration files and setup scripts to create a cozy, efficient, and aesthetically pleasing terminal environment.
- Shell: Zsh because bash is what your grandpa uses.
- Prompt: Starship cross-shell prompt customized with the Catppuccin Macchiato palette.
- Plugins:
zsh-autosuggestions: Fish-like autosuggestions for Zsh.zsh-syntax-highlighting: Syntax highlighting for commands as you type.
- Theme: Consistent Catppuccin theming across shell and terminal. Subject to change.
- Management: Uses GNU Stow for easy dotfile symlinking.
You can install these dotfiles using the automated Python script or by following the manual steps below.
This automated script handles dependencies, backups, and symlinking.
-
Clone the repository:
git clone [https://github.com/austryx/dotfiles.git](https://github.com/austryx/dotfiles.git) ~/dotfiles cd ~/dotfiles
-
Run the installer:
python3 install.py
If you prefer to do things yourself or don't have Python installed, follow these steps.
-
Install Dependencies: You will need
git,stow,zsh, andcurlinstalled via your system's package manager (e.g.,apt,pacman,brew).You also need to install Starship:
curl -sS [https://starship.rs/install.sh](https://starship.rs/install.sh) | sh -
Clone the Repository:
git clone [https://github.com/austryx/dotfiles.git](https://github.com/austryx/dotfiles.git) ~/dotfiles cd ~/dotfiles
-
Update Submodules: This downloads the Zsh plugins and themes.
git submodule update --init --recursive
-
Stow Configurations: Use GNU Stow to symlink the configuration folders to your home directory. The
--adoptflag allows Stow to overwrite existing files if necessary.stow --adopt -v -t ~ zsh starship wallpapersNote: This will link
.zshrc,.config/starship.toml, and your wallpapers. -
Change Default Shell: Set Zsh as your default shell.
chsh -s $(which zsh) -
Restart: Log out and back in, or restart your terminal to see the changes.
| Component | Description | Location |
|---|---|---|
| Zsh | Shell configuration, plugins, and environment variables. | zsh/.zshrc |
| Starship | High-performance, customizable prompt. | starship/.config/starship.toml |
| Wallpapers | A collection of wallpapers to match the aesthetic. | wallpapers/Pictures/ |
- Colors: The primary color scheme is Catppuccin Macchiato. You can adjust colors in
starship/.config/starship.toml. - Shell: To add more Zsh plugins, update the
.gitmodulesfile or manually clone them intozsh/.config/zsh/plugins/.
To update your dotfiles and pull the latest changes from the repository (including submodules):
cd ~/dotfiles
git pull
git submodule update --init --recursive
# Re-run stow to link any new files
stow --adopt -v -t ~ zsh starship wallpapers