Skip to content

CLI Reference

Complete reference for all Gira commands and options.

Table of Contents

Epic Management

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 show

Show details of a specific epic.

gira epic show <epic_id> [options]

Arguments:

  • epic_id - Epic ID to show (e.g., EPIC-001) (required)
  • Type: string
  • Pattern: ^EPIC-\d{3}$
  • Examples: EPIC-001, EPIC-002

Options:

  • -f, --format - Output format
  • Type: enum
  • Choices: TABLE, JSON, YAML, CSV, TSV, TEXT, IDS
  • Default: text

  • Examples: json, table

  • --json - Output as JSON (shorthand for --format json)

  • Type: boolean

  • --tickets/--no-tickets - Show tickets belonging to this epic

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

gira epic show EPIC-001

gira epic show EPIC-001 --format json

gira epic show EPIC-001 --json