Your modular, always-on-top desktop utility sidebar.
翻譯準備中
正在載入完整 README。
檢視完整 README ↗KoBar is a frameless, transparent, always-on-top bar that docks to the edge of your screen. It has a built-in notes panel, and everything else (clipboard manager, media controls, screenshots, calculator and more) is added as plugins, so you install only the tools you want. It is built with Electron and React. Website: kobar.org.
Plugins are installed from the plugin store in Settings. These 13 are maintained by the KoBar project.
| Plugin | What it does |
|---|---|
| AI Hub | AI assistant for several providers, including local models |
| Clipboard Manager | Multi-slot sequential clipboard with image support |
| Snippet Vault | Saved text templates, code snippets and prompts |
| Screenshot Studio | Region and full-screen capture with an annotation editor |
| KoPlayer | System media controls with album art |
| KoCalendar | Calendar and event alerts |
| Focus Mode | Timer with ambient melodies |
| Calculator | Floating scientific calculator with history |
| Color Picker | Pick a colour from the screen (HEX, RGB, HSL) |
| KoBox | Drag-and-drop file staging area |
| PinWindowToTop | Keep another application's window on top |
| Shortcuts |
Google Calendar (Settings > Integrations) is a read-only integration and is off by default. It currently works only in the development environment: it needs a local Google OAuth client file that is not part of the packaged app.
Requirements: Node.js ^24.21.0 (engines in package.json; .nvmrc pins 24.21.0, the Node bundled in Electron 44.7) and npm.
git clone https://github.com/Kobar-Project/KoBar.git
cd KoBar
npm install
npm run dev
| Script | Purpose |
|---|---|
npm run dev | Vite and Electron in development mode |
npm test | Unit tests (Vitest) |
npm run test:e2e | End-to-end tests (Playwright) |
npm run lint | ESLint |
npm run build | Type-check and build (no packaging) |
npm run kobar-build | Build manager for packaging |
npm run dist:store / dist:direct:win / dist:mac | Package the Store, direct Windows or macOS build |
Project map:
electron/ Main process, preload scripts, workers
src/ Renderer: App, sidebar, notes, settings, backup, store, i18n, theme
shared/ Types and helpers shared by main and renderer
tests/ Unit and end-to-end tests
tools/ Build and packaging scripts
for-agents/ Guides for AI coding agents
build/ App icons and packaging resources
Assets/ Images, melodies and note templates
See CONTRIBUTING.md before opening a pull request and SECURITY.md to report a vulnerability.
Plugins are plain JavaScript that run in the app's renderer. The current (v1) API is five globals:
window.React and window.ReactDOMwindow.useAppStore: the app's Zustand storewindow.api: the preload bridge to the main processwindow.KoBarExtensions: registers buttons, panels and settingsStart with for-agents/kobar-plugin-developer/SKILL.md: the rules the host enforces and a complete working plugin. Its references/ folder has the full window.api reference, host behaviour (panels, theme, storage, permissions), manifest and publishing rules, and platform notes.
Plugins have full access to the app window. Installed plugins are not sandboxed, so install only plugins you trust.
The kobar and kobox prefixes are reserved for KoBar and its official plugins. Backup restore treats localStorage keys (and plugin ids) that start with them, case-insensitively, as belonging to KoBar, so a third-party plugin cannot claim them. Prefix your keys with your own plugin id.
A new plugin API (v2) is planned for KoBar 2.0. The v1 API will be removed then.
To list a plugin in the store: add a manifest.json (or kobar.json) to the repository root, publish a GitHub Release with the plugin .zip, then open a pull request that adds Username/RepositoryName to plugins.json in kobar-plugins-registry. Listing is not a security review.
for-agents/ holds guides for coding agents: the plugin API (kobar-plugin-developer) and the current design rules (kobar-ui-ux-designer). To test a plugin from source, create a git-ignored pluginsPlayground/ folder at the repository root; an unpackaged build (npm run dev) loads plugins from it. See section 6 of manifest-and-publishing.md.
No sponsors at the moment. Would you like to sponsor KoBar? Write to [email protected].
Made by Ekrem EDALI. Contact: [email protected].
MIT. See LICENSE.md.
| Application launcher and shortcut manager |
| ToDo List | Small task list with priorities |