note-companion

note-companion

Note Companion: AI assistant for Obsidian that goes beyond just a chat. (prev File Organizer 2000)

Stars: 546

Visit
 screenshot

Note Companion is an AI-powered Obsidian plugin that automatically organizes and formats notes. It provides organizing suggestions, custom format AI prompts, automated workflows, handwritten note digitization, audio transcription, atomic note generation, YouTube summaries, and context-aware AI chat. Key use cases include smart vault management, handwritten notes digitization, and intelligent meeting notes. The tool offers advanced features like custom AI templates and multi-modal support for processing various content types. Users can seamlessly integrate with mobile workflows and utilize iOS shortcuts for sending Apple Notes to Obsidian. Note Companion enhances productivity by streamlining note organization and management tasks with AI assistance.

README:

Note Companion AI (prev. File Organizer 2000)

Note Companion is an AI-powered Obsidian plugin that automatically organizes and formats your notesβ€”so you don’t have to.

Try Note Companion YouTube Subscribers

🌟 Features

  • πŸ—‚οΈ Organizing Suggestions: Get AI-driven suggestions for folders, tags, filenames, and more.
  • πŸŽ›οΈ Custom Format AI Prompts: Save and apply your own AI prompts for consistency.
  • πŸ“ Automated Workflows: Streamline your file management and formatting tasks.
  • πŸ“– Handwritten Note Digitization: Convert handwritten notes into searchable digital text.
  • πŸ”Š Audio Transcription: Easily transcribe and organize audio files.
  • βœ‚οΈ Atomic Note Generation: Break down larger notes into smaller, more focused ones.
  • πŸŽ₯ YouTube Summaries: Quickly generate summaries for YouTube videos.
  • πŸ’¬ Context-Aware AI Chat: Use AI to chat with multiple notes in context.

Group 39904 Group 39905 Group 39906 Group 39907 Group 39908


πŸ—„οΈ Key Use Cases

Smart Vault Management

Transform your Obsidian vault into an intelligent knowledge base:

  1. Context-Aware Organization: AI suggests tags, folders, and filenames based on content.
  2. Powerful Search: Natural language search across files, including YouTube transcripts.
  3. Automation Tools:
    • LastModifiedHandler: Track and organize recently modified files.
    • ScreenpipeHandler: Monitor daily activities.
    • ExecuteActionsHandler: Automate repetitive tasks.

Handwritten Notes Digitization

  • Advanced OCR Integration: Convert handwritten notes and diagrams into digital text.
  • Batch Processing: Automate organization for multiple notes at once.
  • Diagram Recognition: Preserve and process hand-drawn diagrams.

Intelligent Meeting Notes

  • Granola-Style Notes: Automatically create structured and actionable meeting notes.
  • Smart Transcript Integration: Merge meeting transcripts with existing notes.
  • Customizable Templates: Ensure consistent formatting for all notes.

πŸš€ Getting Started

Choose your preferred setup:

A. Cloud Subscription

  1. Access our managed service with all features included
  2. No setup required - just activate your license key
  3. Regular updates and new features

B. Self-Hosted Solution

  1. Run your own instance with full control

  2. Use your preferred AI models

  3. Complete privacy with local processing

  4. Run the server For Linux/macOS:

    cd packages/web && pnpm build:self-host && pnpm start

    And make sure you have your OPENAI_API_KEY variable set up in your .env.local file inside the packages/web directory. If you want to use Amazon Bedrock models, you'll also need to configure AWS credentials (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION). For Windows (PowerShell):

    cd packages/web; pnpm build:self-host; pnpm start

    And make sure you have your OPENAI_API_KEY variable set up in your .env.local file inside the packages/web directory.

  5. Enable self-hosted mode in plugin settings: Screenshot 2024-04-13 at 07 16 21

C. Development Setup

This is a monorepo using pnpm workspaces and Turborepo. To get started:

  1. Install dependencies:
    pnpm install
  2. Build all packages:
    pnpm build
  3. Development commands:
    • Start web development server: cd packages/web && pnpm dev
    • Build plugin: cd packages/plugin && pnpm build
    • Build audio server: cd packages/audio-server && pnpm build The project consists of the following packages:
  • packages/plugin: The Obsidian plugin
  • packages/web: The web application
  • packages/audio-server: Audio transcription server
  • packages/shared: Shared utilities and types For the tech-savvies who would like to play around with different models, there is a promptfoo.yaml file in the project including examples with local LLMs. See link for more info: https://promptfoo.dev/docs/configuration/guide/

πŸ“± Mobile Integration

Seamlessly integrate with your mobile workflow:

  • iOS Shortcut for sending Apple Notes to Obsidian
  • Voice memo support for instant meeting notes
  • Cloud sync compatibility (works great with iCloud)

iOS shortcut to send Apple Notes and Audios to Obsidian

The iOS shortcut below makes it easy for you to easily work from your phone with this plugin. https://www.icloud.com/shortcuts/06915768862848fb9711f2f19b6405e2 how to set it up: https://youtu.be/zWJgIRlDWkk?si=HSeOUKaMfJvaLtKI

Notes:

  • It works when your vault is on a cloud drive. I use it with iCloud and works great. Doesn't work with OneDrive last time I tested.
  • Currently only works if your iOS is in English. But if you reach out on discord I can help you set it up in your language.

πŸ› οΈ Advanced Features

Custom AI Templates

Create powerful automation workflows:

  • Define custom processing rules
  • Set up automatic file naming conventions
  • Configure content formatting templates

Multi-Modal Support

Process various types of content:

  • Audio transcription
  • Image OCR
  • PDF text extraction
  • YouTube video transcripts

Tips and Tricks

Thumbnail (2)

How to use

A. AI Organizer

Get suggestions and choose what to apply with the Assistant view. Here's how to use it:

  1. Click on the Assistant View Icon or set up the "Show Assistant" hotkey to open the Sidebar
  2. Select any of your files and choose which changes to apply

Screenshot 2024-05-24 at 11 42 17β€―PM

B. AI Inbox

Auto-organize with the AI Inbox.

We recommend the AI Assistant view for more control. But the AI Inbox can be handy as well. Simply move any of your files to the "Inbox" folder and the plugin will automatically move it to the folder it belongs. Additional configuration can also be specified within the plugin settings (e.g. auto-tagging, auto-formatting).

Move your unorganized files into _FileOrganizer2000/Inbox

image

It takes a sec, and then renames, and organizes your file.

image

See plugin settings to customize the changes AI Inbox applies to your files.

C. Create custom AI Templates

Give instructions for the AI to format and modify your files.

See video: https://www.youtube.com/watch?v=rommuUXRgUw&t=17s

D. Misc

To use llama 3.2 with the ai chat, install Ollama + llama 3.2 and check this setting in the plugin:

Screenshot 2024-10-26 at 7 34 18β€―PM

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for note-companion

Similar Open Source Tools

For similar tasks

For similar jobs