• sherlock-wiki: allows you to search Wikipedia from within Sherlock using the bulk_text launcher.
  
  

🚨 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.

• Features
• Getting Started
  • Dependencies
  • Installation
    • Arch Linux
    • From Source
    • Debian
    • Nix Flake
  • Post Installation
    • Config Setup
    • Keybind Setup

• Fully customize the look and feel of the launcher.
• Modify themes and visual elements to match your preferences

• Define your own commands and extend the functionality of the launcher.
• Add new features or workflows tailored to your specific needs.

• Configure fallback behaviours for various commands and operations.
• Ensure a smooth experience even when certain commands fail or are unavailable.

• 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.

• 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.

• Use the Teams Event Launcher to easily join upcoming Microsoft Teams meetings

• 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.

• Use shortcuts like ctrl + 4 to quickly launch a command or app without having to scroll.

To run the Sherlock Launcher, ensure the following dependencies are installed:

• gtk4 - Gtk4 Documentation
• gtk-4-layer-shell - Gtk4 Layer Shell
• dbus - (Used to get currently playing song)
• openssl - (Used for retrieving Spotify album art)

Additionally, if you're building from source, you will need:

• rust - How to install rust
• git - How to install git
  
  

If you're using Arch Linux, you can install the pre-built binary package with the following command:

yay -S sherlock-launcher-bin

To build Sherlock Launcher from source, follow these steps.
Make sure you have the necessary dependencies installed:

• rust - How to install rust
• git - How to install git
• gtk4 - Gtk4 Documentation
• gtk-4-layer-shell - Gtk4 Layer Shell

1. Clone the repository:

   git clone https://github.com/skxxtz/sherlock.git
   cd sherlock

2. Install necessary Rust dependencies:

   Build the project using the following command:

   cargo build --release

3. Install the binary:

   After the build completes, install the binary to your system:

   sudo cp target/release/sherlock /usr/bin/

To build a .deb package directly from the source, follow these steps:
Make sure you have the following dependencies installed:

• rust - How to install rust
• git - How to install git
• gtk4 - Gtk4 Documentation
• gtk-4-layer-shell - 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:

   cargo install cargo-deb

2. Build the Debian package:

   After installing cargo-deb, run the following command to build the .deb package:

   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:

   sudo dpkg -i target/debian/sherlock-launcher_0.1.8_amd64.deb

   (Make sure to replace the filename if the version number is different.)
   
   

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.

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: This file specifies the behavior and defaults of your launcher. Documentation here.
2. fallback.json: This file specifies the features your launcher should have. Documentation here.
3. sherlock_alias.json: This file specifies aliases for applications. Documentation here.
4. sherlockignore: This file specifies which applications to exclude from your search. Documentation here.

mkdir -p ~/.config/sherlock/
touch ~/.config/sherlock/config.toml ~/.config/sherlock/sherlockignore
echo [] > ~/.config/sherlock/fallback.json
echo {} > ~/.config/sherlock/sherlock_alias.json

Alternatively, you can use curl -O in the ~/.config/sherlock/ directory to load the example configs. 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!

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

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.

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:

$menu = sherlock

2. Bind a key to execute $menu

bind = $mainMod, space, exec, $menu