No description
Find a file
Shirayuki Nekomata 522199b467
Revise project documentation for clarity
- Updated project overview to specify plugin name and features
- Enhanced environment and tooling section with detailed requirements
- Added quick start instructions for installation and development
- Improved organization of folder structure and conventions
- Clarified key principles and guidelines for contributors
2025-12-25 23:55:12 +07:00
.github/workflows Update lint workflow to use pnpm 2025-12-24 00:07:51 +07:00
scripts Refine vault path handling 2025-12-24 00:38:20 +07:00
src Replace old license with new community license 2025-12-25 12:55:38 +07:00
.editorconfig Initial commit 2025-12-23 07:58:23 +07:00
.gitignore Refine vault path handling 2025-12-24 00:38:20 +07:00
.npmrc Initial commit 2025-12-23 07:58:23 +07:00
AGENTS.md Revise project documentation for clarity 2025-12-25 23:55:12 +07:00
DEVELOPMENT.md Refine vault path handling 2025-12-24 00:38:20 +07:00
esbuild.config.mjs Enhance API interaction and error handling 2025-12-23 12:34:42 +07:00
eslint.config.mts Update Node.js version to 18.x 2025-12-23 23:55:56 +07:00
LICENSE.md Replace old license with new community license 2025-12-25 12:55:38 +07:00
manifest.json Add Logically research assistant sidebar 2025-12-23 11:14:50 +07:00
package-lock.json Initial commit 2025-12-23 07:58:23 +07:00
package.json Replace old license with new community license 2025-12-25 12:55:38 +07:00
pnpm-lock.yaml Update eslint and related packages 2025-12-24 00:13:30 +07:00
README.md Enhance account switching and logout feedback 2025-12-25 11:59:14 +07:00
styles.css Add Logically research assistant sidebar 2025-12-23 11:14:50 +07:00
tsconfig.json Enhance API interaction and error handling 2025-12-23 12:34:42 +07:00
version-bump.mjs Initial commit 2025-12-23 07:58:23 +07:00
versions.json Add Logically research assistant sidebar 2025-12-23 11:14:50 +07:00

Logically Research Assistant (Obsidian)

Release GitHub release (latest SemVer) GitHub All Releases

Chat with Logicallys research assistant inside Obsidian (right sidebar), with optional context from your vault notes.

What you get

  • Right sidebar chat view with persistent history
  • Search modes:
    • Files (Document Retrieval): use selected vault notes as reference context
    • Google: enrich answers with web results
    • Scholar (Semantic Scholar): research paper discovery
  • Model selection (Standard / Advanced / Reasoning), with upgrade prompts for locked tiers
  • Reference files (up to 5) via file picker or drag & drop
  • Citations + sources:
    • Citation tokens in responses render as clickable superscripts
    • A Sources table is shown for assistant messages when sources exist
  • Message actions:
    • Insert into active note (assistant messages)
    • Regenerate (assistant messages)
    • Delete from here down (user messages)
  • Quick controls: Settings panel and Clear chat
  • Custom instruction (saved, applied to every message)

Requirements

  • Obsidian
  • A Logically account (logically.app)
  • Internet access (messages are sent to Logicallys API)

Install

Option A Community Plugins

  1. Open Settings → Community plugins
  2. Select Browse and search for Logically Research Assistant
  3. Install, then enable the plugin

Option B Private distribution

If it is not listed in the Community Plugins browser, you will need a direct install bundle from Logically. Please reach out to Logically support for access.

Set up

  1. Open Settings → Logically Research Assistant
  2. Sign in with your Logically email + password (or paste a token under Advanced → Login with token)
  3. (Optional) Use Verify connection to test your login/API

Notes:

  • Model selection happens inside the chat (next to the send button). Your choice is remembered.
  • When you log out, the plugin resets the selected model back to GPT-5 mini.

Use

  1. Open the assistant:
    • Click the Logically ribbon icon, or
    • Use command palette: Logically: Open Research Assistant / Logically: Toggle Research Assistant
  2. Pick a mode (Files / Google / Scholar)
  3. Pick a model (Standard / Advanced / Reasoning)
  4. Ask your question

Files mode: add reference context

You can include up to 5 Markdown notes as reference context for the next message.

  • Click Files to open the file picker (search your vault and select notes)
  • Or drag a note from Obsidians file explorer into the assistant panel (youll see a drop overlay)

Notes:

  • Dropping files that are already selected wont error; the plugin will add the new ones and tell you which were already added.
  • When the limit is reached, additional dropped/selected files are skipped.

Citations & sources

  • When the backend returns citations, the plugin renders citation markers as clickable superscripts.
  • Assistant messages with sources show a Sources table where you can:
    • Open external links (Google / Scholar)
    • Open vault notes used as reference files

Insert an answer into your note

Use Insert into active note on an assistant message.

  • Citation markers are converted into Obsidian footnotes ([^1], [^2], …)
  • Footnote definitions are appended at the bottom
  • A Sources section is added with links to reference files and/or external URLs

Settings panel (in the assistant header)

  • Shows the signed-in email
  • Lets you logout
  • Lets you edit and save a Custom Instruction (applied to every message)

Privacy & data

  • When you send a message, the plugin sends your prompt and relevant chat history to Logicallys API.
  • If you add reference files, the contents of those selected notes are included with the request.

Avoid adding sensitive/private content you dont want processed remotely.

Account switching & history

  • If you sign in to a different Logically account than last time, the plugin will clear the existing chat history to protect your privacy.
  • If you log out and sign back in to the same account, your chat history is preserved.

Troubleshooting

  • Google Sign-In: the button is visible, but Google Sign-In isnt available in Obsidian yet. For now, please sign in using email + password (you can set this up at https://logically.app under Account Detail) or use a login token (see Advanced → Log in with token in plugin settings).
  • Login fails: confirm your credentials work on https://logically.app and try Verify connection in settings.
  • Network / connection errors: check your internet connection and try Verify connection.
  • Dragging notes doesnt add them: only Markdown notes can be added; try dragging a .md note from the Obsidian file explorer.
  • File picker is empty: ensure your vault contains Markdown files and Obsidian has finished indexing.