Skip to content

kerim/logseq-db-sidekick

Repository files navigation

Logseq DB Sidekick 🚀

Forked from Logseq Copilot by @EINDEX A specialized version focused on DB graphs only with HTTP server integration for search-only functionality.

GPL-3.0 License TypeScript

Logseq DB Sidekick is a browser extension that allows you to access your Logseq DB graphs while browsing. It shows relevant notes from your Logseq database alongside search results on popular search engines. This fork is specifically designed to work with Logseq's new database graph format via an HTTP server. 🧠

What Makes This Fork Different?

This fork differs from the original Logseq Copilot in several key ways:

  • DB Graphs Only: Works exclusively with Logseq's new database (DB) graph format, not file-based/markdown graphs
  • HTTP Server Architecture: Uses a separate Python HTTP server which connects to Logseq's CLI, instead of the API.
  • Search-Only Focus: Simplified plugin, only focused on searching pages (not blocks), and removing all non-search functionality, like clipping content to Logseq.
  • Independent Operation: Doesn't require Logseq Desktop to be running
  • Redesigned UI: Uses a simpler, collapsable, sidebar, instead of injecting results into search page.

Requirements

  • Logseq HTTP Server - A companion server that wraps @logseq/cli commands
  • DB Graph - Only works with Logseq database graphs (not file-based graphs)

Features

  • 🔍 Automatic Search Detection: Show Logseq DB graph content when you search on popular search engines
  • 🌐 Multi-Engine Support: Google, Bing, Ecosia, Baidu, Yandex, DuckDuckGo, SearX
  • 📝 Manual Search: Type queries directly in the extension's search bar to query your Logseq graph
  • 🎯 Floating Button UI: Collapsible floating button shows result count, expands to side panel
  • 📊 Page Search: Searches page titles across your entire DB graph
  • 🔗 Direct Links: Open pages in Logseq Desktop with one click
  • ⚙️ Easy Configuration: Simple settings panel for server connection and graph selection

Installation

HTTP Server Setup (Required First)

  1. Install the HTTP server from: https://github.com/kerim/logseq-http-server
  2. Start the server: python3 logseq_server.py
  3. The server will run on http://localhost:8765 by default

Browser Extension

Chrome/Edge/Brave (Chromium-based browsers)

  1. Download or clone this repository
  2. Build the extension:
    cd logseq-sidekick
    pnpm install
    VERSION=0.0.46 pnpm run build
  3. Open Chrome and navigate to chrome://extensions/
  4. Enable "Developer mode" (toggle in top right)
  5. Click "Load unpacked"
  6. Select the build/chrome/ directory from this project
  7. The extension icon should appear in your browser toolbar

Firefox

  1. Download or clone this repository
  2. Build the extension:
    cd logseq-sidekick
    pnpm install
    VERSION=0.0.46 pnpm run build
  3. Open Firefox and navigate to about:debugging#/runtime/this-firefox
  4. Click "Load Temporary Add-on"
  5. Navigate to the build/firefox/ directory and select the manifest.json file
  6. The extension will be loaded (note: temporary add-ons are removed when Firefox closes)

Configuration

After installing:

  1. Click the extension icon and go to Settings
  2. Configure HTTP Server connection:
    • Host: localhost (default)
    • Port: 8765 (default)
  3. Click "Refresh Graphs" to load your available DB graphs
  4. Select your graph from the dropdown
  5. Click "Connect" to verify connection

Credits & Acknowledgments

This project would not exist without:

Support the Original Creator

If you find this tool useful, please consider supporting the original creator of Logseq Copilot:

GitHub Sponsors Buy me a Coffee

Contributing

Contributions are welcome! If you want to contribute:

  • Fork this repository and clone it to your local machine
  • Create a new branch for your feature or bug fix
  • Make your changes and commit them with a clear message
  • Submit a pull request

License

GPLv3 - Same as the original Logseq Copilot project

Differences From Original

For a detailed comparison with the original Logseq Copilot, see DIFFERENCES.md

About

Fork of logseq-copilot with fixes for Logseq DB graph compatibility

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 10