Skip to Content
Optimus docs · TypeScript rewrite of the legacy Python Textual app.

Optimus

Control panel for cloud browser automation. Users describe a task in English, Optimus drives a real browser on Browser Use Cloud, and every run is recorded with steps, screenshots, tokens, and cost.

Two frontends share one backend:

  • Web — Next.js app on a public domain, OAuth sign-in (Google + Microsoft).
  • TUI — Ink CLI, reaches the web app’s API via a personal access token.

Documentation map

SectionWhat’s in it
Getting startedInstall, run locally, understand the moving parts.
ConceptsRuns, steps, the status machine, auth, cost, URL guard.
AppsThe Next.js web app and the Ink TUI — usage, env, conventions.
PackagesHand-written guides for the six shared workspace packages.
API referenceAuto-generated TypeScript symbol-by-symbol reference.
OperationsDeploying to Railway + Supabase, troubleshooting.
ContributingBranch + commit conventions, coding standards, docs workflow.

Monorepo layout

apps/ web/ Next.js App Router — auth, API, run orchestration, history UI tui/ Ink TUI — thin HTTP client docs/ This site (Nextra + Next.js) packages/ core/ Pure TS domain: types, Zod schemas, URL guard, cost, status machine api-client/ Typed HTTP + SSE client (shared by TUI and web) browser-use/ Wrapper around Browser Use TS Cloud SDK db/ Drizzle schema + repositories (server-only) auth/ Better Auth config + PAT helpers config/ Shared tsconfig presets legacy/ Original Python Textual app — read-only during migration

Where things live