Skip to content

Readme local install #872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Vasilije1990 merged 2 commits into from
May 26, 2025
Merged

Readme local install #872

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14be910
docs: Update README.md with local install info
dexters1 May 26, 2025
1dd6ea8
docs: Update README
dexters1 May 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

Build dynamic Agent memory 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)
More on [use-cases](https://docs.cognee.ai/use-cases) and [evals](https://github.com/topoteretes/cognee/tree/main/evals)

<p align="center">
🌐 Available Languages
Expand All @@ -41,7 +41,7 @@ More on [use-cases](https://docs.cognee.ai/use-cases) and [evals](https://github
·
<a href="assets/community/README.ru.md">🇷🇺 Русский</a>
</p>


<div style="text-align: center">
<img src="https://raw.githubusercontent.com/topoteretes/cognee/refs/heads/main/assets/cognee_benefits.png" alt="Why cognee?" width="50%" />
Expand Down Expand Up @@ -73,7 +73,7 @@ Your contributions are at the core of making this a true open source project. An

## 📦 Installation

You can install Cognee using either **pip**, **poetry**, **uv** or any other python package manager.
You can install Cognee using either **pip**, **poetry**, **uv** or any other python package manager.
Cognee supports Python 3.8 to 3.12

### With pip
Expand All @@ -82,6 +82,17 @@ Cognee supports Python 3.8 to 3.12
pip install cognee
```

## Local Cognee installation

You can install the local Cognee repo using **pip**, **poetry** and **uv**.
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
```

## 💻 Basic Usage

### Setup
Expand Down Expand Up @@ -127,12 +138,12 @@ 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 UI

You can also cognify your files and query using cognee UI.
You can also cognify your files and query using cognee UI.

<img src="assets/cognee-ui-2.webp" width="100%" alt="Cognee UI 2"></a>

Expand Down Expand Up @@ -175,4 +186,3 @@ We are committed to making open source an enjoyable and respectful experience fo
## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=topoteretes/cognee&type=Date)](https://star-history.com/#topoteretes/cognee&Date)

Loading