[![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url]

Open Notebook

An open source, privacy-focused alternative to Google's Notebook LM!
Join our Discord server for help, to share workflow ideas, and suggest features!
Checkout our website »

Get Started (Setup) · Features

## 📢 Open Notebook is under very active development > Open Notebook is under active development! We're moving fast and making improvements every week. Your feedback is incredibly valuable to me during this exciting phase and it gives me motivation to keep improving and building this amazing tool. Please feel free to star the project if you find it useful, and don't hesitate to reach out with any questions or suggestions. I'm excited to see how you'll use it and what ideas you'll bring to the project! Let's build something amazing together! 🚀 > > ⚠️ **API Changes**: As we optimize and enhance the project, some APIs and interfaces might change. We'll do our best to document these changes and minimize disruption. > > 🙏 **We Need Your Feedback**: Please try out Open Notebook and let us know what you think! Submit issues, feature requests, or just share your experience through: > - GitHub Issues > - Discussions > - Pull Requests > > Together, we can make it even better!

Table of Contents

About The Project
- Built With
Setting Up
- Prerequisites
- Installation
Usage
Features
Roadmap
Contributing
License
Contact
Acknowledgments

## About The Project ![New Notebook](docs/assets/asset_list.png) An open source, privacy-focused alternative to Google's Notebook LM. Why give Google more of our data when we can take control of our own research workflows? In a world dominated by Artificial Intelligence, having the ability to think 🧠 and acquire new knowledge 💡, is a skill that should not be a privilege for a few, nor restricted to a single provider. Open Notebook empowers you to manage your research, generate AI-assisted notes, and interact with your content—on your terms. Learn more about our project at [https://www.open-notebook.ai](https://www.open-notebook.ai)

(back to top)

### Built With [![Python][Python]][Python-url] [![SurrealDB][SurrealDB]][SurrealDB-url] [![LangChain][LangChain]][LangChain-url] [![Streamlit][Streamlit]][Streamlit-url]

(back to top)

## ⚙️ Setting Up Go to the [Setup Guide](docs/SETUP.md) to learn how to set up the tool in details. 📚 **Need help choosing AI models?** Check out our [Model Selection Guide](https://github.com/lfnovo/open-notebook/blob/main/docs/models.md) for recommended combinations and provider comparisons. You don't need to clone this repo if you just want to use the app without building from source! Take a look at the [Open Notebook Boilerplate](https://github.com/lfnovo/open-notebook-boilerplate) repo with a sample of how to set it up for maximum feature usability. ### Running from source Start by cloning this repo and cd into it. ```bash git clone https://github.com/lfnovo/open-notebook cd open-notebook ``` Rename `.env.example` into `.env` and set up your API keys. Also, repeat the process for `docker.env` if you plan to run this using docker. ```bash cp .env.example .env cp .env.example docker.env ``` Edit .env for your API keys. ### System Dependencies This project requires some system dependencies: ```bash # macOS brew install libmagic # Ubuntu/Debian sudo apt-get install libmagic-dev # Fedora/RHEL/CentOS sudo dnf install file-devel ``` ### Installing Python Dependencies Install all required Python packages: ```bash uv sync uv pip install python-magic ``` ### Running the Application Start the SurrealDB database first: ```bash docker compose --profile db_only up -d ``` Then run the Streamlit application: ```bash # Load environment variables from .env file and run the app uv run --env-file .env streamlit run app_home.py ``` ## Provider Support Matrix Thanks to the [Esperanto](https://github.com/lfnovo/esperanto) library, we support this providers out of the box! | Provider | LLM Support | Embedding Support | Speech-to-Text | Text-to-Speech | |--------------|-------------|------------------|----------------|----------------| | OpenAI | ✅ | ✅ | ✅ | ✅ | | Anthropic | ✅ | ❌ | ❌ | ❌ | | Groq | ✅ | ❌ | ✅ | ❌ | | Google (GenAI) | ✅ | ✅ | ❌ | ✅ | | Vertex AI | ✅ | ✅ | ❌ | ✅ | | Ollama | ✅ | ✅ | ❌ | ❌ | | Perplexity | ✅ | ❌ | ❌ | ❌ | | ElevenLabs | ❌ | ❌ | ✅ | ✅ | | Azure OpenAI | ✅ | ❌ | ❌ | ❌ | | Mistral | ✅ | ✅ | ❌ | ❌ | | DeepSeek | ✅ | ❌ | ❌ | ❌ | | Voyage | ❌ | ✅ | ❌ | ❌ | | xAI | ✅ | ❌ | ❌ | ❌ | | OpenRouter | ✅ | ❌ | ❌ | ❌ | ### Common Issues and Solutions If you encounter a port already in use error: ``` Port 8502 is already in use ``` Find and stop the running process: ```bash # Find the process using port 8502 lsof -i :8502 # Kill the process (replace PID with the actual process ID) kill -9 PID ``` Or specify a different port: ```bash uv run --env-file .env streamlit run app_home.py --server.port=8503 ``` ### Running with Docker If you don't want to mess around with the code and just want to run it as a docker image: ```bash docker compose --profile multi up ```

(back to top)

## Usage Go to the [Usage](docs/USAGE.md) page to learn how to use all features.

(back to top)

## Features - **Multi-Notebook Support**: Organize your research across multiple notebooks effortlessly. - **Multi-model support**: Open AI, Anthropic, Gemini, Vertex AI, Open Router, X.AI, Groq, Ollama. ([Model Selection Guide](https://github.com/lfnovo/open-notebook/blob/main/docs/models.md)) - **Podcast Generator**: Automatically convert your notes into a podcast format. - **Broad Content Integration**: Works with links, PDFs, EPUB, Office, TXT, Markdown files, YouTube videos, Audio files, Video files and pasted text. - **Content Transformation**: Powerful customizable actions to summarize, extract insights, and more. - **AI-Powered Notes**: Write notes yourself or let the AI assist you in generating insights. - **Integrated Search Engines**: Built-in full-text and vector search for faster information retrieval. - **Fine-Grained Context Management**: Choose exactly what to share with the AI to maintain control. - **Citations**: Ask questions about your documents and get answers with citations. [![Check out our podcast sample](https://img.youtube.com/vi/D-760MlGwaI/0.jpg)](https://www.youtube.com/watch?v=D-760MlGwaI)

(back to top)

### 📝 Notebook Page Three intuitive columns to streamline your work: 1. **Sources**: Manage all research materials. 2. **Notes**: Create or AI-generated notes. 3. **Chat**: Chat with the AI, leveraging your content. ### ⚙️ Context Configuration Take control of your data. Decide what gets sent to the AI with three context options: - No context - Summary only - Full content Plus, you can add your project description to help the AI provide more accurate and helpful responses. ### 🔍 Integrated Search for Your Items Locate anything across your research with ease using full-text and vector-based search. ### 💬 Powerful open prompts Jinja based prompts that are easy to customize to your own preferences.

(back to top)

## Roadmap - [ ] **Live Front-End Updates**: Real-time UI updates for a smoother experience. - [ ] **Async Processing**: Faster UI through asynchronous content processing. - [ ] **Cross-Notebook Sources and Notes**: Reuse research notes across projects. - [ ] **Bookmark Integration**: Integrate with your favorite bookmarking app. - ✅ **Multi-model support**: Open AI, Anthropic, Vertex AI, Open Router, Ollama, etc. - ✅ **Insight Generation**: New tools for creating insights - [transformations](docs/TRANSFORMATIONS.md) - ✅ **Podcast Generator**: Automatically convert your notes into a podcast format. - ✅ **Multiple Chat Sessions**: Juggle different discussions within the same notebook. - ✅ **Enhanced Citations**: Improved layout and finer control for citations. - ✅ **Better Embeddings & Summarization**: Smarter ways to distill information. See the [open issues](https://github.com/lfnovo/open-notebook/issues) for a full list of proposed features (and known issues).

(back to top)

## Contributing We would love your contributions! Specifically, we're looking for help with: - **Front-End Development**: Improve the UI/UX by moving beyond Streamlit. - **Testing & Bug Fixes**: Help make Open Notebook more robust. - **Feature Development**: Let’s make the coolest note-taking tool together! See more at [CONTRIBUTING](CONTRIBUTING.md)

(back to top)

## License Open Notebook is MIT licensed. See the [LICENSE](LICENSE) file for details.

(back to top)

## Contact Luis Novo - [@lfnovo](https://twitter.com/lfnovo) Join our [Discord server](https://discord.gg/37XJPXfz2w) for help, share workflow ideas, and suggest features.

(back to top)

## Acknowledgments This project uses some amazing third-party libraries * [Podcastfy](https://github.com/souzatharsis/podcastfy) - Licensed under the Apache License 2.0 * [Content Core](https://github.com/lfnovo/content-core) - Licensed under the MIT License * [Docling](https://github.com/docling-project/docling) - Licensed under the MIT License * [Esperanto](https://github.com/lfnovo/esperanto) - Licensed under the MIT License

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/lfnovo/open-notebook.svg?style=for-the-badge [contributors-url]: https://github.com/lfnovo/open-notebook/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/lfnovo/open-notebook.svg?style=for-the-badge [forks-url]: https://github.com/lfnovo/open-notebook/network/members [stars-shield]: https://img.shields.io/github/stars/lfnovo/open-notebook.svg?style=for-the-badge [stars-url]: https://github.com/lfnovo/open-notebook/stargazers [issues-shield]: https://img.shields.io/github/issues/lfnovo/open-notebook.svg?style=for-the-badge [issues-url]: https://github.com/lfnovo/open-notebook/issues [license-shield]: https://img.shields.io/github/license/lfnovo/open-notebook.svg?style=for-the-badge [license-url]: https://github.com/lfnovo/open-notebook/blob/master/LICENSE.txt [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 [linkedin-url]: https://linkedin.com/in/lfnovo [product-screenshot]: images/screenshot.png [Streamlit]: https://img.shields.io/badge/Streamlit-FF4B4B?style=for-the-badge&logo=streamlit&logoColor=white [Streamlit-url]: https://streamlit.io/ [Python]: https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white [Python-url]: https://www.python.org/ [LangChain]: https://img.shields.io/badge/LangChain-3A3A3A?style=for-the-badge&logo=chainlink&logoColor=white [LangChain-url]: https://www.langchain.com/ [SurrealDB]: https://img.shields.io/badge/SurrealDB-FF5E00?style=for-the-badge&logo=databricks&logoColor=white [SurrealDB-url]: https://surrealdb.com/