Installation

📦 Installation

KFtray is available for macOS and Linux users via Homebrew, and directly from the GitHub releases page for other systems. Here's how you can get started:

For macOS

brew tap hcavarsan/kftray
brew install --HEAD kftray

For Linux

brew tap hcavarsan/kftray
brew install kftray-linux

Please check the caveats section for global app creation instructions after installation.

Linux Note: due to GTK limitations, it is necessary to install and enable the GNOME Shell extension for AppIndicator support to kftray works. See here: https://extensions.gnome.org/extension/615/appindicator-support/

For other systems, visit the GitHub releases page for downloadable binaries.

Building from Source

Requirements

• Node.js and pnpm or yarn for building the frontend.
• Rust for building the backend.

To compile kftray, these steps should be followed:

1. Clone the repository:

   git clone https://github.com/hcavarsan/kftray.git
   

   Copy to clipboard
2. Navigate to the cloned directory:

   cd kftray
   

   Copy to clipboard
3. Install dependencies:

   pnpm install
   

   Copy to clipboard
4. Launch the application in development mode:

   pnpm run tauri dev
   

   Copy to clipboard