obsidian-yolo  by Lapis0x0

AI assistant for Obsidian vault knowledge management and agentic workflows

Created 8 months ago
650 stars

Top 51.3% on SourcePulse

GitHubView on GitHub
Project Summary

YOLO is an AI assistant designed for Obsidian, transforming user vaults into intelligent knowledge bases. It targets Obsidian users, researchers, and knowledge workers seeking to enhance productivity and content creation through advanced LLM integration. The primary benefit is a seamless, intelligent workflow for managing and generating information directly within the Obsidian environment.

How It Works

YOLO integrates multiple Large Language Models (LLMs) like OpenAI, Claude, and Gemini, allowing users to chat directly within Obsidian, query their entire vault, and generate content via features like "Smart Space" and "Quick Ask." Its core approach emphasizes agent orchestration, aiming for long-range task management and multi-model collaboration, offering a more sophisticated AI partner for learning and knowledge work compared to simpler plugins.

Quick Start & Requirements

  • Primary install: Manual installation required. Download main.js, manifest.json, and styles.css from the latest release and place them in <vault>/.obsidian/plugins/obsidian-yolo/.
  • Prerequisites: API keys for supported LLM providers (OpenAI, Anthropic, Gemini, Groq).
  • Dependencies: Obsidian.
  • Notes: YOLO cannot coexist with the Smart Composer plugin. Detailed documentation is available.

Highlighted Details

  • Sidebar Conversations: Supports context injection, preset prompts, custom providers, and smart Markdown parsing.
  • Knowledge Base Q&A: Enables querying the entire Obsidian vault as the AI's knowledge base.
  • Smart Space: Facilitates natural, fluent content generation anywhere within Obsidian.
  • Quick Ask: An inline assistant with Ask, Edit, and Edit (Full Access) modes for tasks like continuing, replacing, or inserting text, requiring models with tool-calling capabilities.
  • Multi-Model Support: Integrates with various LLM providers and includes native internationalization (i18n).

Maintenance & Community

This project is a fork of Smart Composer, aiming for expanded capabilities. Contributions are welcomed via bug reports, fixes, and feature enhancements, with a CONTRIBUTING.md file detailing the workflow. Discussions are available on the repository.

Licensing & Compatibility

Licensed under the MIT License, which generally permits commercial use and integration into closed-source projects.

Limitations & Caveats

YOLO is not yet available in the Obsidian Community Plugin Store and requires manual installation. Certain features, like advanced edit modes in Quick Ask, depend on specific LLM capabilities. Experimental features like Learning Mode and sub-agents are noted.

Health Check
Last Commit

1 day ago

Responsiveness

Inactive

Pull Requests (30d)
5
Issues (30d)
19
Star History
99 stars in the last 30 days

Explore Similar Projects

Starred by Eric Zhu Eric Zhu(Coauthor of AutoGen; Research Scientist at Microsoft Research), Elvis Saravia Elvis Saravia(Founder of DAIR.AI), and
2 more.

deepagents by langchain-ai

2.0%
10k
Framework for building advanced LLM agents
Created 7 months ago
Updated 1 day ago
Feedback? Help us improve.