Skip to content

orion card ​

Work items on the canvas

sh
orion card <command> [options]

orion card list ​

List work items with their derived status

sh
orion card list [options]
ArgumentDescription
--group <value>Only items inside this group
--allInclude done items
--jsonPrint JSON

orion card create ​

Add a work item

sh
orion card create [options] [label...]
ArgumentDescription
[label...]What the work is
--group <value>Group to add it to
--after <value>Item the card follows; it lands beside it, in its group
--before <value>Item the card leads into; it lands beside it, in its group
--status <value>todo, active, review, blocked, deferred, or done
--repo <value>Repository it belongs to, as owner/name (empty to clear)
--who <value>Whose move: you, review, or ci (empty to clear)
--note <value>Free-form note (empty to clear)
--shape <value>How a component is drawn: service, store, actor, external, interface, process, or queue (empty to clear)
--color <value>A component's tint: teal, blue, purple, amber, rose, green, or slate (empty to clear)
--kind <value>step; gate for one that's done once everything it waits on is; or component for a part of a system, not work. A note given a kind becomes a work item
--ref <value>Attach outside work: a GitHub or Jira URL, source:key such as jira:ABC-1, or branch:owner/name@branch
--jsonPrint JSON

orion card set ​

Change an item's fields

sh
orion card set [id] [options]
ArgumentDescription
[id]Item or group id, or a selector such as label:"Extract slider", ref:jira:ABC-12, or pr:86
--label <value>New label
--status <value>todo, active, review, blocked, deferred, or done
--repo <value>Repository it belongs to, as owner/name (empty to clear)
--who <value>Whose move: you, review, or ci (empty to clear)
--note <value>Free-form note (empty to clear)
--shape <value>How a component is drawn: service, store, actor, external, interface, process, or queue (empty to clear)
--color <value>A component's tint: teal, blue, purple, amber, rose, green, or slate (empty to clear)
--kind <value>step; gate for one that's done once everything it waits on is; or component for a part of a system, not work. A note given a kind becomes a work item
--ref <value>Attach outside work: a GitHub or Jira URL, source:key such as jira:ABC-1, or branch:owner/name@branch
--jsonPrint JSON

orion card timeline ​

Show a card's timeline: its most recent log entries, newest first

sh
orion card timeline [id] [options]
ArgumentDescription
[id]Card id
--limit <value>How many recent entries to show (default 5)
--jsonPrint JSON

orion card done ​

Mark one or more items done

sh
orion card done [options] [ids...]
ArgumentDescription
[ids...]Item ids or selectors
--where <value>Select targets with an expression instead of ids
--dry-runPreview changes and current revision without writing
--if-revision <value>Write only if the document has this revision
--jsonPrint JSON

orion card chain-close ​

Close out a done card and the waiting done cards chained to it, so their Done stamps show

sh
orion card chain-close [id] [options]
ArgumentDescription
[id]Item or group id, or a selector such as label:"Extract slider", ref:jira:ABC-12, or pr:86
--dry-runPreview the chain and current revision without writing
--if-revision <value>Write only if the document has this revision
--jsonPrint JSON

orion card import ​

Add a card for each URL or source:key in one step

sh
orion card import [options] [refs...]
ArgumentDescription
[refs...]GitHub or Jira URLs, or source:key such as jira:ABC-1
--stdinAlso read one reference per line from stdin
--group <value>Group to add the cards to
--dry-runPreview the cards without writing
--if-revision <value>Write only if the document has this revision
--jsonPrint JSON

orion card snooze ​

Hide items from attention and orion next until a time

sh
orion card snooze [options] [ids...]
ArgumentDescription
[ids...]Item ids
--until <value>Required. When it wakes: an ISO 8601 date or date-time, in local time unless it ends in Z or an offset
--where <value>Select items with an expression instead of ids
--dry-runPreview changes and current revision without writing
--if-revision <value>Write only if the document has this revision
--jsonPrint JSON

orion card unsnooze ​

Show snoozed items again right away

sh
orion card unsnooze [options] [ids...]
ArgumentDescription
[ids...]Item ids
--where <value>Select items with an expression instead of ids
--dry-runPreview changes and current revision without writing
--if-revision <value>Write only if the document has this revision
--jsonPrint JSON