Sherlock-wiki

Sherlock wiki is a simple script to allow you to make a Wikipedia API request from sherlock directly.

Table of Contents

• Getting Started
  • Dependencies
  • Installation
    • Using the Binary
    • From Source

Getting Started

1. Dependencies

To run sherlock-wiki, ensure the following dependencies are installed:

• Sherlock Application Launcher - Getting Started with Sherlock

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

• rust - How to install rust
  
  

2. Istallation

Using the Binary

1. Go to releases and download the latest release
2. Extract the resulting archive

# Make sure to replace the name with the name of your archive
tar -xvzf sherlock-wiki-v0.1.0-bin-linux-x86_64.tar.gz 

3. Move the extracted binary to the sherlock config directory

mkdir -p ~/.config/sherlock/scripts/
mv sherlock-wiki ~/.config/sherlock/scripts/

4. (Optional) Move the LICENSE to a directory of your choice or delete it

sudo mkdir -p /usr/local/share/licenses/sherlock-wiki/
sudo mv LICENSE /usr/local/share/licenses/sherlock-wiki/

# or

rm -rf LICENSE

From Source

To build sherlock-wiki from source, follow these steps.
Make sure you have the necessary dependencies installed:

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

1. Clone the repository:

git clone https://github.com/Skxxtz/sherlock-wiki.git
cd sherlock-wiki

2. Install necessary Rust dependencies and build the app:

cargo build --release

3. Install the inary:

mkdir -p ~/.config/sherlock/scripts/
cp target/release/sherlock-wiki ~/.config/sherlock/scripts/

Post Installation

You can now refer to sherlock-wiki in your fallback.json file like so:

    {
        "name": "Wikipedia Search",
        "alias": "wiki",
        "type": "bulk_text",
        "on_return": "next",
        "async": true, 
        "args": {"icon": "wikipedia", "exec": "~/.config/sherlock/scripts/sherlock-wiki", "exec-args": "'{keyword}'"},
        "priority": 0 
    }

💡 NOTE: to use an icon that's not included in your standard icon theme you must set a custom icon path within your config.toml file. See Example Config