Run the binary

The recommended way to run Staqly Community Edition on your own computer. One binary, staqly serve, starts the REST API, the MCP endpoint, the background workers and the dashboard — no Docker, no containers. Use the Docker image instead if you already run everything in Docker or want the hardened container setup.

Install and startCopy Anchor Link

curl -fsSL https://raw.githubusercontent.com/staqly/staqly/main/scripts/install.sh | sh

staqly serve

Staqly Community Edition (local mode): every request needs the access token.
  Open the dashboard:  http://localhost:8080/#token=stk_local_...
  Access token:        stk_local_...

staqly is also the CLI, so one install gives you both.

What runs whereCopy Anchor Link

OptionsCopy Anchor Link

staqly serve --data ~/staqly-data          # another data directory (or STAQLY_DATA_DIR)
staqly serve --port 4333 --dashboard-port 9090   # other ports for the API and the dashboard
staqly serve --expose                      # dashboard on all interfaces, for phones and tablets

Every other setting comes from environment variables, for example LOG_LEVEL=debug staqly serve. The binary does not read a .env file.

Use it from your phoneCopy Anchor Link

With --expose, other devices on your network can open the dashboard. Every browser signs in once; a phone does it with a one-time link, so it never needs the access token:

staqly serve --expose
staqly serve connect-link    # in another terminal: prints a one-time sign-in link

Or scan the QR code from Connect a device in the dashboard: it uses your computer's Wi-Fi address by itself, even when you opened the dashboard at localhost. To pin another address or name for every browser, set PUBLIC_DASHBOARD_URL (e.g. PUBLIC_DASHBOARD_URL=http://192.168.1.23:8080 staqly serve --expose). Without --expose, the dialog tells you to restart with it. See Phones & tablets.

Operator commandsCopy Anchor Link

staqly serve followed by a command runs an operator command against the same data directory instead of starting the server:

staqly serve token                       # the access token, and a link that signs a browser in
staqly serve token --rotate              # a new access token; the old one stops, every browser is signed out
staqly serve connect-link                # one-time sign-in link for a browser
staqly serve backup ~/staqly-backup.db   # consistent database backup, works while staqly runs

Pass the same --data (and --dashboard-port) you start the server with.

Run it in the backgroundCopy Anchor Link

staqly service install runs staqly serve as a background service of your user, so staqly keeps running after you close the terminal, starts again with your computer and restarts if it stops. No root, no Docker.

staqly service install              # same flags as serve: --port, --dashboard-port, --data, --expose
staqly service status               # installed? running and answering on its port?
staqly service logs -f              # follow its log
staqly serve token                  # the access token and the sign-in link
staqly service uninstall            # stop and remove it (your data and log are kept)

install waits until staqly answers on its port and fails with a message instead if it does not start. It refuses ports another program already uses, for example the Docker container on 3333 and 8080: pick others with --port and --dashboard-port.

Settings from your environment when you install are kept in the service (STAQLY_*, PROVIDER_*, PUBLIC_*, LOG_*, NOTIFY_*, WEBHOOK_*...). For example, a fixed key for channel credentials:

STAQLY_SECRET_KEY="$(openssl rand -base64 32)" staqly service install

Run staqly service install again after an upgrade or to change flags or settings: it replaces the service. On Windows, start staqly serve from Task Scheduler.

Next stepsCopy Anchor Link