Obsidian Plugin Setup & Configuration

The NutEgg Obsidian plugin hosts the local sync server, manages AI communication, matches incoming content to your knowledge trees, and maintains your vault files.

Installation

Option 1: Manual Installation (Recommended)

1. Download main.js, manifest.json, and styles.css from the NutEgg Obsidian Plugin Releases.
2. In your Obsidian vault, open .obsidian/plugins/ (show hidden folders in your OS if needed).
3. Create a new directory named nutegg and place the three files inside:

   your-vault/.obsidian/plugins/nutegg/
   ├── main.js
   ├── manifest.json
   └── styles.css

4. In Obsidian, open Settings → Community plugins, click Reload, and toggle NutEgg on.

Option 2: Using BRAT

1. Install the BRAT community plugin in Obsidian.
2. Go to Settings → BRAT → Add Beta plugin.
3. Enter staff-000/nutegg-obsidian-release and click Add Plugin.
4. Enable NutEgg once installed.

AI Provider Configuration

NutEgg puts you in complete control of your AI model and keys. In Obsidian, go to Settings → NutEgg:

• AI Provider: Select your preferred model provider:
  • Google Gemini (Flash, Pro)
  • Anthropic Claude (Haiku, Sonnet, Opus)
  • OpenAI (GPT-4o, GPT-4o-mini)
  • DeepSeek (V3, R1)
  • Kimi / Moonshot
  • Qwen
  • OpenRouter (allows routing to dozens of community & proprietary models)
• API Source: Choose between official provider API or OpenRouter.
• API Key: Enter your private API key. It is saved securely in your Obsidian local storage and never leaves your machine except to contact your chosen provider.

Local Sync Server

When the plugin is enabled, it automatically boots a background HTTP listener on 127.0.0.1:27123.