Skip to main content

culvii surface review

Create, get, and open browser reviews for selected execution surfaces.

Synopsis​

culvii surface [--env <env>] review create --file <path> [--json]
culvii surface [--env <env>] review get <review-id> [--json]
culvii surface [--env <env>] review open <review-id>

Description​

Manages custom runtime surface reviews.

  • create: Creates a new review from a JSON file. The manifest shape must be { "items": [{ "executionId": "...", "nodeId": "..." }] }. Reviews expire after 2 hours.
  • get: Retrieves the selected surfaces and the user feedback collected so far.
  • open: Opens the surface review in the Culvii Console.

Review Lifecycle​

A review session tracks user feedback for specific surfaces generated during an execution.

  • Targeting: Each item in the review manifest must specify { executionId, nodeId }.
  • Console Badges: When viewing a review in the Culvii Console, nodes are badged based on their execution state:
    • Mocked output: The node used a value from the --mocks-file.
    • Simulated trigger: The workflow was started via culvii workflow run.
    • Executed output: The node ran its real logic and produced a live result.
  • Reviewer Decisions: Reviewers can provide feedback on each surface:
    • Keep this surface: The surface is correct and should be used.
    • Request changes: The surface needs modification.
    • Use default: Revert to the platform's default surface for this node type.

Flags​

FlagRequiredDescription
--env-Target environment (dev, sandbox, or prod). Defaults to active context.
--file✓ (create)JSON file with { items: [{ executionId, nodeId }] }.
--json-Print machine-readable JSON.

Examples​

culvii surface review create --file review.json
culvii surface review open rev_12345

Error behaviour​

ConditionMessageExit
Invalid review file"Review file must contain a non-empty items array"1
Invalid review item"Review item <index> must contain executionId and nodeId strings"1