SAG

(★ 2,404)

A new SOTA for RAG — an original retrieval architecture and an open-source knowledge base for humans and agents.

  • .env.example
  • .gitignore
  • .public-sync-state.json
  • CHANGELOG.md
  • compose.dify.yaml
  • compose.postgres.yaml
  • compose.yaml
  • CONTRIBUTING.md
  • LICENSE
  • Makefile
  • README-CN.md
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/Zleap-AI/SAG

Downloads the entire project code from GitHub to your computer.

cd SAG

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
  • Python 3 Python is required to use pip.
npm install --global @zleap-ai/sag-cli

Installs the package published on the npm registry globally — no need to clone the source.

pip install zleap-sag

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 compose up -d --build

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

docker compose ps # api and web should be healthy

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

docker compose logs -f api web # follow logs

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

docker compose restart # restart services

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

docker compose down # stop and keep all data

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. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install --global @zleap-ai/sag-cli

Installs the package published on the npm registry globally — no need to clone the source.

SKILL_SRC="$(npm root -g)/@zleap-ai/sag-cli"

Type this command into your terminal and run it.

npm install

Downloads and installs the libraries listed in package.json.

npm run dev

Starts the development/run server.

cd apps/web && npm run typecheck

Moves into the project folder you just downloaded.

After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. 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.
python -m venv .venv

Runs the Python script (or module).

pip install -e ".[dev]"

Installs the Python libraries listed in requirements.txt (or similar).

pip install zleap-sag

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.

6. 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