Skip to content

Installation Guide

Tharushka Dinujaya edited this page Sep 18, 2025 · 3 revisions

Installation Guide

Install VaultAI in your Obsidian vault using Community Plugins or manual installation.

Prerequisites

  • Obsidian v0.15.0 or higher
  • Google Gemini API key (Get one here)

Community Plugins (Recommended)

  1. Open Obsidian SettingsCommunity Plugins
  2. Turn off Safe Mode if enabled
  3. Click Browse and search for "VaultAI"
  4. Install and enable the plugin
  5. Configure your API key in SettingsVaultAI

Manual Installation

  1. Download latest release from GitHub releases
  2. Extract files to .obsidian/plugins/vaultai/ in your vault
  3. Restart Obsidian
  4. Enable plugin in SettingsCommunity Plugins
  5. Configure your API key

Verification

After installation:

  • Look for the 🤖 icon in bottom-right corner
  • Press Ctrl/Cmd+Shift+V to test chat toggle
  • Try asking "Hello, VaultAI!" to confirm it's working

Common Issues

Plugin not appearing: Ensure Obsidian v0.15.0+ and Safe Mode is disabled API errors: Verify your Gemini API key is correct and has quota remaining Chat not opening: Check if plugin is enabled in Community Plugins settings

Next Steps

Clone this wiki locally