Skip to main content

Quickstart

Get Suzent running in under 5 minutes.

1. Install​

Prerequisites: Node.js 20+ and Git.

powershell -NoProfile -ExecutionPolicy Bypass -Command "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).

Mainland China Mirror Mode​

If package downloads are slow from mainland China, enable mirror mode before running setup:

$env:SUZENT_CHINA_MIRROR="1"; powershell -NoProfile -ExecutionPolicy Bypass -Command "irm https://raw.githubusercontent.com/cyzus/suzent/main/scripts/setup.ps1 | iex"

Mirror mode configures PyPI, npm, Playwright, Node via nvm, and Rustup mirrors. If GitHub itself is slow, set SUZENT_REPO_URL or SUZENT_RELEASE_BASE_URL to a mirror you trust before running setup.

2. Launch​

suzent start

This starts the backend and opens the desktop interface.

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, open the OpenAI card → API KEYS tab → CHANGE → paste your key. Then go to the MODELS tab → FETCH, select the models you want, and click Save Changes.

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 update

Stable updates pin the backend, locked dependencies, and desktop app to the same release. The command hands control to a standalone updater outside the workspace, so Windows can replace the virtual environment and app safely. The updater records progress in <install-dir>/.suzent/update-status.json and automatically restores the previous release if installation or verification fails. Run suzent repair if a machine lost power or was terminated during recovery.

In a source checkout, plain suzent update detects the workspace and switches to the development channel automatically. suzent update --dev remains available when you want to select that channel explicitly.

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