Skip to content

Getting started

Interested in using Talaia? Contact Oriol to discuss access and deployment. This guide assumes you already have the project files. Talaia is privately distributed; the documentation does not provide a public download.

Talaia uses Python 3.12 and uv. Run commands from the supplied project’s backend/ directory:

Terminal window
cd backend
uv sync --locked
cp .env.example .env

Edit .env as needed. Leave Pushover and production credentials empty for the initial local check. Use --env-file .env on local CLI commands: the CLI does not load .env automatically. Backend Make targets load it when present; Compose loads it separately through env_file.

Terminal window
uv run --env-file .env talaia list
uv run --env-file .env talaia run _template
uv run --env-file .env talaia ui

The local UI listens on port 8080. Open /suite/_template to see the result. The template makes no production requests and can be run explicitly even though it is disabled. Other suites remain unknown until they have run.

Browser suites additionally need Chromium:

Terminal window
uv run playwright install chromium

Follow Writing a suite. Begin with a credential-free surface check and a product-specific marker; add real journeys using dedicated test accounts and explicit safety gates. Configure alerts and review the suite’s footprint before scheduling it.

Terminal window
uv run --env-file .env talaia run your-project/surfaces
uv run --env-file .env talaia footprint

run --all executes every enabled suite, including write and permanent-data flows where configured. Use it deliberately; it is not a local installation test. uv run pytest runs only the monitor’s harness tests.

CommandPurpose
talaia listList discovered suites and schedules
talaia run <suite>… [--all]Run named suites, or every enabled suite
talaia crontabEmit cron lines for enabled, scheduled suites
talaia uiServe the local status UI; optional --host and --port
talaia footprint [--strict]Report suite load and budget warnings; strict mode exits nonzero on warnings
talaia purge --days NDelete retained runs older than N days; default 90

Automatic retention follows TALAIA_RETENTION_DAYS, default 90. Manual purge uses its --days value. See Deployment for the Docker setup.