CLI Reference¶
Complete reference for all Gira commands and options.
Table of Contents¶
Epic Management¶
gira epic list- List epics with optional filters.
Global Options¶
These options can be used with any command:
--help- Show help message and exit--version- Show version number and exit
Commands¶
gira epic list¶
List epics with optional filters.
Options:
-q, --query- Query expression (e.g., 'status:active AND owner:me()')- Default:
-
Examples: ..py$, ^test_., (bug|fix):
-
-s, --status- Filter by status (draft, active, completed) - Choices: backlog, todo, in_progress, review, done
- Default:
-
Examples: backlog, todo, in_progress
-
-o, --owner- Filter by owner email - Default:
- Pattern:
^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ -
Examples: user@example.com, john.doe@company.org
-
--search- Search text in epic fields (default: title and description) -
Default:
-
--search-in- Specify fields to search: title, description, id, status, owner, all (can be used multiple times) - Type: array
-
Default:
-
--exact-match- Perform exact string match instead of fuzzy match -
Type: boolean
-
--regex-search- Treat search pattern as a regular expression - Type: boolean
-
Examples: ..py$, ^test_., (bug|fix):
-
--case-sensitive-search- Make search case-sensitive -
Type: boolean
-
-f, --format- Output format - Type: enum
- Choices: TABLE, JSON, YAML, CSV, TSV, TEXT, IDS
- Default: table
-
Examples: json, table
-
--counts- Show summary counts -
Type: boolean
-
--fields- Comma-separated list of fields to include in JSON output (e.g., 'id,title,status' or use aliases like 'epic_basics') -
Default:
-
--filter-json- JSONPath expression to filter JSON output (e.g., '$[?(@.status=="active")].id') -
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: