mirror of
https://github.com/eliasstepanik/core.git
synced 2026-01-26 02:38:28 +00:00
Update README.md
Added Ask deepwiki badge in readme
This commit is contained in:
Manik Aggarwal
GitHub
parent
e6da6ad7c5
commit
5970cc0244
345
README.md
345
README.md
@ -27,174 +27,177 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</details>
|
</details>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<a href="https://core.heysol.ai">
|
<a href="https://core.heysol.ai">
|
||||||
<img src="https://github.com/user-attachments/assets/89066cdd-204b-46c2-8ad4-4935f5ca9edd" width="200px" alt="CORE logo" />
|
<img src="https://github.com/user-attachments/assets/89066cdd-204b-46c2-8ad4-4935f5ca9edd" width="200px" alt="CORE logo" />
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
### C.O.R.E: Your digital brain for the AI era
|
### C.O.R.E: Your digital brain for the AI era
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://docs.heysol.ai/core/overview"><b>Documentation</b></a> •
|
<img src="https://deepwiki.com/badge.svg" alt="DeepWiki Badge" />
|
||||||
<a href="https://discord.gg/YGUZcvDjUa"><b>Discord</b></a>
|
</p>
|
||||||
</p>
|
|
||||||
</div>
|
<p align="center">
|
||||||
|
<a href="https://docs.heysol.ai/core/overview"><b>Documentation</b></a> •
|
||||||
## 🧠 C.O.R.E.
|
<a href="https://discord.gg/YGUZcvDjUa"><b>Discord</b></a>
|
||||||
|
</div>
|
||||||
**Contextual Observation & Recall Engine**
|
|
||||||
|
## 🧠 C.O.R.E.
|
||||||
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:
|
|
||||||
|
**Contextual Observation & Recall Engine**
|
||||||
- **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.
|
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:
|
||||||
- **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.
|
|
||||||
|
- **Unified, Portable Memory**: Add and recall context seamlessly, and connect your memory across apps like Claude, Cursor, Windsurf and more.
|
||||||
## 🎥 Demo Video
|
- **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.
|
||||||
[Check C.O.R.E Demo](https://youtu.be/iANZ32dnK60)
|
|
||||||
|
## 🎥 Demo Video
|
||||||
<img width="954" height="700" alt="Core dashboard" src="https://github.com/user-attachments/assets/d684b708-6907-47be-9499-a30b25434694" />
|
|
||||||
|
[Check C.O.R.E Demo](https://youtu.be/iANZ32dnK60)
|
||||||
## 🧩 Key Features
|
|
||||||
|
<img width="954" height="700" alt="Core dashboard" src="https://github.com/user-attachments/assets/d684b708-6907-47be-9499-a30b25434694" />
|
||||||
- **Memory Graph**: Visualise how your facts and preferences link together
|
|
||||||
- **Chat with Memory**: Ask questions about memory for instant insights and understanding
|
## 🧩 Key Features
|
||||||
- **Plug n Play**: Instantly use CORE memory in apps like Cursor, Claude
|
|
||||||
|
- **Memory Graph**: Visualise how your facts and preferences link together
|
||||||
## ☁️ C.O.R.E Cloud Setup
|
- **Chat with Memory**: Ask questions about memory for instant insights and understanding
|
||||||
|
- **Plug n Play**: Instantly use CORE memory in apps like Cursor, Claude
|
||||||
1. Sign up to [Core Cloud](https://core.heysol.ai) and start building your memory graph.
|
|
||||||
2. Add your text that you want to save in memory. Once clicking on `+ Add` button your memory graph will be generated.
|
## ☁️ C.O.R.E Cloud Setup
|
||||||
3. [Connect Core Memory MCP with Cursor](#connecting-core-mcp-with-cursor)
|
|
||||||
|
1. Sign up to [Core Cloud](https://core.heysol.ai) and start building your memory graph.
|
||||||
## 💻 C.O.R.E Local Setup
|
2. Add your text that you want to save in memory. Once clicking on `+ Add` button your memory graph will be generated.
|
||||||
|
3. [Connect Core Memory MCP with Cursor](#connecting-core-mcp-with-cursor)
|
||||||
#### Prerequisites
|
|
||||||
|
## 💻 C.O.R.E Local Setup
|
||||||
1. Docker
|
|
||||||
2. OpenAI API Key
|
#### Prerequisites
|
||||||
|
|
||||||
|
1. Docker
|
||||||
> **Note:** We are actively working on improving support for Llama models. At the moment, C.O.R.E does not provide optimal results with Llama-based models, but we are making progress to ensure better compatibility and output in the near future.
|
2. OpenAI API Key
|
||||||
>
|
|
||||||
#### Run C.O.R.E locally
|
|
||||||
|
> **Note:** We are actively working on improving support for Llama models. At the moment, C.O.R.E does not provide optimal results with Llama-based models, but we are making progress to ensure better compatibility and output in the near future.
|
||||||
1. **Copy Environment Variables**
|
>
|
||||||
|
#### Run C.O.R.E locally
|
||||||
Copy the example environment file to `.env`:
|
|
||||||
|
1. **Copy Environment Variables**
|
||||||
```bash
|
|
||||||
cp .env.example .env
|
Copy the example environment file to `.env`:
|
||||||
```
|
|
||||||
|
```bash
|
||||||
2. **Start the Application**
|
cp .env.example .env
|
||||||
|
```
|
||||||
Use Docker Compose to start all required services:
|
|
||||||
|
2. **Start the Application**
|
||||||
```bash
|
|
||||||
docker-compose up
|
Use Docker Compose to start all required services:
|
||||||
```
|
|
||||||
|
```bash
|
||||||
3. **Access the App**
|
docker-compose up
|
||||||
|
```
|
||||||
Once the containers are running, open your browser and go to [http://localhost:3000](http://localhost:3000).
|
|
||||||
|
3. **Access the App**
|
||||||
4. **Create Account with Magic Link**
|
|
||||||
|
Once the containers are running, open your browser and go to [http://localhost:3000](http://localhost:3000).
|
||||||
- To Create an account, click on `Continue with email` button
|
|
||||||
|
4. **Create Account with Magic Link**
|
||||||
<img width="865" height="490" alt="Create account" src="https://github.com/user-attachments/assets/65de110b-2b1f-42a5-9b8a-954227d68d52" />
|
|
||||||
|
- To Create an account, click on `Continue with email` button
|
||||||
- Enter your email and click on `Send a Magic Link` button
|
|
||||||
|
<img width="865" height="490" alt="Create account" src="https://github.com/user-attachments/assets/65de110b-2b1f-42a5-9b8a-954227d68d52" />
|
||||||
<img width="824" height="429" alt="Enter email" src="https://github.com/user-attachments/assets/76128b61-2086-48df-8332-38c2efa14087" />
|
|
||||||
|
- Enter your email and click on `Send a Magic Link` button
|
||||||
- `Copy the magic link from terminal logs` and open it in your browser
|
|
||||||
|
<img width="824" height="429" alt="Enter email" src="https://github.com/user-attachments/assets/76128b61-2086-48df-8332-38c2efa14087" />
|
||||||
<img width="1010" height="597" alt="Magic link" src="https://github.com/user-attachments/assets/777cb4b1-bb93-4d54-b6ab-f7147e65aa5c" />
|
|
||||||
|
- `Copy the magic link from terminal logs` and open it in your browser
|
||||||
|
|
||||||
5. **Create Your Private Space & Add Data**
|
<img width="1010" height="597" alt="Magic link" src="https://github.com/user-attachments/assets/777cb4b1-bb93-4d54-b6ab-f7147e65aa5c" />
|
||||||
|
|
||||||
- In the dashboard, go to the top right section -> Type a message, e.g., `I love playing badminton`, and click `+Add`.
|
|
||||||
- Your memory is queued for processing; you can monitor its status in the `Logs` section.
|
5. **Create Your Private Space & Add Data**
|
||||||
|
|
||||||
<img width="1496" height="691" alt="Core memory logs" src="https://github.com/user-attachments/assets/dc34a7af-fe52-4142-9ecb-49ddc4e0e854" />
|
- In the dashboard, go to the top right section -> Type a message, e.g., `I love playing badminton`, and click `+Add`.
|
||||||
|
- Your memory is queued for processing; you can monitor its status in the `Logs` section.
|
||||||
- Once processing is complete, nodes will be added to your private knowledge graph and visible in the dashboard.
|
|
||||||
- You can later choose to connect this memory to other tools or keep it private.
|
<img width="1496" height="691" alt="Core memory logs" src="https://github.com/user-attachments/assets/dc34a7af-fe52-4142-9ecb-49ddc4e0e854" />
|
||||||
|
|
||||||
6. **Search Your Memory**
|
- Once processing is complete, nodes will be added to your private knowledge graph and visible in the dashboard.
|
||||||
|
- You can later choose to connect this memory to other tools or keep it private.
|
||||||
- Use the dashboard's search feature to query your ingested data within your private space.
|
|
||||||
|
6. **Search Your Memory**
|
||||||
|
|
||||||
## Connecting CORE MCP with Cursor
|
- Use the dashboard's search feature to query your ingested data within your private space.
|
||||||
|
|
||||||
1. Open the CORE dashboard and navigate to the API section to generate a new API token.
|
|
||||||
2. In Cursor, go to: Settings → Tools & Integrations → New MCP Server.
|
## Connecting CORE MCP with Cursor
|
||||||
3. Add the CORE MCP server using the configuration format below. Be sure to replace the API_TOKEN value with the token you generated in step 1.
|
|
||||||
|
1. Open the CORE dashboard and navigate to the API section to generate a new API token.
|
||||||
MCP configuration to add in Cursor
|
2. In Cursor, go to: Settings → Tools & Integrations → New MCP Server.
|
||||||
|
3. Add the CORE MCP server using the configuration format below. Be sure to replace the API_TOKEN value with the token you generated in step 1.
|
||||||
```json
|
|
||||||
{
|
MCP configuration to add in Cursor
|
||||||
"mcpServers": {
|
|
||||||
"memory": {
|
```json
|
||||||
"command": "npx",
|
{
|
||||||
"args": ["-y", "@redplanethq/core-mcp"],
|
"mcpServers": {
|
||||||
"env": {
|
"memory": {
|
||||||
"API_TOKEN": "YOUR_API_TOKEN_HERE",
|
"command": "npx",
|
||||||
"API_BASE_URL": "https://core.heysol.ai",
|
"args": ["-y", "@redplanethq/core-mcp"],
|
||||||
"SOURCE": "cursor"
|
"env": {
|
||||||
}
|
"API_TOKEN": "YOUR_API_TOKEN_HERE",
|
||||||
}
|
"API_BASE_URL": "https://core.heysol.ai",
|
||||||
}
|
"SOURCE": "cursor"
|
||||||
}
|
}
|
||||||
```
|
}
|
||||||
|
}
|
||||||
4. Go to Settings-> User rules -> New Rule -> and add the below rule to ensure all your chat interactions are being stored in CORE memory
|
}
|
||||||
|
```
|
||||||
```
|
|
||||||
After every interaction, update the memory with the user's query and the assistant's
|
4. Go to Settings-> User rules -> New Rule -> and add the below rule to ensure all your chat interactions are being stored in CORE memory
|
||||||
response to core-memory mcp. sessionId should be the uuid of the conversation
|
|
||||||
```
|
```
|
||||||
|
After every interaction, update the memory with the user's query and the assistant's
|
||||||
## Documentation
|
response to core-memory mcp. sessionId should be the uuid of the conversation
|
||||||
|
```
|
||||||
Explore our documentation to get the most out of CORE
|
|
||||||
- [Basic Concepts](https://docs.heysol.ai/core/overview)
|
## Documentation
|
||||||
- [API Reference](https://docs.heysol.ai/core/local-setup)
|
|
||||||
- [Connect Core Memory MCP with Cursor](#connecting-core-mcp-with-cursor)
|
Explore our documentation to get the most out of CORE
|
||||||
|
- [Basic Concepts](https://docs.heysol.ai/core/overview)
|
||||||
|
- [API Reference](https://docs.heysol.ai/core/local-setup)
|
||||||
## 🧑💻 Support
|
- [Connect Core Memory MCP with Cursor](#connecting-core-mcp-with-cursor)
|
||||||
Have questions or feedback? We're here to help:
|
|
||||||
- Discord: [Join core-support channel](https://discord.gg/YGUZcvDjUa)
|
|
||||||
- Documentation: [docs.heysol.ai/core](https://docs.heysol.ai/core/overview)
|
## 🧑💻 Support
|
||||||
- Email: manik@poozle.dev
|
Have questions or feedback? We're here to help:
|
||||||
|
- Discord: [Join core-support channel](https://discord.gg/YGUZcvDjUa)
|
||||||
## Usage Guidelines
|
- Documentation: [docs.heysol.ai/core](https://docs.heysol.ai/core/overview)
|
||||||
|
- Email: manik@poozle.dev
|
||||||
**Store:**
|
|
||||||
|
## Usage Guidelines
|
||||||
- Conversation history
|
|
||||||
- User preferences
|
**Store:**
|
||||||
- Task context
|
|
||||||
- Reference materials
|
- Conversation history
|
||||||
|
- User preferences
|
||||||
**Don't Store:**
|
- Task context
|
||||||
|
- Reference materials
|
||||||
- Sensitive data (PII)
|
|
||||||
- Credentials
|
**Don't Store:**
|
||||||
- System logs
|
|
||||||
- Temporary data
|
- Sensitive data (PII)
|
||||||
|
- Credentials
|
||||||
## 👥 Contributors
|
- System logs
|
||||||
|
- Temporary data
|
||||||
<a href="https://github.com/RedPlanetHQ/core/graphs/contributors">
|
|
||||||
<img src="https://contrib.rocks/image?repo=RedPlanetHQ/core" />
|
## 👥 Contributors
|
||||||
</a>
|
|
||||||
|
<a href="https://github.com/RedPlanetHQ/core/graphs/contributors">
|
||||||
|
<img src="https://contrib.rocks/image?repo=RedPlanetHQ/core" />
|
||||||
|
</a>
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user