From 2769b5b9ef25b261c34e94556acf1f2d8cfde4ae Mon Sep 17 00:00:00 2001
From: Vasilije <8619304+Vasilije1990@users.noreply.github.com>
Date: Wed, 24 Sep 2025 19:42:27 +0200
Subject: [PATCH 01/14] feat: Revise README for installation and CLI usage
Updated installation instructions and usage examples in README.
---
README.md | 47 +++++++++++++++++++++++++++++------------------
1 file changed, 29 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index 30f829c93..426d3eb55 100644
--- a/README.md
+++ b/README.md
@@ -95,24 +95,15 @@ Your contributions are at the core of making this a true open source project. An
You can install Cognee using either **pip**, **poetry**, **uv** or any other python package manager.
-Cognee supports Python 3.10 to 3.13
+Cognee supports Python 3.10 to 3.12
-### With pip
+### With uv
```bash
-pip install cognee
+uv pip install cognee
```
-## Local Cognee installation
-
-You can install the local Cognee repo using **uv**, **pip** and **poetry**.
-For local pip installation please make sure your pip version is above version 21.3.
-
-### with UV with all optional dependencies
-
-```bash
-uv sync --all-extras
-```
+Detailed instructions can be found in our [docs](https://docs.cognee.ai/getting-started/installation#environment-configuration)
## 💻 Basic Usage
@@ -125,11 +116,28 @@ os.environ["LLM_API_KEY"] = "YOUR OPENAI_API_KEY"
```
You can also set the variables by creating .env file, using our template.
-To use different LLM providers, for more info check out our documentation
+To use different LLM providers, for more info check out our documentation
### Simple example
+
+## Via CLI
+
+These commands will show you the basics of cognee CLI
+
+```
+cognee-cli add "Cognee turns documents into AI memory."
+
+cognee-cli cognify
+
+cognee-cli search "What does cognee do?"
+cognee-cli delete --all
+
+```
+
+## Python
+
This script will run the default pipeline:
```python
@@ -139,13 +147,16 @@ import asyncio
async def main():
# Add text to cognee
- await cognee.add("Natural language processing (NLP) is an interdisciplinary subfield of computer science and information retrieval.")
+ await cognee.add("Cognee turns documents into AI memory.")
# Generate the knowledge graph
await cognee.cognify()
+ # Add memory algorithms to the graph
+ await cognee.memify()
+
# Query the knowledge graph
- results = await cognee.search("Tell me about NLP")
+ results = await cognee.search("What does cognee do?")
# Display the results
for result in results:
@@ -158,7 +169,7 @@ if __name__ == '__main__':
```
Example output:
```
- Natural Language Processing (NLP) is a cross-disciplinary and interdisciplinary field that involves computer science and information retrieval. It focuses on the interaction between computers and human language, enabling machines to understand and process natural language.
+ Cognee turns documents into AI memory.
```
@@ -178,7 +189,7 @@ You can also cognify your files and query using cognee UI.
### Running the UI
-Try cognee UI by setting LLM_API_KEY and running ``` cognee-cli -ui ``` command on your terminal.
+Try cognee UI by setting your LLM_API_KEY and running ``` cognee-cli -ui ``` command on your terminal.
## Understand our architecture
From 7620f46820955e42bdbeffb351c2259f7901e342 Mon Sep 17 00:00:00 2001
From: Vasilije <8619304+Vasilije1990@users.noreply.github.com>
Date: Wed, 24 Sep 2025 19:43:25 +0200
Subject: [PATCH 02/14] Change section headers from H2 to H4
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 426d3eb55..bd4f713ad 100644
--- a/README.md
+++ b/README.md
@@ -122,7 +122,7 @@ To use different LLM providers, for more info check out our documentation
-### Simple example
+#### Simple example
-#### Via CLI
+##### Via CLI
These commands will show you the basics of cognee CLI
@@ -134,9 +139,13 @@ cognee-cli cognify
cognee-cli search "What does cognee do?"
cognee-cli delete --all
+```
+or run
+```
+cognee-cli -ui
```
-#### Python
+##### Python
This script will run the default pipeline:
@@ -173,29 +182,18 @@ Example output:
```
-## Our paper is out! Read here
-
-
-
+Get up and running in minutes with automatic updates, analytics, and enterprise security.
-### Running the UI
+1. Sign up on [cogwit](https://www.cognee.ai)
+2. Add your API key to local UI and sync your data or send your data to Cogwit API
-Try cognee UI by setting your LLM_API_KEY and running ``` cognee-cli -ui ``` command on your terminal.
-
-## Understand our architecture
-
-
-
-
-## Sponsors
+## Citation
-Thanks to the following companies for sponsoring the ongoing development of cognee.
+We now have a paper you can cite:
-- [GitHub's Secure Open Source Fund](https://resources.github.com/github-secure-open-source-fund/)
-
-## Star History
-
-[](https://star-history.com/#topoteretes/cognee&Date)
+```bibtex
+@misc{markovic2025optimizinginterfaceknowledgegraphs,
+ title={Optimizing the Interface Between Knowledge Graphs and LLMs for Complex Reasoning},
+ author={Vasilije Markovic and Lazar Obradovic and Laszlo Hajdu and Jovan Pavlovic},
+ year={2025},
+ eprint={2505.24478},
+ archivePrefix={arXiv},
+ primaryClass={cs.AI},
+ url={https://arxiv.org/abs/2505.24478},
+}
+```
From 694fc7fb5b7b8dc98efd0e5175ecbe5afb8c7683 Mon Sep 17 00:00:00 2001
From: Vasilije <8619304+Vasilije1990@users.noreply.github.com>
Date: Wed, 24 Sep 2025 20:06:19 +0200
Subject: [PATCH 04/14] Remove contributors section from README
Removed contributors section from README.
---
README.md | 6 ------
1 file changed, 6 deletions(-)
diff --git a/README.md b/README.md
index 744c54ecd..433b75226 100644
--- a/README.md
+++ b/README.md
@@ -216,12 +216,6 @@ Get up and running in minutes with automatic updates, analytics, and enterprise
We are committed to making open source an enjoyable and respectful experience for our community. See CODE_OF_CONDUCT for more information.
-## 💫 Contributors
-
-
-
-
-
## Citation
We now have a paper you can cite:
From 311085b2f3fdbeb3ded3e2b49ee5f4ea922c7963 Mon Sep 17 00:00:00 2001
From: Vasilije <8619304+Vasilije1990@users.noreply.github.com>
Date: Wed, 24 Sep 2025 20:07:22 +0200
Subject: [PATCH 05/14] Update usage instructions in README
Clarified instructions for using the self-hosted package and deployment.
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 433b75226..bf9039c8f 100644
--- a/README.md
+++ b/README.md
@@ -89,8 +89,8 @@ Your contributions are at the core of making this a true open source project. An
## Using cognee
-Start with our self-hosted package and UI and deploy it to our hosted solution with one click once you want to move to production.
-
+Start with our self-hosted package and UI.
+Deploy your data to our hosted solution with one click once you want to move to production.
## Self-Hosted (Open Source)
From 867e216befb88628ad63b7b86e47b73b8ea7ead5 Mon Sep 17 00:00:00 2001
From: Vasilije <8619304+Vasilije1990@users.noreply.github.com>
Date: Wed, 24 Sep 2025 20:12:40 +0200
Subject: [PATCH 06/14] Enhance README with cognee usage details
Expanded the 'Using cognee' section with details on self-hosted package and production readiness.
---
README.md | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index bf9039c8f..ffd0e98c1 100644
--- a/README.md
+++ b/README.md
@@ -89,8 +89,15 @@ Your contributions are at the core of making this a true open source project. An
## Using cognee
-Start with our self-hosted package and UI.
-Deploy your data to our hosted solution with one click once you want to move to production.
+Start with our self-hosted package:
+ - UI and embedded Python notebooks
+ - Custom memory components you can add yourself
+ - Distributed cognee to process a TBs of your data
+
+Ready for production:
+ - Sync your local data to our [hosted solution](www.cognee.ai)
+ - Get your API endpoint
+ - Secure and protected, and multi-tenant
## Self-Hosted (Open Source)
From e62339d333a50bf51e29b270e752557dd61e038d Mon Sep 17 00:00:00 2001
From: Vasilije <8619304+Vasilije1990@users.noreply.github.com>
Date: Wed, 24 Sep 2025 20:16:31 +0200
Subject: [PATCH 07/14] Revise cognee usage details in README
Updated the features and benefits of using cognee in the README.
---
README.md | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index ffd0e98c1..c90b76a15 100644
--- a/README.md
+++ b/README.md
@@ -90,14 +90,15 @@ Your contributions are at the core of making this a true open source project. An
## Using cognee
Start with our self-hosted package:
- - UI and embedded Python notebooks
- - Custom memory components you can add yourself
- - Distributed cognee to process a TBs of your data
+ - Get self-serve UI with embedded Python notebooks
+ - Add custom tasks and pipelines
+ - Docker images and MCP servers you can deploy
+ - Use distributed cognee to process a TBs of your data
Ready for production:
- Sync your local data to our [hosted solution](www.cognee.ai)
- - Get your API endpoint
- - Secure and protected, and multi-tenant
+ - Get a secure API endpoint
+ - We manage the UI for you
## Self-Hosted (Open Source)
From e286949af867b52d21bcb0cb2bed3364a133fb0d Mon Sep 17 00:00:00 2001
From: Vasilije <8619304+Vasilije1990@users.noreply.github.com>
Date: Wed, 24 Sep 2025 20:17:25 +0200
Subject: [PATCH 08/14] Restore contributing section in README.md
---
README.md | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index c90b76a15..f11f2efa3 100644
--- a/README.md
+++ b/README.md
@@ -82,11 +82,6 @@ More on [use-cases](https://docs.cognee.ai/use-cases) and [evals](https://github
Get started quickly with a Google Colab notebook , Deepnote notebook or starter repo
-
-
-## Contributing
-Your contributions are at the core of making this a true open source project. Any contributions you make are **greatly appreciated**. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more information.
-
## Using cognee
Start with our self-hosted package:
@@ -220,6 +215,10 @@ Get up and running in minutes with automatic updates, analytics, and enterprise
[cognee with local models](https://github.com/user-attachments/assets/8621d3e8-ecb8-4860-afb2-5594f2ee17db)
+## Contributing
+Your contributions are at the core of making this a true open source project. Any contributions you make are **greatly appreciated**. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more information.
+
+
## Code of Conduct
We are committed to making open source an enjoyable and respectful experience for our community. See CODE_OF_CONDUCT for more information.
From 8adfa8e2a585662c42878f30322a2c004a2b9c76 Mon Sep 17 00:00:00 2001
From: Vasilije <8619304+Vasilije1990@users.noreply.github.com>
Date: Wed, 24 Sep 2025 20:18:23 +0200
Subject: [PATCH 09/14] Simplify data sync instructions in README
Updated instructions for syncing data with Cogwit API.
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index f11f2efa3..61ce504bc 100644
--- a/README.md
+++ b/README.md
@@ -195,7 +195,7 @@ Example output:
Get up and running in minutes with automatic updates, analytics, and enterprise security.
1. Sign up on [cogwit](https://www.cognee.ai)
-2. Add your API key to local UI and sync your data or send your data to Cogwit API
+2. Add your API key to local UI and sync your data to Cogwit
From c4b2ce0d1aee7cb97cd02bf801b3ed78055580b0 Mon Sep 17 00:00:00 2001
From: Vasilije <8619304+Vasilije1990@users.noreply.github.com>
Date: Wed, 24 Sep 2025 20:19:58 +0200
Subject: [PATCH 10/14] Revise README for self-hosted and hosted platform
Updated sections on self-hosted package and hosted platform.
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 61ce504bc..4a1690746 100644
--- a/README.md
+++ b/README.md
@@ -84,13 +84,13 @@ Get started quickly with a Google Colab
Date: Wed, 24 Sep 2025 20:25:47 +0200
Subject: [PATCH 12/14] Revise CLI commands section in README
Reorganize CLI usage section in README for clarity.
---
README.md | 33 ++++++++++++++++-----------------
1 file changed, 16 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index e783c00f9..f3e32bb35 100644
--- a/README.md
+++ b/README.md
@@ -130,23 +130,6 @@ To use different LLM providers, for more info check out our
From 2437892766d2e7de1c966333c99f15bcf5094219 Mon Sep 17 00:00:00 2001
From: Vasilije <8619304+Vasilije1990@users.noreply.github.com>
Date: Wed, 24 Sep 2025 20:26:30 +0200
Subject: [PATCH 13/14] Remove beta launch announcement from README
Removed announcement for Cogwit beta launch.
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index f3e32bb35..d8338b979 100644
--- a/README.md
+++ b/README.md
@@ -43,7 +43,7 @@
-**🚀 We launched Cogwit beta (Fully-hosted AI Memory): Sign up [here](https://platform.cognee.ai/)! 🚀**
+
Build dynamic memory for Agents and replace RAG using scalable, modular ECL (Extract, Cognify, Load) pipelines.
From 9c3fa87e5c3149647c74130aec7b1fcdfc9cb579 Mon Sep 17 00:00:00 2001
From: Vasilije <8619304+Vasilije1990@users.noreply.github.com>
Date: Wed, 24 Sep 2025 20:29:09 +0200
Subject: [PATCH 14/14] Revise README for SDK and use-case links
Updated README to reflect changes in SDK usage and links.
---
README.md | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index d8338b979..59f58d68a 100644
--- a/README.md
+++ b/README.md
@@ -47,8 +47,6 @@
Build dynamic memory for Agents and replace RAG using scalable, modular ECL (Extract, Cognify, Load) pipelines.
-More on [use-cases](https://docs.cognee.ai/use-cases) and [evals](https://github.com/topoteretes/cognee/tree/main/evals)
-
🌐 Available Languages
:
@@ -86,9 +84,10 @@ Get started quickly with a Google Colab