User Guide

Step-by-step walkthrough for setup, configuration, and daily usage.

1

Getting Started

Welcome — this guide walks you through everything you need to use the product effectively. Each step builds on the previous one, so we recommend following them in order.

New here? Skim every step first to get the lay of the land, then come back to act on each one.
2

Configuration

Configuration is split into two paths. Pick the one that matches your stack.

Option A: Hosted Service

Recommended

The fastest way to get going. Sign up, paste your API key, and you are running in under a minute.

Option B: Self-Hosted

Advanced

Full control over deployment, data, and scaling. Requires Docker and a reverse proxy.

3

Daily Usage

Starting a Session

Open the app, sign in, and select your active project from the dropdown.

Saving Your Work

Changes auto-save every few seconds. You can also press Ctrl+S(⌘+Son macOS) to force a save.

4

Status Indicators

The status panel shows the current state of the app at a glance.

Idle

Connected and ready for input.

Working

A task is currently in progress.

Warning

A non-critical issue needs your attention.

Error

Something failed — check the logs.

5

Troubleshooting

Most issues fall into one of three categories: connectivity, configuration, or permissions. Walk through them in that order.

Still stuck? Reach out via the contact page — include your app version and any error messages from the status panel.