Skip to main content

Quick Start

Start from source if you do not have restricted alpha npm package access yet. Use @t3x-dev/local only when your npm account has alpha access.

Source, Docker, CLI, and MCP paths are available for development or preview workflows.

Choose A Path​

GoalUse this path
Develop from sourceclone the repo, then run pnpm dev:api and pnpm dev:webui
Try the packaged local alpha@t3x-dev/local with restricted alpha npm access
Use deterministic YAML operations@t3x-dev/yops with restricted alpha npm access
Evaluate self-hostingDocker Compose, not a production-readiness claim

Requirements​

  • Node.js 20+
  • One provider key for live extraction, generation, or chat: ANTHROPIC_API_KEY, OPENAI_API_KEY, or GOOGLE_AI_STUDIO_KEY
  • pnpm 10+ if you want the source-development path
  • Docker if you want the Docker preview path

The core engine and YOps do not require a model provider key. The WebUI also includes a fixture demo path, so you can inspect the interface without a key during local development.

Run From Source​

Use source development when you are changing the repository itself or when you do not have alpha package access.

git clone https://github.com/t3x-dev/t3x-core.git
cd t3x-core
pnpm install
pnpm dev:api
pnpm dev:webui

Open the URLs printed by the dev servers:

  • WebUI: go to /chat on the WebUI URL.
  • API: use the API URL printed by pnpm dev:api.
  • API reference: append /api/docs to the API URL.
  • OpenAPI JSON: append /api/openapi.json to the API URL.

In source development, the app defaults to a local developer mode. To exercise the self-hosted login flow, start both API and WebUI with:

AUTH_DISABLED=false pnpm dev:api
AUTH_DISABLED=false pnpm dev:webui

Run The Local Package​

This command requires restricted alpha npm access. If npm returns 404 or cannot resolve the package, use the source-development path above.

npx -p @t3x-dev/local t3x-local start

Use it when you want the packaged local product experience instead of assembling the monorepo source stack.

A Small Source -> YOps -> Commit Example​

source:
  text: Move launch region from US to EU and add security review before release.

state_before:
  launch:
    region: us
    gates:
      - qa

yops:
  - set:
      path: launch/region
      value: eu
  - append:
      path: launch/gates
      value: security_review

state_after:
  launch:
    region: eu
    gates:
      - qa
      - security_review

commit:
  parents:
    - sha256:...
  provenance:
    source: launch-note

The source is evidence. YOps is the reviewed mutation. The resulting YAML tree is the structured state. The commit preserves that state with parents, operation logs, and provenance.

Run With Docker Preview​

Docker Compose is a preview evaluation path. It is useful for trying a self-hosted WebUI + API + Postgres stack, but it is not the primary promised entry point for users.

docker compose up -d --build

Docker starts Postgres, API, and WebUI:

ServiceDefault host port
WebUI3000
API8000
Postgres5432

Optional profiles:

docker compose --profile runner up -d
docker compose --profile n8n up -d
Self-hosting safety

Docker and self-hosted runs keep auth on by default. Do not expose a deployment with AUTH_DISABLED=true to an untrusted network. Before sharing a host, review Deployment for auth, backups, TLS, logs, and provider key handling.

Try The Guided WebUI Demo​

Open the WebUI URL exposed by your dev server or Docker host, then go to:

/chat?introDemo=1

The demo uses recorded fixture data. It walks through:

  1. Create a project.
  2. Paste or prefill source material.
  3. Open Workspace.
  4. Extract a staged YOps proposal.
  5. Apply the YOps into a materialized tree.
  6. Move to Canvas.
  7. Open a Leaf output artifact.

CLI And MCP Preview​

CLI and MCP are preview surfaces. They read the same machine-local config file when you are testing command-line or agent workflows:

~/.t3x/config.json

Lookup order:

T3X_API_URL / T3X_API_KEY
-> ~/.t3x/config.json
-> built-in defaults

Useful commands:

t3x auth use-key t3xk_xxx
t3x auth status
t3x auth check
t3x config set api-url <api-base-url>/api
t3x config show

Build And Check​

pnpm build
pnpm test
pnpm check

If a test cannot resolve @t3x-dev/*, rebuild the lower package and its consumers first.

Next​