Skip to content
bspwmctlPublic

About

Documentation and usage guides for bspwmctl

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

51 Commits

Folders and files

Repository files navigation

bspwmctl

Version Status License

bspwmctl is an automated installer and manager designed to deploy a fully configured bspwm desktop environment without the manual hassle.

!> WARNING: PRE-ALPHA SOFTWARE
This version (v0.1.0) is a Pre-Alpha release. It is intended for testing purposes on fresh installations.


🧩 What is bspwm?

For those new to the ecosystem, bspwm (Binary Space Partitioning Window Manager) is a tiling window manager for X11.

Unlike traditional desktop environments (like GNOME or KDE), bspwm:

  • Tiles windows automatically: Instead of overlapping windows, it splits the screen so you can see everything at once.
  • Is extremely lightweight: Uses minimal RAM and CPU resources.
  • Is controlled by scripts: Its configuration is handled by a simple shell script, making it incredibly hackable and flexible.

bspwmctl bridges the gap between a fresh Linux install and a fully functional, beautiful bspwm environment.

✨ Features (v0.1.0)

  • 🐧 Multi-distribution support: Currently testing on Debian, Arch, and Fedora.
  • 📦 Smart Installation: Detects your package manager and installs dependencies automatically.
  • 🎨 Dotfiles Injection: Deploys pre-configured setups for:
    • bspwm (Window Manager)
    • sxhkd (Hotkeys)
    • polybar (Status bar)
    • picom (Compositor/Transparency)
    • kitty (Terminal emulator)
  • 🚀 CLI Based: Simple command-line interface (future versions will include a compiled binary).

🚀 Quick Start

Remember: Do not use sudo.

# 1. Clone the repository
git clone [https://github.com/bspwmctl/bspwmctl.git](https://github.com/bspwmctl/bspwmctl.git)
cd bspwmctl

# 2. Make the script executable
chmod +x bspwmctl

# 3. Install (Default / Minimal mode)
./bspwmctl install

# Option: Install with standard packages
./bspwmctl install --standard

Next Steps

🤝 Contributing

Found a bug? Want to add support for your distro? Check out the Contributing Guide or open an Issues.

📄 License

bspwmctl is released under the MIT License.

About

Documentation and usage guides for bspwmctl

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Sponsor this project

Contributors

Languages