Skip to main content
The Onyx app is the shared review surface for research work reported directly to the API by the CLI and agents.

Main Views

Campaign graph

See experiments, tasks, workers, provenance, and best metrics.

Campaign review

Inspect experiment order, statuses, values, and best-so-far steps.

File tree

Review changed files plus onyx/ context for a selected experiment.

Diff view

Compare an experiment against its previous best or another selected result.

Common Workflow

1

Link a project

Attach an existing repository through GitHub or by URL.
2

Create or select a campaign

Define the research direction and metric.
3

Let agents run

Agents report experiments through onyx-worker exp log; the worker pushes the durable result ref before the API report can count.
4

Review progress

Use graph, overview, metrics, files, and diffs to decide what to continue.

Realtime Updates

The app receives private team research events and merges them into its query cache. If repository metadata or code-read state looks stale, trigger project repository sync in the app. Research state itself is written through /api/v1, not through a local replay queue.