Getting Started¶

Prerequisites¶

Squareberg requires only two things:

Tool	Minimum version	Notes
Python	3.10	3.12 recommended
`uv`	latest	Python package manager

Install uv if you don't have it:

curl -LsSf https://astral.sh/uv/install.sh | sh

Node.js is not required — the dashboard is bundled as pre-built static files.

uv tool install squareberg-hub

This installs the sqb command globally. Verify:

sqb --help

sqb start

The hub starts at http://127.0.0.1:9100. Open it in your browser to see the dashboard.

Foreground process

sqb start runs in the foreground. See Running as a Service for background operation and auto-start on login.

Apps are independent repositories installed with:

sqb app add <git-url-or-local-path>
sqb app start <name>

The hub then proxies the app's API at /apps/<name>/api/ and serves its frontend at /apps/<name>/.

Building your own app

See Writing Apps for a step-by-step guide to creating a Squareberg app.

uv tool upgrade squareberg-hub