khoj/documentation/docs/clients/obsidian.md
sabaimran 9b991eb4fe
Migrate to using docusaurus, rather than docsify for documentation (#603)
* Add docusaurus documentation (to replace the docsify setup
* Remove older docs
* Specify documentation as the gh pages build action working directory
2024-01-07 20:28:15 +05:30

2.7 KiB

sidebar_position
3

Obsidian

Connect Obsidian to Khoj to search your notes and the web, and chat with your Second Brain.

Khoj Logo Obsidian

An AI copilot for your Second Brain in Obsidian

Features

  • Chat
    • Faster answers: Find answers quickly, from your private notes or the public internet
    • Assisted creativity: Smoothly weave across retrieving answers and generating content
    • Iterative discovery: Iteratively explore and re-discover your notes
  • Search
    • Natural: Advanced natural language understanding using Transformer based ML Models
    • Incremental: Incremental search for a fast, search-as-you-type experience

Interface

Search Chat

Setup

  1. Open Khoj from the Community plugins tab in Obsidian settings panel
  2. Click Install, then Enable on the Khoj plugin page in Obsidian
  3. Generate an API key on the Khoj Web App
  4. Set your Khoj API Key in the Khoj plugin settings in Obsidian

See the official Obsidian Plugin Docs for more details on installing Obsidian plugins.

Use

Chat

Run Khoj: Chat from the Command Palette and ask questions in a natural, conversational style.
E.g "When did I file my taxes last year?"

See Khoj Chat for more details

Find Similar Notes

To see other notes similar to the current one, run Khoj: Find Similar Notes from the Command Palette

Click the Khoj search icon 🔎 on the Ribbon or run Khoj: Search from the Command Palette

See Khoj Search for more details. Use query filters to limit entries to search

search_demo

Upgrade

  1. Open Community plugins tab in Obsidian settings
  2. Click the Check for updates button
  3. Click the Update button next to Khoj, if available

Troubleshooting

  • Open the Khoj plugin settings pane, to configure Khoj
  • Toggle Enable/Disable Khoj, if setting changes have not applied
  • Click Update button to force index to refresh, if results are failing or stale