base on A versatile application/command launcher for wayland. Built with rust and gtk4 <div align="center" style="text-align:center; border-radius:10px;"> <picture> <source media="(prefers-color-scheme: dark)" srcset="assets/logo-dark.svg"> <source media="(prefers-color-scheme: light)" srcset="assets/logo-light.svg"> <img alt="sherlock logo" height="250" src="assets/logo-light.svg"> </picture> [](https://discord.gg/AQ44g4Yp9q) <picture> <img alt="application screenshot" width="100%" style="border-radius: 10px;" src="assets/mockup.png"> </picture> </div> Sherlock is a lightweight and efficient application launcher built with Rust and GTK4. It allows you to quickly launch your favorite applications with a user-friendly interface, providing a fast and highly-configurable way to search, launch, and track application usage.. <br> ### Quick Links - [Documentation](https://github.com/Skxxtz/sherlock/tree/main/docs): Sherlocks documentation - [sherlock-wiki](https://github.com/Skxxtz/sherlock-wiki): allows you to search Wikipedia from within Sherlock using the `bulk_text` launcher. <br><br> > **🚨 Warning:** This app is/was created on **Arch Linux** with the **Hyprland** tiling window manager in mind. It may cause errors or won't function at all on other system configurations. --- ## Table of Contents - [Features](#features) - [Getting Started](#getting-started) - [Dependencies](#1-dependencies) - [Installation](#2-installation) - [Arch Linux](#arch-linux) - [From Source](#from-source) - [Debian](#build-debian-package) - [Nix Flake](#nix-flake) - [Post Installation](#3-post-installation) - [Config Setup](#config-setup) - [Keybind Setup](#keybind-setup) --- <br><br> ## Features ### 🔧 Style Customization - Fully customize the look and feel of the launcher. - Modify themes and visual elements to match your preferences ### 🛠️ Custom Commands - Define your own commands and extend the functionality of the launcher. - Add new features or workflows tailored to your specific needs. ### 🚀 Fallbacks - Configure fallback behaviours for various commands and operations. - Ensure a smooth experience even when certain commands fail or are unavailable. ### 🖼️ Application Aliases and Customization - Assign aliases to your applications for better looks and quicker access. - Assign custom icons to your applications for a personalized touch. - Hide apps that you don't use and don't want to clutter up your launcher. ### 🌐 Async Widget - Use the async widget to send API requests and display their responses directly in the launcher. - Great for integrating live data or external tools into your workflow. ### 📅 Teams Events Launcher - Use the Teams Event Launcher to easily join upcoming Microsoft Teams meetings ### 🔍 Category-Based Search - Type the launcher alias and spacebar to only search within a specific category of commands. - Categories are fully configurable, allowing you to customize search scopes. ### ⌨️ Shortcuts - Use shortcuts like ctrl + 4 to quickly launch a command or app without having to scroll. --- <br><br> ## Getting Started ### 1. Dependencies To run the Sherlock Launcher, ensure the following dependencies are installed: - `gtk4` - [Gtk4 Documentation](https://docs.gtk.org/gtk4/) - `gtk-4-layer-shell` - [Gtk4 Layer Shell](https://github.com/wmww/gtk4-layer-shell) - `dbus` - (Used to get currently playing song) - `openssl` - (Used for retrieving Spotify album art) - `libssl-dev` - `libsqlite3-dev` Additionally, if you're building from source, you will need: - `rust` - [How to install rust](https://www.rust-lang.org/tools/install) - `git` - [How to install git](https://github.com/git-guides/install-git) <br><br> ### 2. Installation #### <ins>Arch Linux</ins> If you're using Arch Linux, you can install the pre-built binary package with the following command: ```bash yay -S sherlock-launcher-bin ``` #### <ins>From Source</ins> To build Sherlock Launcher from source, follow these steps.<br> Make sure you have the necessary dependencies installed: - `rust` - [How to install rust](https://www.rust-lang.org/tools/install) - `git` - [How to install git](https://github.com/git-guides/install-git) - `gtk4` - [Gtk4 Documentation](https://docs.gtk.org/gtk4/) - `gtk-4-layer-shell` - [Gtk4 Layer Shell](https://github.com/wmww/gtk4-layer-shell) - `dbus` - (Used to get currently playing song) - `openssl` - (Used for retrieving Spotify album art) - `libssl-dev` - `libsqlite3-dev` 1. **Clone the repository**: ```bash git clone https://github.com/skxxtz/sherlock.git cd sherlock ``` 2. **Install necessary Rust dependencies**: Build the project using the following command: ```bash cargo build --release ``` 3. **Install the binary**: After the build completes, install the binary to your system: ```bash sudo cp target/release/sherlock /usr/bin/ ``` #### <ins>Build Debian Package</ins> To build a `.deb` package directly from the source, follow these steps:<br> Make sure you have the following dependencies installed: - `rust` - [How to install rust](https://www.rust-lang.org/tools/install) - `git` - [How to install git](https://github.com/git-guides/install-git) - `gtk4` - [Gtk4 Documentation](https://docs.gtk.org/gtk4/) - `gtk-4-layer-shell` - [Gtk4 Layer Shell](https://github.com/wmww/gtk4-layer-shell) 1. **Install the `cargo-deb` tool**: First, you need to install the `cargo-deb` tool, which simplifies packaging Rust projects as Debian packages: ```bash cargo install cargo-deb ``` 2. **Build the Debian package**: After installing `cargo-deb`, run the following command to build the `.deb` package: ```bash cargo deb ``` This will create a `.deb` package in the `target/debian` directory. 3. **Install the generated `.deb` package**: Once the package is built, you can install it using: ```bash sudo dpkg -i target/debian/sherlock-launcher_0.1.10_amd64.deb ``` (Make sure to replace the filename if the version number is different.) <br><br> #### <ins>Nix Flake</ins> Add `sherlock.url = "github:Skxxtz/sherlock";` to the `inputs` of `flake.nix`. Sherlock can be installed either as a standalone package; or managed with `home-manager`, which both installs and generates configuration files. To install the standalone package, add `sherlock.packages.${pkgs.system}.default` to `environment.systemPackages`. You will need to create the configuration files yourself, see below. For `home-manager` enabled systems, use the `sherlock.homeManagerModules.default` output of the imported flake. An example can be found [here](https://github.com/Vanta1/dots/blob/2888dd05bbba8866f77da4d6fbd9de0122ea7a2b/home/programs/sherlock.nix). ### 3. Post Installation #### **Config Setup** After the installation is completed, you can set up your configuration files. The location for them is `~/.config/sherlock/`. Depending on your needs, you should add the following files: 1. [**config.toml**](https://github.com/Skxxtz/sherlock/blob/main/docs/examples/config.toml): This file specifies the behavior and defaults of your launcher. Documentation [here](https://github.com/Skxxtz/sherlock/blob/main/docs/config.md). 2. [**fallback.json**](https://github.com/Skxxtz/sherlock/blob/main/docs/examples/fallback.json): This file specifies the features your launcher should have. Documentation [here](https://github.com/Skxxtz/sherlock/blob/main/docs/launchers.md). 3. [**sherlock_alias.json**](https://github.com/Skxxtz/sherlock/blob/main/docs/examples/sherlock_alias.json): This file specifies aliases for applications. Documentation [here](https://github.com/Skxxtz/sherlock/blob/main/docs/aliases.md). 4. [**sherlockignore**](https://github.com/Skxxtz/sherlock/blob/main/docs/examples/sherlockignore): This file specifies which applications to exclude from your search. Documentation [here](https://github.com/Skxxtz/sherlock/blob/main/docs/sherlockignore.md). ```bash mkdir -p ~/.config/sherlock/ touch ~/.config/sherlock/config.toml ~/.config/sherlock/sherlockignore echo [] > ~/.config/sherlock/fallback.json echo {} > ~/.config/sherlock/sherlock_alias.json ``` <br><br> **Alternatively**, you can use `curl -O` in the `~/.config/sherlock/` directory to load the [example configs](https://github.com/Skxxtz/sherlock/tree/main/docs/examples). This is **not good practice** and **not recommended**, especially if you don't know the source, as you could end up downloading **malware**! Nevertheless, here's how you can do that, if you prefer to be a risk-taker: > **🚨 Warning:** Only use `curl` with trusted sources to avoid downloading malicious content! ```bash mkdir -p ~/.config/sherlock/ cd ~/.config/sherlock/ curl -O https://raw.githubusercontent.com/skxxtz/sherlock/main/docs/examples/config.toml curl -O https://raw.githubusercontent.com/skxxtz/sherlock/main/docs/examples/sherlockignore curl -O https://raw.githubusercontent.com/skxxtz/sherlock/main/docs/examples/fallback.json curl -O https://raw.githubusercontent.com/skxxtz/sherlock/main/docs/examples/sherlock_alias.json ``` #### Warnings after startup If you're getting warnings after startup, you can press `return` to access the main application. Alternatively you can set the `try_suppress_warnings` key in the config file to true. This will prevent any warnings to be shown. The same thing can be done for errors. However, if you suppress errors, the application might not work as expected. #### **Keybind Setup** To launch Sherlock, you can either type `sherlock` into the command line or bind it to a key. The latter is recommended. The setup steps vary by display manager. The setup for **Hyprland** is outlined here: 1. (Recommended) Bind the `$menu` variable to Sherlock: ```conf $menu = sherlock ``` 2. Bind a key to execute `$menu` ```conf bind = $mainMod, space, exec, $menu ``` ", Assign "at most 3 tags" to the expected json: {"id":"13543","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"