skardi

(โ˜… 99)

Skardi is an agent data plane that gives AI agents data autonomy.

  • .dockerignore
  • .gitignore
  • .pre-commit-config.yaml
  • AGENTS.md
  • Cargo.lock
  • Cargo.toml
  • Dockerfile
  • LICENSE
  • README.md
  • rust-toolchain.toml

# Installation Guide

1. Get the code
git clone https://github.com/SkardiLabs/skardi

Downloads the entire project code from GitHub to your computer.

cd skardi

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
cargo install --locked --path crates/cli

Builds and installs the package published on crates.io โ€” no need to clone the repo yourself.

โœ… 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 build -t skardi .

Builds a runnable image based on the Dockerfile.

docker build -t skardi --build-arg FEATURES=rag . # adds embedding + chunk UDFs

Builds a runnable image based on the Dockerfile.

docker pull ghcr.io/skardilabs/skardi/skardi-server:latest

Type this command into your terminal and run it.

docker pull ghcr.io/skardilabs/skardi/skardi-server-rag:latest # embedding + chunk UDFs

Type this command into your terminal and run it.

docker run --rm \

Runs the built image as an actual container.

โœ… 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. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo install --locked --path crates/cli

Builds and installs the package published on crates.io โ€” no need to clone the repo yourself.

cargo run --bin skardi-server -- --ctx ./ctx.yaml --port 8080

Builds and then immediately runs the program.

cargo run --bin skardi-server -- \

Builds and then immediately runs the program.

cargo build --release -p skardi-cli

Compiles the Rust project.

cargo build --release -p skardi-server

Compiles the Rust project.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation