Skip to content

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 graph

gira graph [entity_args] [options]

Arguments:

  • entity_args - Ticket ID (e.g., GCM-123) or epic command (e.g., epic EPIC-001) (optional)
  • Type: array

Options:

  • -d, --depth - Maximum depth to traverse relationships
  • Type: integer

  • Default: 2

  • --blockers/--no-blockers - Show tickets that block this ticket

  • Type: boolean

  • Default: True

  • --blocks/--no-blocks - Show tickets blocked by this ticket

  • Type: boolean

  • Default: True

  • --parent/--no-parent - Show parent ticket relationship

  • Type: boolean

  • Default: True

  • --children/--no-children - Show child tickets

  • Type: boolean

  • Default: True

  • --epic/--no-epic - Show epic relationship

  • Type: boolean

  • Default: True

  • -f, --format - Output format: tree, json

  • Choices: text, json, table, csv
  • Default: tree

  • Examples: json, table

  • --epics - Show all epics overview

  • Type: boolean

  • --epic-deps - Show dependencies between epics

  • Type: boolean

  • --mixed - Show mixed view of epics and tickets

  • Type: boolean

  • -s, --status - Filter epics by status (for --epics mode)

  • Choices: backlog, todo, in_progress, review, done
  • Default:

  • Examples: backlog, todo, in_progress

  • -o, --owner - Filter epics by owner (for --epics mode)

  • Default:
  • Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

  • Examples: user@example.com, john.doe@company.org

  • --min-progress - Filter epics by minimum progress percentage

  • Type: integer

  • Default:

  • --all-tickets - Show all tickets in epic view (default shows first 5 per status)

  • Type: boolean

  • --compact - Use compact mode for large graphs

  • Type: boolean

  • --stats - Show graph statistics panel

  • Type: boolean

  • --legend - Show legend for icons and colors

  • Type: boolean
  • Pattern: ^\d{4}-\d{2}-\d{2}$

  • Examples: 2025-01-20, 2025-12-31

  • --enhanced - Use enhanced visual display with panels

  • Type: boolean

  • --export - Export graph to file (format determined by extension: .svg, .png, .html, .mermaid, .dot)

  • Default:

Examples:

gira graph

gira graph --format json --status backlog

gira graph --blockers/--no-blockers