KeyWiz

Your Magical Keyboard Shortcut Assistant

Features • Installation • Usage • Contributing • Support

---

KeyWiz in action - showing Windsurf IDE shortcuts

🎯 Overview

KeyWiz is your magical companion for mastering keyboard shortcuts in Windows. This sleek, always-on-top application dynamically displays shortcuts for your active application, helping you become a keyboard wizard!

Perfect for:

• 💻 Developers seeking to boost productivity
• 🎨 Designers switching between creative tools
• 🚀 Power users optimizing their workflow
• 🎮 Anyone wanting to level up their keyboard skills

✨ Features

🔄 Dynamic Detection Real-time shortcut updates Application-aware display Instant context switching	🎨 Modern Design Sleek, frameless window Minimal visual footprint Customizable appearance
📌 Smart Positioning Windows Snap support Left/right screen docking Always-on-top display	🛠 Extensible Custom shortcut support Easy markdown format Growing shortcut database

🚀 Installation

Prerequisites

• Windows 10/11
• Python 3.8+
• pip package manager

Quick Start

1. Clone the repository:

git clone https://github.com/cloudwerxlab/keywiz.git
cd keywiz

2. Create and activate virtual environment:

# Create virtual environment
python -m venv .venv

# Activate virtual environment (Windows)
.venv\Scripts\activate

# Activate virtual environment (Windows PowerShell)
.venv\Scripts\Activate.ps1

3. Install required dependencies:

pip install -r requirements.txt

4. Run the application:

python keywhiz_app.py

Building from Source

# Ensure you're in the virtual environment
.venv\Scripts\activate

# Install PyInstaller if not installed
pip install pyinstaller

# Create executable
pyinstaller KeyWhiz.spec

The executable will be created in the dist directory.

📦 Dependencies

Package	Purpose
PyQt5	Modern GUI framework
psutil	Process management
pywin32	Windows API integration
markdown2	Shortcut file parsing

💡 Usage

Basic Controls

• Toggle Position: Click and drag to either screen edge
• Show/Hide: Double-click the title bar
• Exit: Right-click → Exit

Adding Custom Shortcuts

1. Create a markdown file in shortcuts/
2. Name it after your application (e.g., chrome.md)
3. Format your shortcuts:

# Chrome Shortcuts

## Navigation
- `Ctrl+T`: New tab
- `Ctrl+W`: Close tab
- `Alt+Left`: Back

🛠 Development

Project Structure

keywiz/
├── 📜 keywhiz_app.py    # Main application
├── 📂 shortcuts/        # Shortcut definitions
├── 🎨 icons/           # Application assets
├── 📋 requirements.txt  # Dependencies
└── 📄 LICENSE          # MIT license

Customization Options

# In keywhiz_app.py
WINDOW_WIDTH = 300       # Adjust sidebar width
ACCENT_COLOR = "#4a9eff" # Change theme color
FONT_FAMILY = "Segoe UI" # Customize typography

🤝 Contributing

We love your input! Check out our Contributing Guide for ways to get started. Here's how you can help:

1. 🍴 Fork the repository
2. 🌿 Create a feature branch (git checkout -b feature/AmazingFeature)
3. 💾 Commit changes (git commit -m 'Add AmazingFeature')
4. 📤 Push to branch (git push origin feature/AmazingFeature)
5. 📫 Open a Pull Request

📫 Support

• 🐛 Report bugs
• 💡 Request features
• 🤔 Ask questions
• 📧 Email: cloudwerxlaboratories@gmail.com
• 🌐 Website: cloudwerxlab.com

📄 License

KeyWiz is MIT licensed, as found in the LICENSE file.

---

Made with ❤️ by CLOUDWERX LAB

If KeyWiz helps your productivity, consider giving it a ⭐️!