{"id":25918096,"url":"https://github.com/CNTRLAI/Notate","last_synced_at":"2025-03-03T14:02:51.299Z","repository":{"id":271470926,"uuid":"913547673","full_name":"CNTRLAI/Notate","owner":"CNTRLAI","description":"Notate is a desktop chat application that takes AI conversations to the next level. It combines the simplicity of chat with advanced features like document analysis, vector search, and multi-model AI support - all while keeping your data private.","archived":false,"fork":false,"pushed_at":"2025-02-25T02:17:32.000Z","size":2509,"stargazers_count":244,"open_issues_count":2,"forks_count":19,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-02-26T20:07:48.574Z","etag":null,"topics":["agents","ai","anthropic","chromadb","deepseek","deepseek-r1","deepseek-reasoner","embeddings","gemeni","llm","ml","ollama","openai","xai"],"latest_commit_sha":null,"homepage":"https://notate.hairetsu.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CNTRLAI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-07T22:34:14.000Z","updated_at":"2025-02-26T08:23:49.000Z","dependencies_parsed_at":"2025-01-29T03:20:28.257Z","dependency_job_id":"7bcf6ad2-8810-48bc-96ec-b7066aee379e","html_url":"https://github.com/CNTRLAI/Notate","commit_stats":null,"previous_names":["cntrlai/notate"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CNTRLAI%2FNotate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CNTRLAI%2FNotate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CNTRLAI%2FNotate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CNTRLAI%2FNotate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CNTRLAI","download_url":"https://codeload.github.com/CNTRLAI/Notate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241678154,"owners_count":20001682,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agents","ai","anthropic","chromadb","deepseek","deepseek-r1","deepseek-reasoner","embeddings","gemeni","llm","ml","ollama","openai","xai"],"created_at":"2025-03-03T14:01:53.543Z","updated_at":"2025-03-03T14:02:51.293Z","avatar_url":"https://github.com/CNTRLAI.png","language":"TypeScript","funding_links":["https://www.paypal.com/donate/?hosted_button_id=W96TCRJ5Q3RJG"],"categories":["TypeScript"],"sub_categories":[],"readme":"# Notate\n\nNotate is a powerful, cross-platform chat application designed for seamless AI interactions. It combines enterprise-grade features with an intuitive interface, supporting a wide range of AI models and local deployment options.\n\n## Key Features\n\n- 🤖 **Multi-Model Support**: Integrate with leading AI providers including OpenAI, Anthropic, Google, XAI, OpenRouter, and DeepSeek\n- 🏠 **Local Deployment**: Run models locally using llamacpp, transformers, or ollama inference\n- 📚 **RAG Integration**: Built-in support for document Q\u0026A through ChromaDB integration\n- 🔧 **Flexible Configuration**: Custom API endpoints and comprehensive model settings\n- 🎯 **Advanced Features**: Experimental reasoning capabilities and developer API access\n- 🔒 **Privacy-Focused**: Local-only mode available for sensitive data handling\n\n## Quick Start\n\nDownload the latest version of Notate for your platform:\n\n- [Windows Installer](https://notate.hairetsu.com/download)\n- [macOS Installer](https://notate.hairetsu.com/download)\n- [Linux Deb](https://notate.hairetsu.com/download)\n\nFor detailed installation instructions, see our [Installation Guide](https://notate.hairetsu.com/docs/getting-started).\n\n## Documentation\n\n- [Getting Started](https://notate.hairetsu.com/docs/overview): A quick overview of Notate\n- [Installation Guide](https://notate.hairetsu.com/docs/getting-started): Detailed setup instructions\n- [Model Configuration](https://notate.hairetsu.com/docs/settings): Configure AI models and embeddings\n- [File Collections](https://notate.hairetsu.com/docs/collections): How to use File Collections\n- [File Collection Tools](https://notate.hairetsu.com/docs/collection-tools): Tools to ingest content from outside sources\n- [API Reference](https://notate.hairetsu.com/docs/developer-integration): Technical documentation for developers\n- [Troubleshooting](https://notate.hairetsu.com/docs/troubleshooting): Troubleshooting guide\n\nVisit our complete documentation at [https://notate.hairetsu.com/docs](https://notate.hairetsu.com/docs)\n\n## Community\n\nJoin our Discord community to get help, share feedback, and connect with other users and developers:\n[Discord Server](https://discord.gg/vEFAwB8wFC)\n\n## Support the Project\n\nIf you find this project helpful, consider supporting its development:\n\nDonations are used to cover the costs of running the project, including server costs, domain registration, signed certificates, and other expenses.\n\n[![PayPal](https://img.shields.io/badge/PayPal-donate-blue.svg)](https://www.paypal.com/donate/?hosted_button_id=W96TCRJ5Q3RJG)\n\n## Screenshots\n\n**Chat UI**\n![Notate Chat Screenshot](https://www.hairetsu.com/notate-12.png)\n\n**LLM Intergrations**\n![Notate LLM Intergrations Screenshot](https://www.hairetsu.com/notate-10.png)\n\n**Chat Settings**\n![Notate Collections Screenshot](https://www.hairetsu.com/notate-06.png)\n\n**Tool Settings**\n![Notate Collections Screenshot](https://www.hairetsu.com/notate-11.png)  \n\n**Ingestion from File or URL into ChromaDB**\n![Notate Data Intake Screenshot](https://www.hairetsu.com/notate-3.png)\n\n**Rag Chat Q/A**\n![Notate Collections Screenshot](https://www.hairetsu.com/notate-08.png)\n\n**Reasoning (Experimental)**\n![Notate Collections Screenshot](https://www.hairetsu.com/notate-09.png)\n\n**Dev API Key**\n![Notate Dev Screenshot](https://www.hairetsu.com/notate-2.png)\n\n### Local Only Mode Requirements\n\n_Windows CUDA_\n\n- Microsoft Visual Studio 2022 /w Desktop Development Tools C++ Build Tools\n- CUDA 12.6 toolkit or later\n\n_MacOS_\n\n- Xcode 15.0 or later\n\n- Python 3.12\n- Node.js v16 or higher\n- Package manager: npm or pnpm\n- At least 2GB of free disk space (Recommended 10GB+ minimum for local models and FileCollections)\n- Minimum 8GB RAM recommended\n- CPU: 4 cores or more\n- Nvidia RTX GPU recommended for local model inference 10GB VRAM or more preferably or Apple Silicon\n- Operating System:\n  - macOS 10.15 or later (Intel/Apple Silicon)\n  - Windows 10/11\n  - Linux\n\n### External Requirements\n\n- Python 3.12\n- Node.js v16 or higher\n- Package manager: npm or pnpm\n- CPU: 4 cores or more\n- MEMORY: 8GB RAM or more\n- DISK: 2GB free space (Recommended 4GB minimum for FileCollections)\n- OpenAI API key (optional)\n  - Required for OpenAI embeddings and GPT models\n  - Configure in settings after installation\n- Anthropic API key (optional)\n  - Required for Claude models\n  - Configure in settings after installation\n- Google API key (optional)\n  - Required for Google models\n  - Configure in settings after installation\n- XAI API key (optional)\n  - Required for XAI models\n  - Configure in settings after installation\n\n## Installation\n\n1. Clone the repository: `git clone https://github.com/CNTRLAI/Notate.git`\n2. Navigate to the electron project directory: `cd notate/Frontend`\n3. Install dependencies: `npm install` or `pnpm install`\n4. Build the frontend: `npm run build` or `pnpm run build`\n\n## Running the Application in Development Mode\n\n- Dev mode (macOS): `npm run dev:mac` or `pnpm run dev:mac`\n- Dev mode (Windows): `npm run dev:win` or `pnpm run dev:win`\n- Dev mode (Linux): `npm run dev:linux` or `pnpm run dev:linux`\n\n## Compiling to .exe, .dmg, and .AppImage\n\n- Production mode (macOS): `npm run dist:mac` or `pnpm run dist:mac`\n- Production mode (Windows): `npm run dist:win` or `pnpm run dist:win`\n- Production mode (Linux): `npm run dist:linux` or `pnpm run dist:linux`\n\n## Location of the Application\n\n(if Apple Silicon)\n\n- macOS: `Notate/Frontend/dist/mac-arm64/Notate.app`\n- macOS Installer: `Notate/Frontend/dist/Notate.dmg`\n\n(if Intel)\n\n- macOS: `Notate/Frontend/dist/mac/Notate.app`\n- macOS Installer: `Notate/Frontend/dist/Notate.dmg`\n\n(if Windows)\n\n- Executable: `Notate/Frontend/dist/Notate.exe`\n- Installer: `Notate/Frontend/dist/Notate.msi`\n\n(if Linux)\n\n- AppImage: `Notate/Frontend/dist/Notate.AppImage`\n- Debian Package: `Notate/Frontend/dist/Notate.deb`\n- RPM Package: `Notate/Frontend/dist/Notate.rpm`\n\n## Thanks\n\nSpecial thanks to our #1 beta tester Banks (@scallywag41) for their invaluable contributions and feedback during development.\n\n## Coming Soon\n\n- [ ] Chrome Extension For Ingesting Webpages/Files\n- [ ] Additional Agent Tools\n- [ ] Advanced Ingestion Settings\n- [ ] Additional Document Types\n- [ ] Output to Speech\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCNTRLAI%2FNotate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCNTRLAI%2FNotate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCNTRLAI%2FNotate/lists"}