Skip to content

Wiki

Searchable user manual for runtime behavior, operational flows, API surfaces, and CLI commands.

WebUI Screenshots

4 views
Dashboard Overview screenshot
Overview
Top-level runtime health, activity, and system status.
Dashboard Sessions screenshot
Sessions
Conversation/session management and turn history exploration.
Dashboard Skills screenshot
Skills
Skill inventory, catalog actions, activation, and state controls.
Dashboard Settings screenshot
Settings
Configuration panes for runtime behavior and integrations.
82 entries
Runtime

Runtime startup lifecycle

At startup Roboticus loads config, initializes storage, discovers skills/plugins, wires API surfaces, and then begins agent + scheduler loops.

Use `roboticus serve` to start the runtime. Health and readiness can be checked via `/api/health`, `roboticus status`, and dashboard runtime cards.

startupservehealthruntimereadiness
References: /install, /docs/features, /docs/architecture
Configuration

Configuration apply model

Config mutations are read and applied through runtime APIs with explicit capabilities and apply-status endpoints.

Primary endpoints: `GET/PUT /api/config`, `GET /api/config/capabilities`, and `GET /api/config/status`. CLI mirrors this with `roboticus config show|get|set|unset`.

configsettingsapplystatuscapabilities
References: /docs/api, /docs/cli
Memory

Memory tiers and retrieval

Working memory tracks immediate context, episodic memory tracks event history, and semantic memory stores durable facts with category search.

Inspect memory through `/api/memory/*` endpoints and `roboticus memory list|search` commands. Full-text search is exposed via `/api/memory/search`.

memoryworkingepisodicsemanticsearch
References: /docs/features, /docs/api, /docs/cli
Inference

Model routing and selection telemetry

Requests are routed across available providers/models with observable selection events and efficiency metrics.

See `/api/models/available`, `/api/models/selections`, `/api/stats/efficiency`, and turn-level model inspection endpoints under context observability.

routingmodelsselectiontelemetryefficiency
References: /docs/features, /docs/api
Security

Approvals, policy gates, and audit trails

Potentially risky actions can be gated behind approvals, and policy/tool decisions are exposed through dedicated audit endpoints.

Approval lifecycle: `/api/approvals`, `/approve`, `/deny`. Audit inspection: `/api/audit/policy/:turn_id` and `/api/audit/tools/:turn_id`.

securityapprovalsauditpolicygates
References: /docs/security, /docs/api
Skills

Skill lifecycle: registry -> install -> activate

Skills can come from built-ins or registry catalogs, then be installed, activated, reloaded, and audited.

Skill APIs include `/api/skills`, `/api/skills/catalog`, `/install`, `/activate`, `/reload`, and `/audit`. CLI provides parallel `roboticus skills ...` flows.

skillscataloginstallactivatereload
References: /registry, /docs/api, /docs/cli
Plugins

Plugin lifecycle and execution model

Plugins expose tools through manifests and can be listed, toggled, and invoked through plugin endpoints.

Primary surfaces: `/api/plugins`, `/api/plugins/:name/toggle`, and `/api/plugins/:name/execute/:tool`. CLI includes `roboticus plugins list|install|enable|disable|uninstall|search`.

pluginstoolingcatalogtoggleexecute
References: /registry, /docs/api, /docs/cli
Automation

Scheduler and recurring jobs

Cron-like jobs can be created, listed, inspected, and removed, with run history captured for observability.

Use `/api/cron/jobs` and `/api/cron/runs` endpoints or `roboticus schedule` CLI surfaces.

schedulercronjobsautomationruns
References: /docs/api, /docs/cli
Channels

Channel delivery and dead-letter replay

Messaging channels expose status and failed-delivery queues, including replay support for dead letters.

Use `/api/channels/status`, `/api/channels/dead-letter`, and `/api/channels/dead-letter/:id/replay` for monitoring and repair.

channelsdead-letterreplaydeliverymessaging
References: /docs/features, /docs/api
Operations

Release sync and hosted registry behavior

Site release sync mirrors registry packs from roboticus releases and validates checksums for skills, plugins, and product-knowledge artifacts before deploy.

Registry content is hosted in `public/registry/*` and validated by integrity checks. Product knowledge is published as a source-backed tarball so installed agents can answer Roboticus setup and operation questions from current project evidence. Plugin catalog entries require archive presence and SHA-256 match.

release-syncregistrychecksumspluginsproduct-knowledgeartifacts
References: /registry, /changelog
Dashboard

Dashboard and live observability surfaces

The dashboard aggregates runtime health, sessions, costs, model routing, channels, skills, and operational controls.

For live stream integrations use WebSocket (`/ws`) and streaming endpoints where applicable.

dashboardobservabilitywscontrol-planeoperations
References: /docs/features, /docs/api
WebUI

WebUI tour and navigation model

The dashboard organizes operations into page-like panes (Overview, Sessions, Memory, Skills, Agents, Scheduler, Metrics, Wallet, Workspace, Settings) with live state indicators.

Navigation is hash-driven (`#overview`, `#sessions`, `#skills`, `#settings`) and updates in place without leaving the dashboard. Use the header Help button to open the wiki manual.

webuidashboardnavigationoverviewsettings
References: /wiki
API

GET /api/health

Health check

Route group: Health. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttphealthgetapihealth
References: /docs/api
API

GET /.well-known/agent.json

A2A agent discovery card

Route group: Discovery. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpdiscoveryget.well-knownagent.json
References: /docs/api
API

POST /api/agent/message

Send a message (standard inference)

Route group: Agent. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpagentpostapiagentmessage
References: /docs/api
API

POST /api/agent/message/stream

Send a message (SSE streaming)

Route group: Agent. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpagentpostapiagentmessagestream
References: /docs/api
API

GET /api/agent/status

Agent and provider diagnostics

Route group: Agent. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpagentgetapiagentstatus
References: /docs/api
API

GET /api/sessions

List sessions

Route group: Sessions. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpsessionsgetapisessions
References: /docs/api
API

POST /api/sessions

Create session

Route group: Sessions. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpsessionspostapisessions
References: /docs/api
API

GET /api/sessions/{id}

Get session details

Route group: Sessions. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpsessionsgetapisessions{id}
References: /docs/api
API

DELETE /api/sessions/{id}

Delete session

Route group: Sessions. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpsessionsdeleteapisessions{id}
References: /docs/api
API

GET /api/sessions/{id}/messages

List session messages

Route group: Sessions. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpsessionsgetapisessions{id}messages
References: /docs/api
API

GET /api/memory/working

Working memory entries

Route group: Memory. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpmemorygetapimemoryworking
References: /docs/api
API

GET /api/memory/episodic

Episodic memory entries

Route group: Memory. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpmemorygetapimemoryepisodic
References: /docs/api
API

GET /api/memory/semantic

Semantic knowledge store

Route group: Memory. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpmemorygetapimemorysemantic
References: /docs/api
API

GET /api/memory/search

Cross-tier hybrid memory search

Route group: Memory. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpmemorygetapimemorysearch
References: /docs/api
API

GET /api/cron/jobs

List cron jobs

Route group: Scheduler. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpschedulergetapicronjobs
References: /docs/api
API

POST /api/cron/jobs

Create cron job

Route group: Scheduler. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpschedulerpostapicronjobs
References: /docs/api
API

GET /api/skills

List loaded skills

Route group: Skills. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpskillsgetapiskills
References: /docs/api
API

GET /api/stats/costs

Inference cost tracking

Route group: Statistics. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpstatisticsgetapistatscosts
References: /docs/api
API

GET /api/stats/efficiency

Model efficiency metrics

Route group: Statistics. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpstatisticsgetapistatsefficiency
References: /docs/api
API

GET /api/config

Current configuration

Route group: Config. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpconfiggetapiconfig
References: /docs/api
API

GET /api/wallet/balance

Wallet balance

Route group: Wallet. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpwalletgetapiwalletbalance
References: /docs/api
API

GET /api/approvals

List approval requests

Route group: Approvals. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpapprovalsgetapiapprovals
References: /docs/api
API

POST /api/approvals/{id}/approve

Approve a pending request

Route group: Approvals. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpapprovalspostapiapprovals{id}approve
References: /docs/api
API

POST /api/approvals/{id}/deny

Deny a pending request

Route group: Approvals. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpapprovalspostapiapprovals{id}deny
References: /docs/api
API

POST /api/interview/start

Start personality interview

Route group: Interview. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpinterviewpostapiinterviewstart
References: /docs/api
API

POST /api/interview/turn

Submit interview Q&A turn

Route group: Interview. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpinterviewpostapiinterviewturn
References: /docs/api
API

POST /api/interview/finish

Finish interview and generate config

Route group: Interview. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpinterviewpostapiinterviewfinish
References: /docs/api
API

GET /api/subagents

List sub-agents

Route group: Sub-Agents. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpsub-agentsgetapisubagents
References: /docs/api
API

GET /api/breaker/status

Circuit breaker status

Route group: Circuit Breaker. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpcircuit breakergetapibreakerstatus
References: /docs/api
API

GET /ws

WebSocket event stream

Route group: WebSocket. This endpoint is part of the documented API reference and is available through the runtime HTTP surface.

apihttpwebsocketgetws
References: /docs/api
CLI

roboticus admin

Administrative operations

Usage: `roboticus admin`.

clicommandadmin
References: /docs/cli
CLI

roboticus agents

Manage agents

Usage: `roboticus agents`.

clicommandagents
References: /docs/cli
CLI

roboticus auth

Manage provider authentication

Usage: `roboticus auth`.

clicommandauth
References: /docs/cli
CLI

roboticus channels

Manage channel adapters and dead-letter queue

Usage: `roboticus channels`.

clicommandchannels
References: /docs/cli
CLI

roboticus check

Validate config, database, and provider connectivity

Usage: `roboticus check`.

clicommandcheck
References: /docs/cli
CLI

roboticus circuit

Manage circuit breaker state for LLM providers

Usage: `roboticus circuit`.

clicommandcircuit
References: /docs/cli
CLI

roboticus completion

Generate shell completions

Usage: `roboticus completion`.

clicommandcompletion
References: /docs/cli
CLI

roboticus config

View and manage configuration

Usage: `roboticus config`. Examples: - `roboticus config show` - `roboticus config get models.default` - `roboticus config set models.default openai/gpt-4.1-mini`

clicommandconfig
References: /docs/cli
CLI

roboticus cron

Manage cron jobs

Usage: `roboticus cron`.

clicommandcron
References: /docs/cli
CLI

roboticus daemon

Manage the roboticus daemon (alias for service)

Usage: `roboticus daemon`.

clicommanddaemon
References: /docs/cli
CLI

roboticus defrag

Database optimization or code quality scanning

Usage: `roboticus defrag`.

clicommanddefrag
References: /docs/cli
CLI

roboticus help

Help about any command

Usage: `roboticus help`.

clicommandhelp
References: /docs/cli
CLI

roboticus ingest

Ingest documents into the knowledge system

Usage: `roboticus ingest`.

clicommandingest
References: /docs/cli
CLI

roboticus init

Initialize a new roboticus workspace

Usage: `roboticus init`.

clicommandinit
References: /docs/cli
CLI

roboticus keystore

Manage the encrypted keystore

Usage: `roboticus keystore`.

clicommandkeystore
References: /docs/cli
CLI

roboticus logs

Stream or fetch recent log entries

Usage: `roboticus logs`. Examples: - `roboticus logs --follow` - `roboticus logs --level warn`

clicommandlogs
References: /docs/cli
CLI

roboticus mcp

Manage MCP (Model Context Protocol) servers

Usage: `roboticus mcp`.

clicommandmcp
References: /docs/cli
CLI

