CLI Reference¶
Complete reference for all Gira commands and options.
Table of Contents¶
Ticket Management¶
gira ticket list- List tickets 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 ticket list¶
List tickets with optional filters.
Options:
-q, --query- Query expression (e.g., 'status:todo AND priority:high')- Default:
-
Examples: ..py$, ^test_., (bug|fix):
-
-s, --status- Filter by status - Choices: backlog, todo, in_progress, review, done
- Default:
-
Examples: backlog, todo, in_progress
-
-a, --assignee- Filter by assignee - Default:
- Pattern:
^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ -
Examples: user@example.com, john.doe@company.org
-
-t, --type- Filter by type -
Default:
-
-p, --priority- Filter by priority - Choices: low, medium, high, critical
- Default:
-
Examples: medium, high
-
-l, --label- Filter by label -
Default:
-
--parent- Filter by parent ticket ID (show subtasks) -
Default:
-
--blocked- Show only tickets blocked by unresolved dependencies -
Type: boolean
-
--story-points-eq- Filter by exact story point value - Type: integer
-
Default:
-
--story-points-gt- Filter by story points greater than value - Type: integer
-
Default:
-
--story-points-lt- Filter by story points less than value - Type: integer
-
Default:
-
--created-after- Filter tickets created after date (YYYY-MM-DD) - Default:
- Pattern:
^\d{4}-\d{2}-\d{2}$ -
Examples: 2025-01-20, 2025-12-31
-
--created-before- Filter tickets created before date (YYYY-MM-DD) - Default:
- Pattern:
^\d{4}-\d{2}-\d{2}$ -
Examples: 2025-01-20, 2025-12-31
-
--updated-after- Filter tickets updated after date (YYYY-MM-DD) - Default:
- Pattern:
^\d{4}-\d{2}-\d{2}$ -
Examples: 2025-01-20, 2025-12-31
-
--updated-before- Filter tickets updated before date (YYYY-MM-DD) - Default:
- Pattern:
^\d{4}-\d{2}-\d{2}$ -
Examples: 2025-01-20, 2025-12-31
-
--due-after- Filter tickets due after date (YYYY-MM-DD) -
Default:
-
--due-before- Filter tickets due before date (YYYY-MM-DD) -
Default:
-
--due-on- Filter tickets due on specific date (YYYY-MM-DD) -
Default:
-
--overdue- Show only tickets past their due date -
Type: boolean
-
--has-comments- Show only tickets that have comments -
Type: boolean
-
--no-comments- Show only tickets without comments -
Type: boolean
-
--has-parent- Show only subtasks that have a parent ticket -
Type: boolean
-
--no-parent- Show only tickets that are not subtasks -
Type: boolean
-
--in-sprint- Filter tickets in a specific sprint -
Default:
-
--not-in-sprint- Filter tickets not in a specific sprint -
Default:
-
--not-in-epic- Filter tickets not linked to a specific epic -
Default:
-
--epic- Filter tickets by epic ID (comma-separated for multiple epics) -
Default:
-
--no-epic- Show only tickets without epic assignment (alias for --not-in-epic without value) -
Type: boolean
-
--search- Search text in ticket fields (default: title and description) -
Default:
-
--search-in- Specify fields to search: title, description, id, status, type, priority, assignee, reporter, labels, 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
-
--sort- Sort by: id, priority, created, updated, title, order -
Default: id
-
-f, --format- Output format - Type: enum
- Choices: TABLE, JSON, YAML, CSV, TSV, TEXT, IDS
- Default: table
-
Examples: json, table
-
--ids-only- Show only ticket IDs -
Type: boolean
-
--counts- Show summary counts -
Type: boolean
-
--include-archived- Include archived tickets in results -
Type: boolean
-
--fields- Comma-separated list of fields to include in JSON output (e.g., 'id,title,status' or use aliases like 'basics') -
Default:
-
--filter-json- JSONPath expression to filter JSON output (e.g., '$[?(@.priority=="high")].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: