CLI Reference¶
Complete reference for all Gira commands and options.
Table of Contents¶
Sprint Management¶
gira sprint show- Show details of a specific sprint.
Global Options¶
These options can be used with any command:
--help- Show help message and exit--version- Show version number and exit
Commands¶
gira sprint show¶
Show details of a specific sprint.
Arguments:
sprint_id- Sprint ID to show (e.g., SPRINT-001) (required)- Type: string
- Pattern:
^SPRINT-\d{3}$ - Examples: SPRINT-001, SPRINT-002
Options:
-f, --format- Output format- Type: enum
- Choices: TABLE, JSON, YAML, CSV, TSV, TEXT, IDS
- Default: text
-
Examples: json, table
-
--json- Output in JSON format (shorthand for --format json) -
Type: boolean
-
--tickets/--no-tickets- Show tickets belonging to this sprint - Type: boolean
-
Default: True
-
--filter-json- JSONPath expression to filter JSON output (e.g., '$.tickets[*]') -
Default:
-
--color- Enable syntax highlighting for JSON output (default: no color for AI compatibility) -
Type: boolean
-
--no-color- Explicitly disable syntax highlighting (default is already no color) - Type: boolean
Examples: