sqrl

(β˜… 222)

Agentic Data Engineering Harness for building data pipelines, data products, data APIs, and data lakes autonomously

  • .gitignore
  • .gitmodules
  • CLAUDE.md
  • codecov.yml
  • CONTRIBUTING.md
  • CONTRIBUTORS.md
  • Dockerfile.duckdb-extensions
  • Dockerfile.mcp-inspector
  • LICENSE
  • manual-tests.md
  • NOTICE.txt
  • playbook.md
  • pom.xml
  • README.md
  • RELEASE.md

# Installation Guide

1. Get the code
git clone https://github.com/DataSQRL/sqrl

Downloads the entire project code from GitHub to your computer.

cd sqrl

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
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 --rm -v $PWD:/workspace datasqrl/cmd init api messenger

Runs the built image as an actual container.

docker run -it --rm -p 8888:8888 -p 8081:8081 -v $PWD:/workspace datasqrl/cmd run messenger-prod-package.json

Runs the built image as an actual container.

docker run -it --rm -v $PWD:/workspace datasqrl/cmd test messenger-test-package.json

Runs the built image as an actual container.

docker run --rm -v $PWD:/build datasqrl/cmd compile messenger-prod-package.json

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.

3. Maven (Java)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
mvn clean install

Installs dependencies and builds the project using Maven.

βœ… A BUILD SUCCESS message means it worked. The output is created under target/.
// repository documentation