/logseq-copilot

A Logseq plugin that integrates with OpenAI-compatible LLMs

Primary LanguageClojure

Logseq Copilot Plugin

A Logseq plugin that integrates with OpenAI-compatible LLM APIs to provide AI assistance directly in your notes.

Features

  • 🔌 Works with OpenAI-compatible APIs (LM Studio, Ollama, Google Gemini, x.ai Grok, and more)
  • 🎯 Custom system prompts for specialized tasks
  • ⚡️ Quick access with keyboard shortcuts
  • 🎛️ Adjustable temperature and response length
  • ⌨️ Customizable hotkeys
  • 🔗 Page Content Fetching: If a block contains only a page link (e.g., [[page name]]), the plugin will fetch the content of the linked page and use it as the context for the LLM. This allows you to use the plugin with page content as if it were block content. By default our plugin only works with current block. This is useful when you want to apply prompts to multiple blocks at the same time, you can use the "Block to Page" plugin to turn multiple blocks into page and then apply logseq-copilot system prompts.

Installation

  1. Download the plugin
  2. Enable it in Logseq Settings > Plugins
  3. Configure your API settings
  4. Verify your API connection

Configuration

API Settings

Custom Prompts

You can configure up to three custom system prompts for specialized tasks:

  1. Custom Prompt 1: Triggered by /copilot1 or Ctrl+Shift+J
  2. Custom Prompt 2: Triggered by /copilot2 or Ctrl+Shift+K
  3. Custom Prompt 3: Triggered by /copilot3 or Ctrl+Shift+L

Usage

Basic Usage

  1. Select any block in your notes
  2. Either:
    • Type /copilot and press Enter, or
    • Press Ctrl+Shift+H (default hotkey)
  3. The AI will respond to your block content

Using Custom Prompts

  1. First, configure your custom prompts in plugin settings
  2. Select a block in your notes
  3. Trigger the custom prompt either by:
    • Using slash commands: /copilot1, /copilot2, or /copilot3
    • Using hotkeys: Ctrl+Shift+J/K/L

Keyboard Shortcuts

Default shortcuts (can be customized in Settings > Shortcuts):

  • Default Copilot: Ctrl+Shift+H
  • Custom Prompt 1: Ctrl+Shift+J
  • Custom Prompt 2: Ctrl+Shift+K
  • Custom Prompt 3: Ctrl+Shift+L

Tips

  • Test your API connection with the verify button before use
  • Adjust temperature for more creative (higher) or focused (lower) responses
  • Use custom prompts for frequently repeated tasks
  • Customize hotkeys in Logseq's Settings > Shortcuts if you prefer different combinations

Support

If you encounter any issues or have suggestions, please:

  1. Check if your API connection is verified
  2. Ensure you have selected a block before using commands
  3. Check the console for any error messages

Contributing

We welcome contributions! Here's how you can help improve the Logseq Copilot Plugin.

Development Setup

  1. Prerequisites

  2. Clone and Install Dependencies

    git clone https://github.com/avelino/logseq-copilot.git
cd logseq-copilot
bb deps

  3. Development Commands We use Babashka (bb) tasks for development. Here are the main commands:

    • Start development environment:

      bb dev

      This command:

      • Cleans the dist directory
      • Copies resources
      • Starts Shadow-CLJS watch process for hot reloading

    • Check for dependency updates:

      bb deps

    • Build the plugin:

      bb build

      This creates a production build in the dist directory.

Loading the Plugin in Logseq

  1. In Logseq, go to Settings → Developer mode → Turn it on
  2. Click "Load unpacked plugin"
  3. Select the dist directory from your development workspace
  4. The plugin will be loaded for development

For hot-reloading during development:

  1. Make changes to the code
  2. The Shadow-CLJS watch process will automatically rebuild
  3. In Logseq, click the reload (↻) button next to the plugin name

Making Contributions

  1. Fork the repository

  2. Create a new branch for your feature/fix:

    git checkout -b feature/your-feature-name

  3. Make your changes

  4. Test your changes thoroughly

  5. Commit your changes with a clear message:

    git commit -m "feat: add new feature" # or "fix: resolve issue"

  6. Push to your fork and submit a Pull Request

Development Tips

  • Use bb watch-cljs for just the ClojureScript watch process
  • The bb portal command opens the Portal UI for debugging
  • Check the browser console for errors and debug information
  • Test your changes in Logseq before submitting a PR

License

MIT License - See LICENSE