windot
v0.1.1
Published
Windots setup and private distribution CLI for Windows environment configuration.
Maintainers
Readme
🪟 Windots
A premium Windows configuration project encompassing tiling window management, system bars, and advanced enhancements.
🚀 Overview
Windots is a curated collection of configuration files for a highly productive and aesthetic Windows environment. It integrates several powerful tools to transform the Windows experience into something more reminiscent of a high-end tiling window manager setup.
⚡ Quick Start
Node CLI
Install Node.js LTS first:
winget install OpenJS.NodeJS.LTSInstall dependencies and run the CLI from this repo:
npm install
npm run doctor
npm run setup:dry-runLocal executable usage:
node .\bin\windots.js --help
node .\bin\windots.js doctor --json
node .\bin\windots.js setup --dry-run --json
node .\bin\windots.js setupPublished npm package usage:
npm install -g windot
windot --help
windot doctor
windot setup
windot auth --json
windot repo list --json
windot repo install windots --dry-run --jsonThe Node CLI is the distribution entrypoint. The package name is windot. The npm package ships CLI code only; private configs stay in the private Windots GitHub repo and are fetched through GitHub CLI authentication during windot setup.
Current limitation: font installation still uses the PowerShell installer fallback until Node setup parity is complete.
PowerShell Installer
The PowerShell installer remains in the private repo as a legacy fallback. New installs should use:
npm install -g windot
windot setupLegacy direct script usage from a private repo checkout:
powershell -ExecutionPolicy Bypass -File .\install.ps1Or use the dedicated TUI launcher:
powershell -ExecutionPolicy Bypass -File .\install_tui.ps1The script will:
- Request Administrator privileges (needed for symlinks & font installation)
- Install/check Git and GitHub CLI
- Authenticate with GitHub CLI and clone/pull this private repo
- Prompt for optional app installs/updates (GlazeWM, YASB, whkd, Windhawk)
- Download & install JetBrains Mono Nerd Font, Inter, and Python/YASB dependencies
- Prompt before applying configs and backing up existing files
Idempotent: Safe to run multiple times. Existing configs are backed up to timestamped
.bak-*paths before overwriting.
CLI Reference
windot --help
windot doctor
windot doctor --json
windot setup
windot setup --dry-run --json
windot auth --json
windot repo list --json
windot repo install windots --dry-run --jsonRelease and migration notes:
🛠️ Components
📐 GlazeWM
- Type: Tiling Window Manager for Windows.
- Config:
config.yaml - Focus: Custom tiling rules, gaps, and workspace management.
🚥 YASB (Yet Another Status Bar)
- Type: Highly customizable status bar.
- Components: Includes volume widgets, system tray management, and dynamic styles.
- Key Files:
config.yaml,styles.css.
⚡ whkd
- Type: Hotkey daemon for Windows.
- Config:
whkdrc - Focus: Global keybindings for GlazeWM and application launching.
🦅 Windhawk
- Type: The professional's toolkit for Windows customization.
- Content: Organized subfolders for each active mod and the
userprofile.json. - Note: The installer stages exported mod settings in
C:\ProgramData\Windhawk\WindotsModSettings; import them through Windhawk's Mod > Advanced settings UI. - Mods:
windows-11-taskbar-stylerexplorer-details-better-file-sizeschrome-wheel-scroll-tabswindows-11-start-menu-stylerwindows-11-notification-center-stylerwindows-11-file-explorer-styler
📂 Project Structure
Windots/
├── bin/ # npm executable entrypoint
├── src/cli/ # Node CLI foundation
├── test/ # Node CLI tests
├── glazewm/ # GlazeWM configuration
├── yasb/ # YASB configuration and scripts
├── whkd/ # Hotkey configurations
├── windhawk/ # Windhawk mods and profile
└── install.ps1 # Automated setup script🎨 Aesthetic Design
This setup utilizes a refined color palette (Catppuccin-inspired) with a focus on:
- Glassmorphism: Subtle transparency and blur effects.
- Typography: Modern, legible fonts (Inter/JetBrains Mono).
- Efficiency: Minimalist UI with keyboard-centric controls.
Created with ❤️ by DAT
