Skip to content

Mechazawa/High-Beam

Repository files navigation

High Beam

CI Plugins

A keyboard launcher in the Spotlight / Alfred / Raycast / Ulauncher class. Native Rust, single-file JS plugins, no npm at runtime.

Pre-release.

Install

cargo install --path .

Packaged builds (.app, .dmg, .deb, .pacman, .rpm, tarball) via just bundle / just bundle-linux. See docs/distribution.md.

macOS post-install:

xattr -dr com.apple.quarantine /Applications/HighBeam.app

(self-signed; the command strips the download quarantine.)

Use

  • macOS: Shift+Space to open. Configurable in Settings → Global.
  • Linux: bind highbeam --open to a hotkey in your WM/DE. See docs/platform.md for GNOME / KDE / sway / Hyprland snippets.

Type to query, ↑/↓ to highlight, Enter to invoke, Esc to dismiss. The Core built-in handles settings, install <manifest-url>, reload, update, shutdown, sleep, lock, etc.

Plugins

Single-directory manifest.json + plugin.js. Reference plugins under plugins/; bundled ones get seeded on first launch. Authoring guide: docs/plugin-authoring.md. API reference: docs/sdk-reference.md. Dynamic, stateful screens: docs/views.md.

Theming

Drop a <name>.toml in the themes/ folder in the config dir and pick it in Settings → Global → Theme; default is the bundled yosemite-spotlight. Token reference: docs/theming.md.

Internals

docs/internals.md — stack rationale, threading model, cancellation contract, Slint gotchas. src/lib.rs is the module map.

License

GPL-3.0-or-later. See LICENSE. Uses Slint under its GPLv3 option.

About

MacOS Spotlight alternative

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors