rocky

(★ 294)

A SQL transformation engine that type-checks your whole pipeline and catches breaking changes before they run — branches, replay, column-level lineage, compile-time contracts, per-model cost. Adapters: Databricks, Snowflake, BigQuery, DuckDB. Single static Rust binary. Apache 2.0.

Showing a partial file list — download the zip above to see everything.

  • .gitattributes
  • .gitignore
  • .taplo.toml
  • AGENT_REVIEW.md
  • AGENTS.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CODEX_REVIEW.md
  • CONTRIBUTING.md
  • LICENSE
  • PARITY.md
  • README.md
  • RELEASE_SMOKE.md
  • ROCKY_EXPLAINED.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/rocky-data/rocky

Downloads the entire project code from GitHub to your computer.

cd rocky

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
curl -fsSL https://raw.githubusercontent.com/rocky-data/rocky/main/engine/install.sh | bash

Downloads and runs the official install script in one line — this handles the full setup automatically.

irm https://raw.githubusercontent.com/rocky-data/rocky/main/engine/install.ps1 | iex

Downloads and runs the official install script via PowerShell — this handles the full setup automatically.

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.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker compose -f deploy/observability/compose.yaml up -d --build

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.

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.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd editors/vscode

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

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

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.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install .

Installs the package published on PyPI directly — no need to clone the source.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

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

6. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cd engine

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation