Sugu Search

Instant spotlight like search and actions in your browser with Sugu Search.

Developed by Drew Hutton

Grab it today for Firefox and Chrome soon.

Table of contents

• Features
• Controlling the interface
  • Opening Sugu
  • Closing Sugu
  • Switching between dark and light mode
• List of commands
• Developer contribution guide
• Special Thanks

Features

• ⚡️ Blazing fast and lightweight UX Built with Svelte
• 💅 Modern Fluid UI
• 👀 Suggested actions in the search bar
• 🗂 Tab management
• 📚 Bookmarks management
• ⌨ Keyboard shortcuts
• 🔌 Plugin based extendable actions
• 🌙 Dark and light mode
• 🔒 Secure, private no login
• 🧩 Integrations (Web shortcuts)

Much more not listed...

Controlling the interface

Opening Sugu

To open Sugu, simply press ⌘+Shift+K on Mac or Ctrl+Shift+K on Windows. You can change the shortcut by going to chrome://extensions/shortcuts.

Alternatively you can click on the extension icon in the toolbar to toggle it.

Closing Sugu

To close Sugu you can press Esc, click on the background, or press the extension icon.

Switching between dark and light mode

The dark and light theme in Sugu is currently tied to your system's theme.

On Mac you can change the theme by clicking on the Apple menu (on the top left), opening the System preferences, going into the General section, and then choosing between dark, light, or auto.

On Windows it depends on the OS version. Here is a guide for Windows 11 and 10.

After switching the theme you might need to restart Chrome.

List of commands

You can use a variety of commands with Sugu to perform actions or filter your results.

• /tabs: Search your tabs
• /bookmarks: Search your bookmarks
• /history: Search your browser history
• /actions: Search all available actions
• /remove: Remove a bookmark or close a tab

Developers contribution guide

To develop with this extension you need to have npm or yarn installed. Once you have downloaded the git repo, you can install the dependencies by running npm install or yarn. This project preferably uses yarn. Please do not commit the npm.lock file.

yarn
# or npm install

To run the extension in development mode, you can run npm run dev or yarn dev.

yarn dev
# or npm run dev

To build for production, you can run npm run build or yarn build.

yarn build
# or npm run build

All required files will be copied to the dist folder.

Running Locally / Self Hosting or Testing

You can build and run this extension locally without needing to install though the store.

Developers

Chrome

1. Clone the code with your git client of choice or zip download.
2. Open a terminal and navigate to the root of the project.
3. Run npm install or yarn.
4. Run npm run build or yarn build.
5. Open Chrome and navigate to chrome://extensions/ make sure you enable developer mode.
6. Click on the Load unpacked extension button, located the public folder and click on the Load button.
7. You should now see the extension in the list of extensions. And can use Sugu in the browser.

Firefox

1. Clone the code with your git client of choice or zip download.
2. Open a terminal and navigate to the root of the project.
3. Run npm install or yarn.
4. Run npm run build or yarn build.
5. Delete the manifest.json file in the public folder, and rename the manifest.v2.json file to manifest.json. (This is because Firefox does not support v3 manifest files and chrome requires them!)
6. Open Chrome and navigate to about:debugging page and click "This Firefox" from the menu.
7. Click on the Load Temporary Add-on button, located the public folder and click on the Load button.
8. You should now see the extension in the list of extensions. And can use Sugu in the browser.

Non-developers

TBA

Special Thanks

• Svelte - Cybernetically Enhanced Web Apps
• Omni - Alyssa X's Original Omni Chrome Extension
• whats.new - Amazing resource for url as shortcuts
• Fluid UI Icons - Microsoft Fluent UI Icons
• Web Extension Polyfill - Web Extension Polyfill

Disclaimer

Acknowledgments

This work is highly inspired by Omni by Alyssa X. This project was originally developed to be a alternative JQuery-less version of Omni, but due to the scope of changes rewrites and features the project has become its own development. The project is offered with the same MIT license so that people are free to take optimizations and implement them back into Omni if wanted, but I highly recommend you checkout and help this project develop further.

Contact

Any questions, comments or direct feedback you are welcome to contact me with email Here or raise a Github issue.