Skip to content

INSTALLATION.md

Latest commit

 

History

History
76 lines (55 loc) · 1.54 KB

INSTALLATION.md

File metadata and controls

76 lines (55 loc) · 1.54 KB

Installation Guide - keybind-audit

System Requirements

  • Python 3.8+
  • Linux (tested on Ubuntu, Fedora, Arch, Omarchy)
  • Optional: gsettings (GNOME) for dconf scanning

Install from Source

# Clone the repo
git clone https://github.com/hoornet/keybind-audit
cd keybind-audit

# Option 1: Install for current user (recommended)
pip install --user -e .

# Option 2: Install system-wide (requires sudo)
sudo pip install -e .

# Option 3: Run directly without installing
python3 keybind_audit.py

Verify Installation

keybind-audit --help

If using --user install, make sure ~/.local/bin is in your PATH:

export PATH="$PATH:$HOME/.local/bin"

Optional Dependencies

For dconf scanning (GNOME):

# Ubuntu/Debian
sudo apt install dconf-cli

# Fedora
sudo dnf install dconf

# Arch
sudo pacman -S dconf

Uninstall

pip uninstall keybind-audit
# or if installed system-wide:
sudo pip uninstall keybind-audit

Troubleshooting

"command not found: keybind-audit"

  • Make sure ~/.local/bin is in your PATH
  • Or run as: python3 keybind_audit.py

"ModuleNotFoundError: No module named 'keybind_audit'"

  • Make sure you're in the keybind-audit directory
  • Or install the package: pip install -e .

No keybindings found

  • The tool only scans existing config files
  • Create a config file (e.g., ~/.tmux.conf) with keybindings
  • Or run with --verbose to see what it's scanning

gsettings errors

  • Install dconf-cli (see Optional Dependencies above)
  • Or ignore if you don't use GNOME