CLI Reference¶
Complete reference for all Gira commands and options.
Table of Contents¶
Core Commands¶
Global Options¶
These options can be used with any command:
--help- Show help message and exit--version- Show version number and exit
Commands¶
gira describe¶
Arguments:
command- Command path to describe (e.g., 'ticket create') (optional)- Type: array
Options:
-f, --format- Output format: json or markdown- Choices: text, json, table, csv
- Default: json
-
Examples: json, table
-
--no-color- Explicitly disable syntax highlighting (default is already no color) -
Type: boolean
-
--color- Enable syntax highlighting (colors the JSON output) -
Type: boolean
-
--theme- Syntax highlighting theme (requires --color) -
Default: monokai
-
--indent- JSON indentation spaces - Type: integer
-
Default: 2
-
--compact- Compact JSON output -
Type: boolean
-
--render- Render markdown with Rich formatting - Type: boolean
- Pattern:
^\d{4}-\d{2}-\d{2}$ -
Examples: 2025-01-20, 2025-12-31
-
--examples/--no-examples- Include command examples in markdown - Type: boolean
-
Default: True
-
--full- Generate full documentation with all commands - Type: boolean
Examples: