​
Getting Started

Goal: go from zero to a first working chat with minimal setup.
Fastest chat: open the Control UI (no channel setup needed). Run traseai dashboard and chat in the browser, or open http://127.0.0.1:18789/ on the . Docs: Dashboard and Control UI.

​
Prereqs

Check your Node version with node --version if you are unsure.

​
Quick setup (from source)

1

Clone and build

git clone https://github.com/mk-rcp/traseai.git
cd traseai
pnpm install
pnpm build
2

Run the onboarding wizard

pnpm traseai onboard --install-daemon
The wizard configures auth, gateway settings, and optional channels. See Onboarding Wizard for details.
3

Check the Gateway

If you installed the service, it should already be running:
pnpm traseai gateway status
4

Open the Control UI

pnpm traseai dashboard
To make the traseai command available globally (so you can run traseai instead of pnpm traseai), run pnpm link --global from the repo root.
If the Control UI loads, your Gateway is ready for use.

​
Optional checks and extras

Useful for quick tests or troubleshooting.
pnpm traseai gateway --port 18789
Requires a configured channel.
pnpm traseai message send --target +15555550123 --message "Hello from TraseAI"

​
Useful environment variables

If you run TraseAI as a service account or want custom config/state locations:
  • TRASEAI_HOME sets the home directory used for internal path resolution.
  • TRASEAI_STATE_DIR overrides the state directory.
  • TRASEAI_CONFIG_PATH overrides the config file path.
Full environment variable reference: Environment vars.

​
Go deeper

Onboarding Wizard (details)

Full CLI wizard reference and advanced options.

​
What you will have

  • A running Gateway
  • Auth configured
  • Control UI access or a connected channel

​
Next steps

  • DM safety and approvals: Pairing
  • Connect more channels: Channels
  • Advanced workflows and from source: Setup