VibeMouse

(β˜… 58)

Mouse-side-button voice input for VibeCoding on Linux.

  • .gitignore
  • LICENSE
  • pyproject.toml
  • README.md
  • README.zh-CN.md
  • THIRD_PARTY_NOTICES.md

# Installation Guide

1. Get the code
git clone https://github.com/vimalinx/VibeMouse

Downloads the entire project code from GitHub to your computer.

cd VibeMouse

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
  • Python 3 Python is required to use pip.
sudo apt install -y python3-gi gir1.2-atspi-2.0 portaudio19-dev libsndfile1

Installs directly from the APT package repository (Debian/Ubuntu-based).

pip install -U pip

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
sudo pacman -Syu --needed python python-pip python-gobject portaudio libsndfile

Runs the Python script (or module).

python3 -m venv .venv

Runs the Python script (or module).

pip install -U pip

Installs the package published on PyPI directly β€” no need to clone the source.

pip install -e .

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation