Skip to content

Installation & Getting Started

Jump to bottom
Ekrem EDALI edited this page May 20, 2026 · 1 revision

Welcome to KoBar! Whether you just want to use the application to boost your productivity, or you want to dive into the codebase and contribute, this guide has you covered.

📥 For Users: Downloading & Installing

KoBar is currently optimized for Windows (10/11), with macOS support under active development. You can download KoBar in two ways:

1. Microsoft Store (Recommended for Windows)

The easiest and most seamless way to get KoBar on Windows is through the Microsoft Store. This ensures automatic updates and a clean installation.

2. Standalone Download (GitHub Releases)

If you prefer not to use the Microsoft Store, or if you are testing the macOS versions, you can download the application directly from our GitHub Releases page.

  • Go to the KoBar Releases Page.
  • Windows: Download the .exe installer.
  • macOS: Download the .dmg or .zip file (Note: macOS features are currently limited).

🚀 First Launch & Basic Configuration

When you launch KoBar for the first time, you'll be greeted by its floating interface.

Edge Docking

By default, KoBar behaves as an always-on-top sidebar.

  • You can drag the top handle of KoBar to move it around.
  • Docking: Drag KoBar to the extreme left or right edge of your screen. It will automatically detect the edge and snap into place, behaving like a true sidebar.
  • Multi-Monitor Support: KoBar seamlessly detects edges across multiple displays, allowing you to dock it on the edge of any monitor.

Mini Mode

Need to save screen real estate?

  • Click the collapse/minimize button at the top of the sidebar.
  • KoBar will shrink into a "Mini Mode" (a floating eye icon) that you can drag anywhere on the screen.
  • Click the eye icon to restore the full sidebar instantly.

👨‍💻 For Developers: Source Code Setup

If you want to contribute, modify, or build KoBar from source, follow these steps:

Prerequisites

Before you begin, ensure you have the following installed on your machine:

  • Node.js (Version 18 or higher recommended)
  • npm (Version 9 or higher)
  • Git

Clone and Install

  1. Clone the repository: 
    git clone https://github.com/eedali/KoBar.git
cd KoBar
  2. Install dependencies: 
    npm install

Running in Development Mode

To start the application with hot-reloading (both frontend and Electron main process):

npm run dev

What this does: It concurrently runs the Vite dev server for the React frontend, compiles the Electron TypeScript files in watch mode, and launches the Electron application once ready.

Building for Production

To compile the TypeScript files and bundle the React frontend for production:

npm run build

Packaging Distribution Files

If you want to create the final executable (.exe) or AppX package for the Microsoft Store:

npm run kobar-build

Note: Make sure your kobar-settings.json and kobar-secrets.json (if any) are configured properly before packaging.

Next Step: Ready to supercharge your productivity? Check out Core Features: Productivity to learn about the Sequential Clipboard Manager, Rich Notes, and more!

Clone this wiki locally