https://github.com/different-ai/note-companion
Note Companion: AI assistant for Obsidian that goes beyond just a chat. (prev File Organizer 2000)
https://github.com/different-ai/note-companion
gpt obsidian ocr
Last synced: 5 months ago
JSON representation
Note Companion: AI assistant for Obsidian that goes beyond just a chat. (prev File Organizer 2000)
- Host: GitHub
- URL: https://github.com/different-ai/note-companion
- Owner: different-ai
- License: mit
- Created: 2023-09-10T20:33:20.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-05-12T19:21:50.000Z (5 months ago)
- Last Synced: 2025-05-12T20:33:48.595Z (5 months ago)
- Topics: gpt, obsidian, ocr
- Language: TypeScript
- Homepage: https://notecompanion.ai
- Size: 153 MB
- Stars: 642
- Watchers: 4
- Forks: 100
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
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.
## 🌟 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.
---
## 🗄️ 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
1. Run the server
For Linux/macOS:
```sh
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):
```sh
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.
2. Enable self-hosted mode in plugin settings:
### C. Development Setup
This is a monorepo using pnpm workspaces and Turborepo. To get started:
1. Install dependencies:
```sh
pnpm install
```
2. Build all packages:
```sh
pnpm build
```
3. Development commands:
- Start web development server: `pnpm --filter web dev`
- Build plugin: `pnpm --filter plugin build`
- Build audio server: `pnpm --filter audio-server build`
- **Mobile App (Expo):**
- Navigate to the mobile package: `cd packages/mobile`
- Install dependencies: `pnpm install` (run inside `packages/mobile`)
- Run Android: `pnpm android` (run inside `packages/mobile`)
- Run iOS: `pnpm ios` (run inside `packages/mobile`)
- Start development server: `pnpm start` (run inside `packages/mobile`)
The project consists of the following packages:
- `packages/plugin`: The Obsidian plugin
- `packages/web`: The web application (Next.js)
- `packages/mobile`: The mobile application (React Native/Expo)
- `packages/audio-server`: Audio transcription server
- `packages/shared`: Shared utilities and types
**Mobile Development Bounty:** We are offering $50 to the first person who can refactor the mobile setup to allow building and running *perfectly* directly from the monorepo root (e.g., `pnpm run android` from the top level instead of having to `cd` into `packages/mobile`). This likely involves adjusting `turbo.json` and potentially Expo configurations.
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
[](https://youtube.com/playlist?list=PLgRcC-DFR5jcwwg0Dr3gNZrkZxkztraKE&si=FozzANIO6i8XI_x8)
## 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
### 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 `_NoteCompanion/Inbox`
It takes a sec, and then renames, and organizes your file.
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:
