Skip to content

[reviewer] Review backlog (docs-currency): crux-serve.md does not document --runs-config / CRUX_RUNS_CONFIG or the /v1/runs route family #17027

Closed

Description

@hivecommons-hive

Filed from an out-of-scope finding in the Hive review of PR #17025.

PR: #17025 (#17025)
Perspective: docs-currency
Severity: low (P3)
Finding: crux-serve.md does not document --runs-config / CRUX_RUNS_CONFIG or the /v1/runs route family
Evidence: src/docs/crux-serve.md:39

| `--lanes-config PATH`, `CRUX_LANES_CONFIG` | opt into [durable event/work lanes](crux-lanes.md) on this same server, backed by NATS JetStream. Lane project credentials are separate from agent-control credentials. |

The carried commit adds crux serve --runs-config PATH with env fallback CRUX_RUNS_CONFIG (src/crux/cli/serve.go:46, :165) and the routes POST /v1/runs, GET /v1/runs/{id}, POST /v1/runs/{id}/cancel (src/crux/api/runs.go:7-14). src/docs/crux-serve.md is the operator reference that lists every other serve flag (lines 32-40: --operator-name, --checkout-allow, --checkout-dir, --lanes-config, --hive-callback) and every route family (line 97-98: /v1/checkouts, /v1/lanes), but at head 13f0d59 it has no row for --runs-config or /v1/runs, so an operator reading the doc cannot discover how to enable contained runs or that a server without a backend still serves saved records (serve.go:168-171). Likewise src/docs/env-vars.md:132 lists CRUX_LANES_CONFIG for crux serve but not CRUX_RUNS_CONFIG. Because this PR is a mechanical v5->v6 forward-merge, the fix belongs in v5 (then forward-merged) rather than here; filing as backlog.

Fingerprint: 17fa7edd3e6094205146daa7a4bb3745ad6097e372bb93b63989a9551115a77f

filed by Hive review backlog

Activity

  1. added
    help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
    on Nov 7, 2026
  2. hivecommons-hive commented on Nov 7, 2026

    @hivecommons-hive
    ContributorAuthor

    🔓 Claim by agent scanner released (holding agent relaunched).

    Claim history
    • 2026-11-07 18:15 UTC — claimed by scanner (agent on hive hosted-available-oke-11-placeholder-r05x)
    • 2026-11-07 18:20 UTC — released by scanner (agent; holding agent relaunched)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    agent/reviewerFiled by the reviewer agenthelp wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions