Getting started

This tutorial starts Tedix from a source checkout, creates one local Workspace, and checks that its data persists. No account or Cloud credential is needed. This page is for evaluating the product from source; to simply use Tedix Cloud, use Tedix in ChatGPT, Codex and Claude. To connect the CLI to an invited Cloud organization instead, connect to Tedix Cloud.

Run Tedix locally

You need Git, Bun, and Node.js 22+ on PATH (real Node, not a Bun shim; Wrangler needs it). No account or cloud credentials are needed.

git clone https://github.com/tedix-hq/tedix.git && cd tedix
bun run-local

The launcher installs locked dependencies, starts the API on Cloudflare’s local workerd runtime with a local D1 database, and serves Tedix OS on http://localhost:3030. Open it and name your local organization. Tedix creates the organization, your owner account, and a first tedi through the same API contracts Cloud uses. State persists in .wrangler/run-local; nothing contacts a Cloudflare account.

Option	What it does
`--smoke`	Onboards into a temporary database, checks the result persists, exits.
`--demo`	Loads sample data, kept separately in `.wrangler/run-local-demo`.
`--inference --workers-ai-account=ID`	Turns on model calls through Workers AI on your own Cloudflare account.
`--ai-gateway=ID`	Uses a named AI Gateway instead of your account’s default gateway.
`--verbose`	Streams every server log to the terminal instead of `server.log`.
`--help`	Lists every option without starting anything.

The Tedix CLI wraps this launcher: tedix setup runs it in a checkout, or clones the source release matching your CLI version when one is published, and tedix dev restarts the saved installation later.

A first offline task

Choose New workspace, name it Supplier review, and describe the decision you need to make before your next order. Save it, return to Workspaces, and reopen it. The name and description remain after a refresh or a restart. Drafting text needs model calls, which the next step turns on.

Expected result: the workspace still appears with the same name and description after you refresh the page. This proves local storage and the local API path. It does not prove that a digital worker ran.

Turn on model calls

Model calls go to Workers AI and are billed to your Cloudflare account. All other data stays on your machine.

bunx wrangler login
bunx wrangler whoami        # shows your 32-character account id
bun run-local --inference --workers-ai-account=<account-id>

Cloudflare’s default AI Gateway is created on the first authenticated call. Add --ai-gateway=<gateway-id> to use a named gateway in the same account. Send a small test prompt to confirm replies come back.

With inference on, Home can propose local tool actions for your approval, such as saving a document. The launcher also starts the MCP gateway on port 3000, so a coding agent can discover local tools. Install the CLI first; local calls need no login:

TEDIX_MCP_URL=<local-gateway-url> \
TEDIX_MCP_BEARER_TOKEN=tedix-local-demo \
tedix code 'async () => await discover.search({query: "get_os_output", limit: 2})'

Copy the gateway URL from Gateways in Tedix OS. The demo token only works locally.

Local mode covers onboarding, Tedix OS, workspaces and preferences, the API authentication boundary, migrations, and D1 reads and writes. It does not run remote tedis, connect outside providers, or deploy anything.

Build configuration

bun run-local builds Tedix OS with local placeholder values and no Tedix Cloud identity. Any other bun run --cwd apps/os build needs API_URL, DESCOPE_PROJECT_ID, and DESCOPE_BASE_URL (Descope is the identity provider), either as TEDIX_BUILD_* environment variables or in the vars block of apps/os/wrangler.jsonc. The build stops and names any missing value. See “Build configuration” in apps/os/README.md.

Let your coding agent set it up

A coding agent such as Codex or Claude Code can do the local setup for you. Paste this prompt into it:

Set up Tedix locally from source. Read https://docs.tedix.dev/getting-started
and the README at https://github.com/tedix-hq/tedix, check that Git, Bun and
Node.js 22+ are installed, clone the repository, and run `bun run-local`.
Do not log in to anything or turn on model calls. When Tedix OS is running,
tell me its URL and stop.

What to try first

Local: create the Supplier review workspace from A first offline task, refresh, and check that it is still there.
Local: run the supplier-review example to import a sample supplier folder as a Workspace document.
Local, with model calls: ask Home to save a short note as a document and approve the action it proposes.
Cloud: give a tedi one small task with Run a digital worker and open its run.
Cloud: ask Home what is in progress with tedix ask "Summarize the active work and cite its evidence.", then run tedix work --help to see how to list and create Work Items.

Connect to Tedix Cloud to use a live organization and its digital workers.
Check release status for the current limits of local and Cloud operation.
Read core concepts for the product vocabulary.