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
datzi dashboard and chat in the browser, or open http://127.0.0.1:18789/ on the
. Docs: Dashboard and
Control UI.Prereqs
- Node 22 or newer
Quick setup (CLI)
Install Datzi (recommended)
- macOS/Linux
- Windows (PowerShell)
Other install methods and requirements: Install.
Run the onboarding wizard
If the Control UI loads, your Gateway is ready for use.
Optional checks and extras
Run the Gateway in the foreground
Run the Gateway in the foreground
Useful for quick tests or troubleshooting.
Send a test message
Send a test message
Requires a configured channel.
Useful environment variables
If you run Datzi as a service account or want custom config/state locations:DATZI_HOMEsets the home directory used for internal path resolution.DATZI_STATE_DIRoverrides the state directory.DATZI_CONFIG_PATHoverrides the config file path.
Go deeper
Onboarding Wizard (details)
Full CLI wizard reference and advanced options.
macOS app onboarding
First run flow for the macOS app.
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