roboticus mechanic

Database diagnostics and repair

Usage: `roboticus mechanic`. Examples: - `roboticus mechanic` - `roboticus mechanic --repair`

clicommandmechanic
References: /docs/cli
CLI

roboticus memory

Query and manage memory tiers

Usage: `roboticus memory`.

clicommandmemory
References: /docs/cli
CLI

roboticus metrics

View cost, cache, and capacity metrics

Usage: `roboticus metrics`. Examples: - `roboticus metrics costs` - `roboticus metrics cache`

clicommandmetrics
References: /docs/cli
CLI

roboticus migrate

Run migrations and data import/export

Usage: `roboticus migrate`.

clicommandmigrate
References: /docs/cli
CLI

roboticus models

Query available models and routing diagnostics

Usage: `roboticus models`.

clicommandmodels
References: /docs/cli
CLI

roboticus plugins

Manage plugins (alias: apps)

Usage: `roboticus plugins`. Examples: - `roboticus plugins search claude` - `roboticus plugins install claude-code` - `roboticus plugins enable claude-code`

clicommandplugins
References: /docs/cli
CLI

roboticus profile

Manage agent configuration profiles

Usage: `roboticus profile`.

clicommandprofile
References: /docs/cli
CLI

roboticus reset

Reset all data (preserves schema)

Usage: `roboticus reset`.

clicommandreset
References: /docs/cli
CLI

roboticus schedule

Manage scheduled jobs (alias for cron)

Usage: `roboticus schedule`. Examples: - `roboticus schedule`

clicommandschedule
References: /docs/cli
CLI

roboticus security

Security configuration and auditing

Usage: `roboticus security`.

clicommandsecurity
References: /docs/cli
CLI

roboticus serve

Start the roboticus agent runtime

Usage: `roboticus serve`. Examples: - `roboticus serve` - `roboticus serve --host 127.0.0.1 --port 8788`

clicommandserve
References: /docs/cli
CLI

roboticus service

Manage the roboticus system service

Usage: `roboticus service`.

clicommandservice
References: /docs/cli
CLI

roboticus sessions

Manage agent sessions

Usage: `roboticus sessions`. Examples: - `roboticus sessions list` - `roboticus sessions show <session-id>` - `roboticus sessions export <session-id> --format markdown`

clicommandsessions
References: /docs/cli
CLI

roboticus setup

Interactive onboarding wizard

Usage: `roboticus setup`.

clicommandsetup
References: /docs/cli
CLI

roboticus skills

Manage agent skills

Usage: `roboticus skills`. Examples: - `roboticus skills list` - `roboticus skills catalog-list --query security` - `roboticus skills catalog-install <skill-name> --activate`

clicommandskills
References: /docs/cli
CLI

roboticus status

Display agent health and status

Usage: `roboticus status`. Examples: - `roboticus status`

clicommandstatus
References: /docs/cli
CLI

roboticus tui

Launch interactive terminal interface

Usage: `roboticus tui`.

clicommandtui
References: /docs/cli
CLI

roboticus uninstall

Uninstall the roboticus service and optionally remove data

Usage: `roboticus uninstall`.

clicommanduninstall
References: /docs/cli
CLI

roboticus update

Check for updates or update the binary

Usage: `roboticus update`. Examples: - `roboticus update --channel stable` - `roboticus update --channel beta`

clicommandupdate
References: /docs/cli
CLI

roboticus upgrade

Upgrade the roboticus runtime

Usage: `roboticus upgrade`.

clicommandupgrade
References: /docs/cli
CLI

roboticus version

Print version information

Usage: `roboticus version`.

clicommandversion
References: /docs/cli
CLI

roboticus wallet

Wallet balance and address management

Usage: `roboticus wallet`. Examples: - `roboticus wallet balance` - `roboticus wallet address`

clicommandwallet
References: /docs/cli
CLI

roboticus web

Open the dashboard in your default browser

Usage: `roboticus web`.

clicommandweb
References: /docs/cli