Skip to main content

Installation Guide

This guide covers end-user installation options for Tyrum gateway.

Supported Platforms​

  • macOS
  • Linux
  • Windows (npm install path)

Prerequisites​

  • Node.js 24.x
  • npm (bundled with Node)

Installs a versioned @tyrum/gateway release tarball after verifying SHA256SUMS.

curl -fsSL https://get.tyrum.ai/install.sh | bash

Install from a channel:

curl -fsSL https://get.tyrum.ai/install.sh | bash -s -- --channel beta

Install a specific version:

curl -fsSL https://get.tyrum.ai/install.sh | bash -s -- 2026.2.18

Advanced overrides:

  • TYRUM_REPO (default: tyrumai/tyrum)
  • TYRUM_VERSION (for non-latest installs)
  • TYRUM_CHANNEL (stable | beta | dev)

Option 2: npm Global Install​

npm i -g @tyrum/gateway

Run:

tyrum

Tyrum in Your Browser (/ui)​

When the gateway is running, it serves the Tyrum web app as a single-page app at:

  • http://127.0.0.1:8788/ui

Browser login uses direct bearer-token auth:

  • The UI stores your admin token in browser local storage after you paste it once.
  • Subsequent HTTP and WebSocket requests authenticate directly with that saved token.
  • /ui?token=<admin token> is supported as a one-time bootstrap path; the UI persists the token and then strips it from the URL.

On first startup, the gateway prints bootstrap tokens to stdout once:

  • system
  • default-tenant-admin

Capture the default-tenant-admin token and use it to sign in to /ui unless you already provisioned tokens through another flow.

If you lose the token later, recover by issuing a fresh one against the same gateway home or DB:

tyrum tokens issue-default-tenant-admin

After login, open Configure -> Tokens to manage tenant tokens with a filterable list, structured add/edit/revoke dialogs, and one-time secret reveal on creation. Existing token secrets are not readable from the UI because the gateway stores token secrets hashed at rest; only freshly issued tokens are shown once in the issue result.

Singleton agent routes are enabled by default. Their durable availability is controlled by deployment config agent.enabled, not by a startup environment variable.

Option 3: GitHub Releases​

From each v* release, download:

  • Desktop installers (.dmg, .zip, .exe, .AppImage, .tar.gz)
  • npm package tarballs (tyrum-*.tgz)
  • SHA256SUMS

Release workflow: .github/workflows/release.yml

Release publishing is gated on the ci workflow passing for the tagged commit (.github/workflows/ci.yml).

Release Channels and Naming​

  • stable: vYYYY.M.D (npm dist-tag: latest)
  • beta: vYYYY.M.D-beta.N (npm dist-tag: next)
  • dev: vYYYY.M.D-dev.N (npm dist-tag: dev)

GitHub release title format is:

  • tyrum YYYY.M.D
  • tyrum YYYY.M.D-beta.N
  • tyrum YYYY.M.D-dev.N

Updating​

In-place update via installed CLI (recommended once tyrum is already on PATH):

tyrum update

Update from a release channel:

tyrum update --channel beta

Pin to an exact release version:

tyrum update --version 2026.2.18

Re-install/update via installer script (useful for fresh bootstrap or PATH repair):

curl -fsSL https://get.tyrum.ai/install.sh | bash
curl -fsSL https://get.tyrum.ai/install.sh | bash -s -- --channel beta

Difference:

  • tyrum update uses your existing installed command and updates @tyrum/gateway via npm.
  • install.sh fetches signed release assets (SHA256SUMS verified) and reinstalls globally.

Desktop app updates:

  • The desktop app checks for updates automatically and notifies when one is available.
  • Download/install remains user initiated from the Diagnostics page.
  • You can also install from a local release file via Diagnostics → Use Local Release File.

Version Pinning​

Install a specific version:

npm i -g @tyrum/[email protected]

or:

curl -fsSL https://get.tyrum.ai/install.sh | bash -s -- 2026.2.18

Next Steps​