🤖 VaultAI - Gemini Chatbot Plugin

A powerful AI assistant plugin for Obsidian (https://obsidian.md) inspired by Notion's AI chatbot. This plugin provides an interactive chatbot powered by Google's Gemini AI, adding a floating chat interface to your Obsidian workspace. It allows you to interact with AI for note summarization, brainstorming, translations, and more.

📑 Table of Contents

Click to expand/collapse

Getting Started

• ✨ Features
  • 🎨 Modern Interface
  • 🧠 AI Capabilities
  • 📚 Organization
  • 🔒 Security
• 🚀 Installation
  • Prerequisites
  • From Community Plugins
  • Manual Installation
• ⚙️ Setup

Using the Plugin

• 💡 Usage
  • 🎯 Quick Actions
  • 💬 Basic Interaction
  • 📜 Chat History

Additional Information

• 🤝 Contributing
• 📄 License
• 💖 Support

✨ Features

🎨 Modern Interface

• Floating Chat Interface: A sleek, minimalist chatbot widget that's always accessible
• Glassy Design: Modern, translucent interface with smooth animations
• Resizable Window: Adjust the chat window size from the top-left corner
• Full Page Mode: Toggle between compact and full-page views

🧠 AI Capabilities

• Smart Summarization: Get concise summaries of your notes
• Content Generation: Generate ideas and expand on topics
• Contextual Responses: AI understands and references your current note
• Multi-Language Support: Translate content to different languages
• File References: Reference multiple notes in your queries using @mentions

📚 Organization

• Chat History: Browse and search through past conversations
• Session Management: Organize chats with auto-generated titles
• Quick Actions: Access common tasks through suggested actions
• Export Options: Save AI responses as new notes

🔒 Security

• Secure API Storage: Your Gemini API key is stored with encryption
• Local Processing: All chat history stays in your vault
• Privacy Focused: No data collection or external sharing

🚀 Installation

Prerequisites

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

From Obsidian Community Plugins

1. Open Obsidian Settings > Community plugins
2. Disable Safe mode
3. Click Browse and search for "VaultAI"
4. Install and enable the plugin

Manual Installation

1. Download the latest release from the releases page
2. Extract the files to your .obsidian/plugins/vaultai folder
3. Reload Obsidian
4. Enable the plugin in Settings > Community plugins

⚙️ Setup

1. Get your Gemini API key from Google AI Studio
2. Open Obsidian Settings > VaultAI
3. Enter your API key
4. Start chatting!

💡 Usage

🎯 Quick Actions

• Summarize: Get a concise summary of your current note
• Ask: Ask questions about your note's content
• Translate: Translate your note to different languages
• Quiz: Generate questions to test your understanding

💬 Basic Interaction

• Click the chat icon in the bottom-right corner
• Type your question or select a suggested action
• Use @mention to reference specific notes
• Click the resize handle (top-left) to adjust the window size

📜 Chat History

• Click the history icon to view past conversations
• Search through previous chats
• Delete unwanted conversations
• Resume any previous chat session

🤝 Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

💖 Support

If you find this plugin helpful:

• ⭐ Star the repository
• 🐛 Report issues on GitHub
• 💡 Submit feature requests
• ☕ If you find this plugin helpful, consider supporting the development:

---

Made with ❤️ by Neo