You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/web/src/content/docs/docs/tools/dashboard.mdx
+9Lines changed: 9 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -285,6 +285,8 @@ The `source` block and the `results` block sync different repositories:
285
285
286
286
Use project-level **Sync Project** as the results exchange workflow. It handles pulled remote runs, locally edited metadata, dirty state, and blocked conflict feedback in one project-scoped action.
287
287
288
+
There is no separate `agentv results remote status` or `agentv results remote sync` command. The `agentv results` CLI stays focused on local run workspaces; manual remote exchange is Dashboard/API-only, with eval auto-export covering the common CI/publisher path.
289
+
288
290
Each run writes to a unique timestamped directory, so concurrent pushes from multiple machines are safe — non-fast-forward conflicts are resolved automatically via rebase retry.
289
291
290
292
### What happens to existing local runs?
@@ -303,6 +305,13 @@ Uses `gh` CLI and `git` credentials already configured on the machine. If authen
303
305
304
306
Once configured, Dashboard reads local runs and the configured results repo clone for that project. The status endpoint does not fetch from the remote on every page load; use **Sync Project** when you want to exchange changes with the results repo remote.
305
307
308
+
Automation can use the same API that Dashboard uses:
309
+
310
+
- `GET /api/projects/:projectId/remote/status`
311
+
- `POST /api/projects/:projectId/remote/sync`
312
+
313
+
Single-project sessions also expose `GET /api/remote/status` and `POST /api/remote/sync`.
314
+
306
315
In the default multi-project flow, open a project card first, then use **Sync Project** in that project's toolbar. The toolbar shows the project display name, sync state, last synced time, configured repo, and remote run count. Statuses include clean, unavailable, behind, ahead, dirty, diverged, conflicted, and syncing.
307
316
308
317
Use the **All Sources / Local Only / Remote Only** filter to narrow the run list by origin.
The `results` command family works on existing AgentV run workspaces and `index.jsonl` manifests. Use it after an eval run to inspect failures, validate manifests, export artifact layouts, or generate a shareable HTML report.
12
+
The `results` command family works on existing local AgentV run workspaces and `index.jsonl` manifests. Use it after an eval run to inspect failures, validate manifests, export artifact layouts, combine/delete local run workspaces, or generate a shareable HTML report.
13
+
14
+
Remote result repository exchange is intentionally not part of `agentv results`. New eval runs can auto-export to a configured results repo when `auto_push: true`; manual remote status and sync are Dashboard/API workflows. See [Dashboard Remote Results](/docs/tools/dashboard/#remote-results) for configuration and sync behavior.
13
15
14
16
## Subcommands
15
17
16
18
| Subcommand | Purpose |
17
19
|-----------|---------|
18
20
|`results report`| Generate a self-contained static HTML report from an existing run workspace |
19
21
|`results export`| Materialize or normalize the artifact workspace structure for a manifest |
22
+
|`results combine`| Combine partial local run workspaces into a new local run workspace |
23
+
|`results delete`| Delete one or more local run workspaces |
20
24
|`results summary`| Print aggregate metrics for a run |
21
25
|`results failures`| Show only failing cases |
22
26
|`results show`| Display case-level rows from a run workspace |
For a review-centric workflow built around these artifacts, see [Human Review Checkpoint](/docs/guides/human-review/).
86
+
87
+
## Remote results sync/status
88
+
89
+
The CLI contract is deliberately narrow: `agentv results` manages local result artifacts only. It does not expose `results remote status` or `results remote sync` subcommands.
90
+
91
+
Use these supported remote workflows instead:
92
+
93
+
-**Automatic publishing:** configure `projects[].results.auto_push: true`; new `agentv eval` and `agentv pipeline bench` runs push their artifacts after the run completes.
94
+
-**Manual Dashboard sync:** run `agentv dashboard`, open the project, and use **Sync Project**.
95
+
-**Manual API sync:** while Dashboard is running, call `GET /api/projects/:projectId/remote/status` or `POST /api/projects/:projectId/remote/sync` for project-scoped automation. Single-project sessions also expose `GET /api/remote/status` and `POST /api/remote/sync`.
96
+
-**Git escape hatch:** for advanced recovery, inspect or repair the configured `projects[].results.path` clone with `git` directly, then sync again.
AgentV should not add `agentv results remote status` or `agentv results remote sync` for the current production remote-results release.
6
+
7
+
The production contract is:
8
+
9
+
-`agentv eval` and `agentv pipeline bench` may auto-export newly created runs to the configured results repository when `auto_push: true`.
10
+
-`agentv results` remains a local-result workspace command family: combine, delete, export, report, summary, failures, show, and validate.
11
+
- Manual remote status and sync are Dashboard/API capabilities:
12
+
-`GET /api/remote/status`
13
+
-`POST /api/remote/sync`
14
+
-`GET /api/projects/:projectId/remote/status`
15
+
-`POST /api/projects/:projectId/remote/sync`
16
+
- Advanced CLI automation should call those Dashboard API endpoints while `agentv dashboard` is running, or use `git` directly in the configured `projects[].results.path` clone.
17
+
18
+
## Rationale
19
+
20
+
The remote sync operation is not a simple result-artifact primitive. It is project-scoped and coordinates git fetch/fast-forward/push behavior, mutable remote metadata overlays, dirty-state detection, conflict blocking, and safe recovery guidance. Dashboard already owns the project context and exposes the status/sync API that the UI uses.
21
+
22
+
Adding another CLI subcommand now would duplicate the Dashboard/API contract, widen the command surface, and force users to learn two manual sync entry points before there is evidence that the API-only automation path is insufficient. That conflicts with AgentV's lightweight-core and YAGNI principles.
23
+
24
+
Keeping `agentv results` local also preserves a clean mental model:
25
+
26
+
- Use `agentv results ...` for local artifacts already on disk.
27
+
- Use Dashboard/API for exchanging local and remote result repositories.
28
+
- Use eval auto-export for the common CI/publisher path.
29
+
30
+
## Future extension trigger
31
+
32
+
Add an explicit CLI sync command only if production users need headless manual sync without a long-running Dashboard server and cannot reasonably use the existing API or direct `git` workflow. If that demand appears, start with one project-scoped primitive that mirrors the existing API response shape instead of inventing a second contract.
0 commit comments