https://github.com/cloudwerx-dev/keywiz
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!
https://github.com/cloudwerx-dev/keywiz
Last synced: about 2 months ago
JSON representation
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!
- Host: GitHub
- URL: https://github.com/cloudwerx-dev/keywiz
- Owner: CLOUDWERX-DEV
- License: mit
- Created: 2024-12-21T08:59:03.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-12-21T09:33:22.000Z (5 months ago)
- Last Synced: 2025-02-13T16:44:34.022Z (4 months ago)
- Language: HTML
- Homepage:
- Size: 57.9 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KeyWiz
#### Your Magical Keyboard Shortcut Assistant
[](https://opensource.org/licenses/MIT)
[](https://www.python.org/downloads/)
[](https://www.microsoft.com/windows)
[](http://makeapullrequest.com)
[Features](#-features) • [Installation](#-installation) • [Usage](#-usage) • [Contributing](#-contributing) • [Support](#-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:
```bash
git clone https://github.com/cloudwerxlab/keywiz.git
cd keywiz
```
2. Create and activate virtual environment:
```bash
# 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:
```bash
pip install -r requirements.txt
```
4. Run the application:
```bash
python keywhiz_app.py
```
### Building from Source
```bash
# 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:
```markdown
# 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
```python
# 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](CONTRIBUTING.md) 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](https://github.com/cloudwerxlab/keywiz/issues)
- 💡 [Request features](https://github.com/cloudwerxlab/keywiz/issues)
- 🤔 [Ask questions](https://github.com/cloudwerxlab/keywiz/discussions)
- 📧 Email: [[email protected]](mailto:[email protected])
- 🌐 Website: [cloudwerxlab.com](https://cloudwerxlab.com)
## 📄 License
KeyWiz is MIT licensed, as found in the [LICENSE](./LICENSE) file.
---
### Made with ❤️ by CLOUDWERX LAB
If KeyWiz helps your productivity, consider giving it a ⭐️!