Skip to main content

Quickstart

Get Suzent running in under 5 minutes.

1. Install​

Prerequisites: Node.js 20+ and Git.

powershell -c "irm https://raw.githubusercontent.com/cyzus/suzent/main/scripts/setup.ps1 | iex"

The script installs Suzent and any missing dependencies (Python/uv, Rust, build tools).

2. Launch​

suzent start

This starts the backend and opens the UI in your browser. The default address is http://localhost:25315.

3. Add Your Model Provider​

Once the UI is open, go to Settings → Providers to configure your API key. The most common starting points:

Get your key: platform.openai.com/api-keys → Create new secret key (starts with sk-...)

In Settings, paste it into OpenAI → API Key, enable the models you want, then click Save → Verify.

Using DeepSeek, Grok, OpenRouter, Ollama, or another provider? See the full Providers reference.

4. Start Chatting​

Pick a model from the model selector in the chat window and send your first message.

That's it. Your agent has memory, tools, and automation ready out of the box.

Troubleshooting​

"Command not found: suzent" — Restart your terminal after installation. If it still fails, check the setup script output for how to manually add the scripts folder to your PATH.

"System Health Check Failed"

suzent doctor

Port conflict on startup — suzent start detects conflicts and asks if you want to kill blocking processes. Type y to proceed.

Updating

suzent upgrade

Next Steps​

  • What is Suzent? — Understand the architecture
  • Providers — Full list of supported models and providers
  • Tools — See everything your agent can do
  • Memory — How persistent memory works
  • Automation — Schedule tasks and set up heartbeat monitors