Skip to main content
Work items are the core executable unit in OpenIndex. The oi work-item command group covers the full lifecycle: listing, creating, updating, transitioning through workflow stages, scheduling, collaborating via comments, and managing attachments, dependencies, and custom fields.

List and get

agent-context returns the agent-oriented workflow bundle for a work item. In --json mode it returns the full backend payload from /browse/:key/agent-context. In human mode it summarises the current goal, allowed exits, blocked exits, and required fields.

List filters

Create

Update

Claim and complete

  • claim requires a valid workflow transition from the current status.
  • complete requires a valid transition to a terminal status, clears active agent fields, and marks the item as resolved.
  • done auto-progresses through valid stage gates to a completion stage (completed by default).
If complete fails because the target status is not terminal, the CLI suggests oi work-item progress --to-stage ... as a next step.

Progress through stage gates

Use progress to advance a work item through a workflow stage gate:

Transitions

Inspect valid transitions and available stage gates for a work item:
Always run this before claim, complete, or progress when you are unsure of the allowed next states.

Schedule placement

Hierarchy

Returns the full parent/child hierarchy for a work item, including its domain, project, task, and sub-task relationships.

Comments

  • --body is required for create and update.
  • --visibility defaults to internal. Pass external to share the comment outside the team.

Custom fields

--values-json accepts a JSON object keyed by workflow custom field key.

Attachments

Dependencies

Audit log

Export the full audit trail for a work item to JSON or CSV. Use --output to write directly to a file.