https://github.com/jacquindev/windots
My Windows 11 dotfiles
https://github.com/jacquindev/windots
catppuccin clink clink-config dotfiles dotfiles-setup dotfiles-windows flow-launcher komorebi oh-my-posh powershell pwsh scoop vscode-settings wallpapers windots windows windows-11 windows-terminal yasb
Last synced: 6 months ago
JSON representation
My Windows 11 dotfiles
- Host: GitHub
- URL: https://github.com/jacquindev/windots
- Owner: jacquindev
- License: mit
- Created: 2024-11-06T10:46:17.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-03-29T04:59:24.000Z (7 months ago)
- Last Synced: 2025-03-29T05:23:58.174Z (7 months ago)
- Topics: catppuccin, clink, clink-config, dotfiles, dotfiles-setup, dotfiles-windows, flow-launcher, komorebi, oh-my-posh, powershell, pwsh, scoop, vscode-settings, wallpapers, windots, windows, windows-11, windows-terminal, yasb
- Language: PowerShell
- Homepage: https://github.com/jacquindev/windots/
- Size: 11.4 MB
- Stars: 20
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
> [!IMPORTANT]
> The below **screenshots** are taken on my main monitor, which has the **resolution of 3440x1440**.
> Configurations in this repository seem to work seamlessly on my **1920x1080** monitors as well.
## ⚠️ Disclaimer
Since I work with this repository everyday to maintain ***latest updates*** for my Windows machine, many apps or packages will be **add** / **remove** / **reconfigure** to fit my personal taste.
So, please keep in mind that:
- **This repository is under very active development.**
- You might expect bugs and breaking changes.
## ✨ Prerequisites
- **[Git for Windows](https://gitforwindows.org/)**
- **[PowerShell 7](https://github.com/PowerShell/PowerShell)**
***Highly Recommended:***
- **[Windows Terminal](https://aka.ms/terminal)** or **[Windows Terminal Preview](https://aka.ms/terminal-preview)**
🌆 Preview
- 2 status bar options: [Rainmeter](https://github.com/modkavartini/catppuccin/tree/main) / [Yasb](./config/config/yasb)
### Yasb's Catppuccin Statusbar
### Rainmeter's Catppuccin Statusbar
- Transparent File Explorer
### [ExplorerBlurMica](https://github.com/Maplespe/ExplorerBlurMica) + [Catppuccin Themes](https://www.deviantart.com/niivu/art/Catppuccin-for-Windows-11-1076249390)
🌷 Install
- Simply clone this repo to `your_location`
```bash
git clone https://github.com/jacquindev/windots.git your_location
cd `your_location`
```
- In your **elevated** PowerShell Terminal, run: `.\Setup.ps1`
```pwsh
. .\Setup.ps1
```
⁉️ Overriding Defaults
> [!IMPORTANT]
> Before running the `Setup.ps1` script, please check the **[appList.json](./appList.json)** file to **ADD/REMOVE** the apps you would like to install.
>
> VSCode Extensions:
> Edit the **[VSCode's extensions list](./extensions.list)** to **ADD/REMOVE** the extensions you would like to install.
😎 Clink Setup
- In your **`Command Prompt`** console, type:
```cmd
clink installscripts "your_location\clink\clink-custom"
clink installscripts "your_location\clink\clink-completions"
clink installscripts "your_location\clink\clink-gizmos"
clink installscripts "your_location\clink\more-clink-completions"
```
- Replace _`your_location`_ with full path to where you cloned this repository.
> [!NOTE]
> The [`clink-custom`](./clink/clink-custom/) directory contains Lua scripts to [extend `clink`](https://chrisant996.github.io/clink/clink.html#extending-clink) based on the programs you use. If you do not have the programs define in the scripts, they will not be activated.
>
> - custom prompt ➝ [`clink/clink-custom/prompt.lua`](./clink/clink-custom/prompt.lua).
> (Only one of the following should be set to `true`, otherwise `false`)
> - **`oh-my-posh`**: to enable, set *`local ohmyposh_enabled = true`*.
> - **`starship`**: to enable, set *`local starship_enabled = true`*.
> - `vfox` ➝ [`clink/clink-custom/vfox.lua`](./clink/clink-custom/vfox.lua)
> - `zoxide` ➝ [`clink/clink-custom/zoxide.lua`](./clink/clink-custom/zoxide.lua)
⛏ Setup Development Tools with MISE (mise-en-place)
Ensure that `mise` command available on your system (using `scoop install mise`)
```bash
# Enable experimental features:
mise settings experimental true
```
The below command with install latest LTS version of NodeJS, and also automatically install NPM global packages define in [`.default-npm-packages`](./config/home/.default-npm-packages)
```bash
# Install latest NodeJS LTS
mise use -g node@lts
```
For further information please visit: https://mise.jdx.dev.
🌟 Bootstrap WSL
WSL setup can be done automatically by using [Ansible](https://docs.ansible.com/ansible/latest/index.html). Any details can be found here: https://github.com/jacquindev/automated-wsl2-setup.
➝ WSL dotfiles are maintained in [this](https://github.com/jacquindev/dotfiles) repository: https://github.com/jacquindev/dotfiles.
⛏🧱 Extra Setup (optional)
Follow the below links to download and learn to how to setup:
🌈 Catppuccin Themes 🎨
🎸 Spicetify Setup 🎧
✨ Features
- 💫 All packages to install are listed in **[appList.json file](./appList.json)** - Easy to maintain!
- 🎨 Main theme [Catppuccin](https://github.com/catppuccin/catppuccin) for everything!
- 🎀 Minimal [Yasb](https://github.com/amnweb/yasb) status bar
- 💖 Beautiful **_[wallpapers](https://github.com/jacquindev/windots/tree/main/windows/walls#readme)_**, and [live wallpapers](./windows/walls/live-walls/) for [Lively Wallpapers](https://www.rocksdanister.com/lively/)
- 🪟 [Komorebi](./config/komorebi) config
- 🌸 All-In-One VSCode setup (**_[extensions list](./extensions.list)_**)
- ⚙️ [Rainmeter](./windows/rainmeter/) setup
- \>\_ Sleek [Windows Terminal config](./config/AppData/Local/Packages/Microsoft.WindowsTerminal_8wekyb3d8bbwe/LocalState/settings.json)
- 🌈 Oh-My-Posh [minimal theme](./dotposh/posh-zen.toml) (with Spotify status if playing)
- 🦄 **Super fast** PowerShell startup time _(load asynchronously)_ + [custom configurations & modules](./dotposh/)
- 🍄 Simple fastfetch configuration, which I copied from [scottmckendry's config](https://github.com/scottmckendry/Windots/tree/main/fastfetch)
- 🥂 Many [addons](#git-addons) for Git!
- 🐱 Use [MISE](https://mise.jdx.dev/) *(mise-en-place)* to manage [development tools](https://mise.jdx.dev/dev-tools/). Learn more about `mise` here: https://mise.jdx.dev/
🖥️ CLI/TUI Apps
| Entry | App |
| --------------------- | --------------------------------------------------------------------------------------------- |
| **Terminal Emulator** | [Windows Terminal](https://github.com/microsoft/terminal) [⚙️](./config/AppData/Local/Packages/Microsoft.WindowsTerminal_8wekyb3d8bbwe/LocalState/settings.json) |
| **File Explorer** | [yazi](https://github.com/sxyazi/yazi) [⚙️](./config/config/yazi/) |
| **Fuzzy File Finder** | [fzf](https://github.com/junegunn/fzf) |
| **System Monitor** | [btop](https://github.com/aristocratos/btop) |
| **System Fetch** | [fastfetch](https://github.com/fastfetch-cli/fastfetch) [⚙️](./config/AppData/Local/fastfetch/config.jsonc) |
| **Git TUI** | [lazygit](https://github.com/jesseduffield/lazygit) [⚙️](./config/AppData/Local/lazygit/config.yml) |
🌎 Replacement
| Entry | App |
| ----- | ------------------------------------------------------------------------- |
| cat | [bat](https://github.com/sharkdp/bat) [⚙️](./config/AppData/Roaming/bat/config) |
| cd | [zoxide](https://github.com/ajeetdsouza/zoxide) |
| ls | [eza](https://github.com/eza-community/eza) [⚙️](./config/eza/theme.yml) |
| find | [fd](https://github.com/sharkdp/fd) |
| grep | [ripgrep](https://github.com/sharkdp/ripgrep) |
🖱️ GUI Apps
| Entry | App |
| ---------------- | ---------------------------------------------- |
| **App Launcher** | [Flow Launcher](https://www.flowlauncher.com/) |
| **Music Player** | [Spotify](https://open.spotify.com/) |
📌 Git Addons
| Installer | Link | Description |
| --- | --- | --- |
| winget | **[GitHub Desktop](https://github.com/apps/desktop)** | Simple collaboration from your desktop.|
| winget | **[GitKraken Desktop](https://www.gitkraken.com/)** | Dev Tools that simplify & supercharge Git. |
| scoop | **[gh](https://github.com/cli/cli)** | Bring GitHub to the command line. |
| scoop | **[git-aliases](https://github.com/AGWA/git-crypt)** | Oh My Zsh's Git aliases for PowerShell. |
| scoop | **[git-crypt](https://github.com/AGWA/git-crypt)** | Transparent file encryption in Git. |
| scoop | **[git-filter-repo](https://github.com/newren/git-filter-repo)** | Quickly rewrite git repository history (filter-branch replacement). |
| scoop | **[git-lfs](https://git-lfs.com/)** | Improve then handling of large files. |
| scoop | **[git-sizer](https://github.com/github/git-sizer)** | Compute various size metrics for a Git repository. |
| scoop | **[gitleaks](https://github.com/gitleaks/gitleaks)** | Detect secrets like passwords, API keys, and tokens. |
| npm | **[commitizen](https://github.com/commitizen/cz-cli)** + **[cz-git](https://cz-git.qbb.sh/)** | Write better Git commits. |
| npm | **[git-open](https://github.com/paulirish/git-open)** | Open the GitHub page or website for a repository in your browser. |
| npm | **[git-recent](https://github.com/paulirish/git-recent)** | See your latest local git branches, formatted real fancy. |
| | **[git aliases](https://github.com/GitAlias/gitalias/blob/main/gitalias.txt)** | Include [git aliases](./config/config/gitaliases) for `git` command for faster version control. |
📝 Text Editor / Note Taking
- [Notepad++](https://notepad-plus-plus.org/)
- [Obsidian](https://obsidian.md/)
- [Visual Studio Code](https://code.visualstudio.com/) [⚙️](./config/AppData/Roaming/Code/User/settings.json)
🎉 Credits
Big thanks for those inspirations:
- [scottmckendry's Windots](https://github.com/scottmckendry/Windots)
- [ashish0kumar's windots](https://github.com/ashish0kumar/windots)
- [MattFTW's Dotfiles](https://github.com/Matt-FTW/dotfiles) - Most of my wallpapers are from here.
- [DevDrive PowerShell's Scripts](https://github.com/ran-dall/Dev-Drive) - I copied most of DevDrive's functions for PowerShell here.
👤 Author
- Name: **Jacquin Moon**
- Github: [@jacquindev](https://github.com/jacquindev)
- Email: jacquindev@outlook.com
📜 License
This repository is released under the [MIT License](https://github.com/jacquindev/windots/blob/main/LICENSE).
Feel free to use and modify these dotfiles to suit your needs.
## Show your support
Please give a ⭐️ if this project helped you!
