Getting started

Terminal retirement — local implementation, 2026-10-20

The current working tree removes interactive terminals and Redis while preserving command/script Remote Actions and authorized session/transcript history with existing retention. Admin has a read-only history viewer; Core advertises no terminal capability and legacy terminal operations cannot create work. This implementation is local and awaits user testing; older published implementation descriptions below remain historical. See the retirement plan and evidence.¹

Prerequisites

• Node.js 22 or a compatible supported release declared by the repository.
• pnpm 9.15.4 or compatible 9.x release.
• Docker with Docker Compose.
• Git.
• A current stable Rust toolchain for native development; the GUI declares Rust 1.90 minimum (Core/CLI: 1.89). The updater is pinned to the official ZIP security fix; see the qualification evidence.
• For pnpm migration:baseline only: authenticated kubectl/Google Cloud CLI and the dig DNS utility. The command collects bounded metadata without changing cloud resources.

Setup

pnpm install
cp .env.example .env
pnpm docker:dev
pnpm db:migrate
pnpm dev

Before using .env.example, confirm that it contains placeholders only. Never copy or commit provider credentials into an example file.

Development services

Component	Default location
Backend	http://localhost:3001
Admin	http://localhost:3002
Desktop	Tauri window over the local MonStaff Core
MinIO API	http://localhost:19010
MinIO console	http://localhost:19011
PostgreSQL	localhost:15432

The loopback host ports avoid collisions with Lexguard. Override MONSTAFF_POSTGRES_PORT, MONSTAFF_MINIO_API_PORT and MONSTAFF_MINIO_CONSOLE_PORT if necessary, and update DATABASE_URL/S3_ENDPOINT to match. Integration tests discover dynamic ports and do not use the development database.¹

Common commands

pnpm dev
pnpm dev:backend
pnpm dev:desktop
pnpm dev:admin
pnpm build
pnpm db:generate
pnpm db:migrate
pnpm db:studio

The current root test and lint commands are not reliable quality gates; see contribution and quality before interpreting their exit status.

First functional flow

1. Start infrastructure and apply migrations.
2. Start the applications.
3. Authenticate through GitHub.
4. Select or configure an organization and GitHub-backed project.
5. Start a desktop timer against a project and optional issue.
6. Stop the timer and review entries, activity and screenshots in the admin.

Footnotes

1. Local interactive-terminal and Redis retirement. ↩ ↩²