graphiti

(β˜… 30,164)

Build Real-Time Knowledge Graphs for AI Agents

  • .env.example
  • .gitignore
  • AGENTS.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • conftest.py
  • CONTRIBUTING.md
  • depot.json
  • docker-compose.test.yml
  • docker-compose.yml
  • Dockerfile
  • ellipsis.yaml
  • LICENSE
  • Makefile
  • OTEL_TRACING.md
  • py.typed
  • pyproject.toml
  • pytest.ini
  • README.md
  • SECURITY.md
  • uv.lock
  • Zep-CLA.md

# Installation Guide

1. Get the code
git clone https://github.com/getzep/graphiti

Downloads the entire project code from GitHub to your computer.

cd graphiti

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install graphiti-core

Installs the package published on PyPI directly β€” no need to clone the source.

pip install graphiti-core[falkordb]

Installs the package published on PyPI directly β€” no need to clone the source.

pip install graphiti-core[falkordblite]

Installs the package published on PyPI directly β€” no need to clone the source.

pip install graphiti-core[kuzu]

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
> docker run -p 6379:6379 -p 3000:3000 -it --rm falkordb/falkordb:latest

Runs the built image as an actual container.

docker compose up

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose --profile falkordb up

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install graphiti-core

Installs the package published on PyPI directly β€” no need to clone the source.

pip install graphiti-core[falkordb]

Installs the package published on PyPI directly β€” no need to clone the source.

pip install graphiti-core[falkordblite]

Installs the package published on PyPI directly β€” no need to clone the source.

pip install graphiti-core[kuzu]

Installs the package published on PyPI directly β€” no need to clone the source.

pip install graphiti-core[neptune]

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation