Skip to content

CLI Reference

Complete reference for all Gira commands and options.

Table of Contents

Other Commands

  • gira backlog - Show tickets in the backlog with enhanced filtering and display options.

Global Options

These options can be used with any command:

  • --help - Show help message and exit
  • --version - Show version number and exit

Commands

gira backlog

Show tickets in the backlog with enhanced filtering and display options.

gira backlog [options]

Options:

  • -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

  • -p, --priority - Filter by priority (critical, high, medium, low)

  • Choices: low, medium, high, critical
  • Default:
  • Examples: medium, high

  • -t, --type - Filter by type (bug, feature, task, etc.)

  • Default:

  • -l, --label - Filter by label

  • Default:

  • --epic - Filter by epic ID (comma-separated for multiple)

  • Default:

  • --no-epic - Show only tickets without epic assignment

  • Type: boolean

  • --search - Search text in ticket title and description

  • Default:

  • --sort - Sort by: priority (default), created, updated, title, id

  • Default: priority

  • --limit - Limit number of results shown

  • Type: integer
  • Default:

  • -f, --format - Output format

  • Type: enum
  • Choices: TABLE, JSON, YAML, CSV, TSV, TEXT, IDS
  • Default: table
  • Examples: json, table

  • --fields - Comma-separated list of fields to include in JSON output

  • Default:

  • --counts - Show summary counts by priority

  • Type: boolean

  • --ready - Show only ready tickets (no blockers, assigned)

  • Type: boolean

  • --unassigned - Show only unassigned tickets

  • Type: boolean

  • --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:

gira backlog
gira backlog --assignee user@example.com --priority medium
gira backlog --no-epic