core/README.md
Harshith Mullapudi 2a6acaf899
Feat: webhooks for oauth apps (#32)
* Fix: integration account webhooks

* Fix: activity webhook

* Feat: add integration credentials API

* Fix: user rules for integrations

* Feat: make self hosting simple

* Fix: add init container functionality

---------

Co-authored-by: Manoj K <saimanoj58@gmail.com>
2025-08-01 10:34:16 +05:30

125 lines
5.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div align="right">
<details>
<summary >🌐 Language</summary>
<div>
<div align="center">
<a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=en">English</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=zh-CN">简体中文</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=zh-TW">繁體中文</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=ja">日本語</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=ko">한국어</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=hi">हिन्दी</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=th">ไทย</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=fr">Français</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=de">Deutsch</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=es">Español</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=it">Italiano</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=ru">Русский</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=pt">Português</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=nl">Nederlands</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=pl">Polski</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=ar">العربية</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=fa">فارسی</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=tr">Türkçe</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=vi">Tiếng Việt</a>
| <a href="https://openaitx.github.io/view.html?user=RedPlanetHQ&project=core&lang=id">Bahasa Indonesia</a>
</div>
</div>
</details>
</div>
<div align="center">
<a href="https://core.heysol.ai">
<img src="https://github.com/user-attachments/assets/89066cdd-204b-46c2-8ad4-4935f5ca9edd" width="200px" alt="CORE logo" />
</a>
### C.O.R.E: Your digital brain for the AI era
<p align="center">
<a href="https://deepwiki.com/RedPlanetHQ/core">
<img src="https://deepwiki.com/badge.svg" alt="DeepWiki Badge" />
</a>
</p>
<p align="center">
<a href="https://docs.heysol.ai/core/overview"><b>Documentation</b></a>
<a href="https://discord.gg/YGUZcvDjUa"><b>Discord</b></a>
</p>
</div>
## 🧠 C.O.R.E.
**Contextual Observation & Recall Engine**
C.O.R.E is a portable memory graph built from your llm interactions and personal data, making all your context and workflow history accessible to any AI tool, just like a digital brain. This eliminates the need for repeated context sharing . The aim is to provide:
- **Unified, Portable Memory**: Add and recall context seamlessly, and connect your memory across apps like Claude, Cursor, Windsurf and more.
- **Relational, Not just Flat Facts**: CORE organizes your knowledge, storing both facts and relationships for a deeper richer memory like a real brain.
- **User Owned**: You decide what to keep, update or delete and share your memory across the tool you want and be freed from vendor lock-in.
## 🎥 Demo Video
[Check C.O.R.E Demo](https://youtu.be/iANZ32dnK60)
<img width="7480" height="4672" alt="core-memory-graph" src="https://github.com/user-attachments/assets/2b159e87-38ce-4cc6-ac16-047f645c3a4b" />
## 🧩 Key Features
- **Memory Graph**: Visualise how your facts and preferences link together
- **Chat with Memory**: Ask questions about memory for instant insights and understanding
- **Plug n Play**: Instantly use CORE memory in apps like Cursor, Claude
## ☁️ C.O.R.E Cloud Setup
1. Visit [core.heysol.ai](https://core.heysol.ai)
2. Sign up with your email
3. Tell CORE about yourself: “Im a software engineer working on a React project called TaskMaster. I prefer TypeScript and use Tailwind for styling.”
<img width="2048" height="1172" alt="add-memory" src="https://github.com/user-attachments/assets/a2b27235-23a2-41c1-a09a-aa5b9f6d4938" />
4. [Connect Core MCP with Claude](https://docs.heysol.ai/providers/claude)
5. [Connect Core MCP with Cursor](https://docs.heysol.ai/providers/cursor)
## 💻 C.O.R.E Self Hosting
Check out our [docs](https://docs.heysol.ai/self-hosting/docker) for modular deployment
## Documentation
Explore our documentation to get the most out of CORE
- [Basic Concepts](https://docs.heysol.ai/concepts/memory_graph)
- [Self Hosting](https://docs.heysol.ai/self-hosting/overview)
- [Connect Core MCP with Claude](https://docs.heysol.ai/providers/claude)
- [Connect Core MCP with Cursor](https://docs.heysol.ai/providers/cursor)
- [Basic Concepts](https://docs.heysol.ai/overview)
- [API Reference](https://docs.heysol.ai/local-setup)
## 🧑‍💻 Support
Have questions or feedback? We're here to help:
- Discord: [Join core-support channel](https://discord.gg/YGUZcvDjUa)
- Documentation: [docs.heysol.ai](https://docs.heysol.ai)
- Email: manik@poozle.dev
## Usage Guidelines
**Store:**
- Conversation history
- User preferences
- Task context
- Reference materials
**Don't Store:**
- Sensitive data (PII)
- Credentials
- System logs
- Temporary data
## 👥 Contributors
<a href="https://github.com/RedPlanetHQ/core/graphs/contributors">
<img src="https://contrib.rocks/image?repo=RedPlanetHQ/core" />
</a>