Dotfiles
📦 Simple yet powerful cross-platform dotfiles. Easily setup the intuitive Ubuntu Desktop, Linux server (Ubuntu/Fedora/Arch Linux), macOS, and Termux.
Install / Use
/learn @irichu/DotfilesREADME
English / [Japanese(日本語)]
<!-- Logo --> <p align="center"> <a href="https://github.com/irichu/dotfiles"> <img src="https://github.com/user-attachments/assets/44037309-be0e-4cba-88a5-730dcac8cbda" alt="Dotfiles logo image" height="40" > </a> </p> <!-- Badges --> <div align="center"> <p style="width: 80%"> <!-- CODE SIZE --> <img src="https://img.shields.io/github/languages/code-size/irichu/dotfiles?style=for-the-badge&logo=github&color=%2377aaff" alt="GitHub code size in bytes" height="22" > <!-- Tokei LOC --> <a href="https://github.com/irichu/dotfiles"> <img src="https://www.aschey.tech/tokei/github/irichu/dotfiles?style=for-the-badge&logo=https://simpleicons.org/icons/github.svg&color=%2377aaff" alt="Tokei total line" height="22" > </a> <!-- CREATED AT --> <img src="https://img.shields.io/github/created-at/irichu/dotfiles?style=for-the-badge&logo=github&color=%239988FF" alt="GitHub Created At" height="22" > <!-- LAST COMMIT --> <img src="https://img.shields.io/github/last-commit/irichu/dotfiles?style=for-the-badge&logo=github&color=%239988FF" alt="GitHub last commit" height="22" > <!-- LICENSE --> <img src="https://img.shields.io/github/license/irichu/dotfiles?style=for-the-badge&logo=github&color=%2355ff99" alt="GitHub License" height="22" > <!-- RELEASE VERSION --> <img src="https://img.shields.io/github/v/release/irichu/dotfiles?category=lines&style=for-the-badge&logo=github&color=%2355ff99" alt="GitHub Release" height="22" > <!-- STARS --> <img src="https://img.shields.io/github/stars/irichu/dotfiles?style=for-the-badge&logo=github&color=%23ffdd33" alt="GitHub Repo stars" height="22" > </p> </div>Dotfiles for Linux and Termux
🎉 Welcome
Welcome to my dotfiles. [This GitHub repository] helps easily set up a fast and intuitive desktop and terminal environment. This setup installs Zsh with starship prompt, tmux, Neovim, and Golang and Rust-based command-line tools that starts and operates quickly. I would be delighted if even a single element leads to a new discovery for you. Grateful that you found this project and took a look!
<img src="https://irichu.github.io/dotfiles/assets/images/irichu-dotfiles-ubuntu-desktop-terminal.png" width="800" alt="irichu dotfiles ubuntu desktop terminal">
<img src="https://irichu.github.io/dotfiles/assets/images/irichu-dotfiles-ubuntu-desktop-guiapps.png" width="800" alt="irichu dotfiles ubuntu desktop vscode nautilus">
🚀 Installation
1. Download and Install dotfiles
Use the following curl, wget, or git command:
2. Automatic package installation
[!IMPORTANT] On Ubuntu Desktop, automatic setup is possible
--ubuntu-desktop.<br> On Ubuntu, fast installation is possible with--aptor--snap.<br> On Linux (Ubuntu/Fedora/Arch Linux) or macOS, automatic setup is available using--brew.<br> On Termux, setup can be done using--pkg.
[!NOTE] On Linux or macOS,
sudoaccess is required for installation.<br> This is needed to install Homebrew itself with--brewand to install packages using--apt,--snap.<br>
Install all components using your preferred package manager:
dots install [--apt|--brew|--snap|--pkg]
Examples:
- To install on Ubuntu Desktop (New):
dots install --ubuntu-desktop
- To use brew on Linux or macOS:
dots install --brew
- To use pkg on Termux:
dots install --pkg
[!NOTE] If
dotscommand not found,<br> please run the following command to add the path to ~/.local/bin<br> or use~/.local/bin/dotscommand directly during the installation process
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
3. Start
Relogin or execute the following command:
exec -l $(which zsh)
[!NOTE] In a login shell, such as an SSH session, Tmux will start automatically.<br> If a Tmux server is already running, you can select a session to connect to.
✅ Supported OS
- Linux 🐧
- Ubuntu 22.04 and newer (recommended)
- Arch Linux
- Fedora
- Mac 🍎
- macOS
- Android 📱
- The latest version of Termux
[!WARNING] The Google Play Store version of Termux may not work properly with some commands.<br> It is recommended to install it from [F-Droid].
<img src="https://irichu.github.io/dotfiles/assets/images/irichu-dotfiles-main-screenshot.png" width="800" alt="irichu dotfiles main screenshot">
<!-- > [!Note] > Some behavior may vary slightly between platforms due to system differences.<br> > -->✨ Features
- Desktop
- Themes
- Icons: [Flat-Remix-Blue-Dark]
- Shell: [Marble-blue-dark]
- GTK: [Flat-Remix-GTK-Blue-Dark-Solid]
- Gnome Extensions
- Blur my Shell
- Just Perfection
- Space Bar
- Tactile
- etc.
- Themes
- Terminal
- Shell: Zsh with the [starship] prompt
- Editor: [Neovim] configured via [LazyVim]
- Terminal Multiplexers: [tmux] for session management, [zellij] for workspace management
- TUI File Managers: [broot] for efficient navigation, [yazi] for rapid file access
- Terminal Emulator: [Alacritty] for performance, [Termux] for Android environments
🐳 Docker
You can build and enter a container with the following commands.
cd ~/.local/share/dotfiles-main
docker compose command:
docker compose up -d --build
docker compose exec dotfiles zsh
<details>
<summary>docker command</summary>
<pre>
<code class="language-bash">docker build -t dotfiles-img .
docker run -it -d --name dotfiles-con dotfiles-img
docker exec -it dotfiles-con /bin/zsh
</code>
</pre>
</details>
<br>
In container, install apt packages
dots install --apt
or install Homebrew with following command.
dots install --brew
📗 Basic commands
<details open=""> <summary>Get/Set the current tmux theme</summary> <pre> <code class="language-bash"># get theme dots tmux-theme</code> </pre> <pre> <code class="language-bash"># set theme dots set-tmux-theme # example dots set-tmux-theme 4 # Set by number dots set-tmux-theme developer-mono # Set by name</code> </pre>Available themes:
<details open=""> <summary>Developer (purple base)</summary>- developer
- developer-textcolored
- developer-colorful
- developer-mono
- dark-turquoise
- dark-turquoise-textcolored
- dark-turquoise-colorful
- dark-turquoise-mono
- dark-orange
- dark-orange-textcolored
- dark-orange-colorful
- dark-orange-mono
- dark-skyblue
<img src="https://github.com/user-attachments/assets/2b97e6ef-9510-40b0-8
