Quick Start
Start Albiex Synth City, inspect existing work, or launch a manual session before deciding whether to connect a repository.
Start the Dev Servers
./scripts/dev.shThis starts:
- Backend at
http://localhost:8000(API docs athttp://localhost:8000/docs) - Frontend at
http://localhost:5173
Open http://localhost:5173 in your browser.
To stop or restart the dev servers for this checkout:
./scripts/dev.sh stop
./scripts/dev.sh restartObserve existing work
Overview is the home page for tracking counts and automation observations across this backend. Use team, scope and harness filters on factory pages; native harness/project preferences do not filter work. Open Work for an owner, waiting reason or PR. Open Repositories to distinguish configured enablement from effective intake. An empty workload does not require enabling autonomy, and a read failure is not an empty factory.
Launch manually or inspect configuration
Use Live sessions for standalone work or Teams for a current launch plan. Reuse only sessions belonging to intended slots. Unbound adoption is an explicit operator review; opening a Work launch link starts nothing.
Use Harnesses for guarded native pages. Local projects scope supported native settings independently of factory filters. Other harnesses' integration capabilities do not create native editors.
Connect a backlog with the current flow
Open Repositories and select Set up a repository for guided configuration. It checks access and labels without changes, then saves an inactive team or uses an existing team, with a disabled scope. Launch and activation are separate, reviewed steps. You can also add an existing primary checkout in Teams > Autonomy.
The Leader is the team's explicit leader_slot_id. Guided setup names it for a new team; for an existing team, use Set Leader in the roster while automation is off. Slot order and Role text do not select it. Configure GitHub polling access on the host and dispatch/design/area labels on GitHub, as described in Autonomous GitHub dispatch. Choose merge policy and finite budgets; review the enable confirmation only when ready.
The operator credential uses the existing per-tab flow, separately from GitHub polling access and authenticated agent sessions. No cookie login is included. Team/scope pause controls intake; inspect existing attempts separately rather than assuming processes stopped.
Identify the Backend Instance
When you run Albiex Synth City on more than one machine, or expose it over a LAN or tailnet, set an instance name so each browser window clearly shows the backend it controls:
SYNTH_CITY_INSTANCE_NAME="Studio Mac" \
SYNTH_CITY_INSTANCE_ACCENT="blue" \
SYNTH_CITY_INSTANCE_ID="studio-mac" \
./scripts/dev.sh --host 0.0.0.0Use a trusted network or tunnel when binding to all interfaces. Protected roster, autonomy and recovery controls require their documented credentials; safe reads remain observational. Local trust is not remote multi-user isolation. A Vite dev UI on another origin needs that exact origin in the JSON CORS_ORIGINS setting; Synth City’s production UI is same-origin.
The instance name appears in the header, browser tab title, Agent Bridge terminal panes, and kill-session confirmations. Supported accents are blue, green, purple, orange, red, pink, cyan, and slate.
Key pages
| Page | Purpose |
|---|---|
| Overview | Tracking counts and automation observations |
| Work | Mixed-team details and current remedies |
| Repositories | Watched scopes, intake, polling and overlaps |
| Harnesses | Guarded native settings and manual entry points |
| Teams | Rosters, launch plans and current repository/autonomy configuration |
| Live sessions | Standalone sessions and explicit terminal interaction |
| Agent Mail | Coordination and read-only work context |
Production Build
To build for production:
./scripts/build.shThis compiles the app frontend into frontend/dist/ and the documentation site into docs/.vitepress/dist/. The backend serves the built app frontend automatically.
To preview the documentation site while editing:
./scripts/docs-dev.shOpen http://localhost:5174/docs/.
Next Steps
- Features — detailed guides for each feature
- Architecture — how the app is structured
- API Reference — REST API documentation