Note Companion is an AI-powered Obsidian plugin designed to automate the organization, formatting, and management of notes for users seeking a more intelligent knowledge base. It offers features like AI-driven suggestions for file organization, custom AI prompt application, and automated workflows, catering to individuals who manage large volumes of information within Obsidian.

How It Works

The plugin leverages AI models to process note content, providing intelligent suggestions for folder structures, tags, and filenames. It supports custom AI prompts for consistent formatting and enables automated workflows for file management. Advanced features include handwritten note digitization via OCR, audio transcription, atomic note generation, YouTube summarization, and context-aware AI chat across multiple notes.

Quick Start & Requirements

• Self-Hosted: Requires pnpm for installation and execution. Set OPENAI_API_KEY in .env.local. For Amazon Bedrock models, configure AWS credentials.
  • Linux/macOS: cd packages/web && pnpm build:self-host && pnpm start
  • Windows (PowerShell): cd packages/web; pnpm build:self-host; pnpm start
• Development: Requires pnpm.
  • Install: pnpm install
  • Build: pnpm build
  • Run web dev server: pnpm --filter web dev
• Dependencies: OpenAI API key or compatible LLM setup (e.g., Ollama with Llama 3.2).
• Links: iCloud Shortcuts, Setup Video, Promptfoo Config

Highlighted Details

• Multi-modal support including audio transcription, image OCR, PDF extraction, and YouTube transcripts.
• Mobile integration with iOS Shortcuts for sending Apple Notes and audio to Obsidian.
• Self-hosted option for full control and local processing with custom AI models.
• "AI Inbox" feature for automatic file organization upon moving files to a designated folder.

Maintenance & Community

The project is actively developed, with a monorepo structure using pnpm and Turborepo. A bounty is offered for refactoring the mobile setup. Community engagement is encouraged via Discord.

Licensing & Compatibility

The README does not explicitly state the license. Compatibility for commercial use or closed-source linking is not specified.

Limitations & Caveats

The iOS integration currently requires the device language to be set to English, though community support for other languages is offered. OneDrive cloud sync is noted as not working with the iOS shortcut.