Skip to content

CLI Reference

Complete reference for all Gira commands and options.

Table of Contents

Other 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 context show

Display comprehensive context for a ticket (explicit show subcommand).

gira context show <ticket_id> [options]

Arguments:

  • ticket_id - Ticket ID to show context for (required)
  • Type: string
  • Pattern: ^[A-Z]{2,4}-\d+$
  • Examples: GIRA-123, GCM-456, PROJ-1

Options:

  • -o, --output - Output format: text, json
  • Choices: text, json, table, csv
  • Default: text
  • Examples: json, table

  • -f, --fields - Comma-separated list of fields to include

  • Default:

  • --include-archived - Include archived tickets in related items

  • Type: boolean

Examples:

gira context show GIRA-123
gira context show GIRA-123 --include-archived

gira context tree

Show visual dependency tree for a ticket.

gira context tree <ticket_id> [options]

Arguments:

  • ticket_id - Ticket ID to show dependency tree for (required)
  • Type: string
  • Pattern: ^[A-Z]{2,4}-\d+$
  • Examples: GIRA-123, GCM-456, PROJ-1

Options:

  • -d, --max-depth - Maximum tree depth
  • Type: integer
  • Default: 3

  • --include-archived - Include archived tickets

  • Type: boolean

Examples:

gira context tree GIRA-123
gira context tree GIRA-123 --include-archived

gira context epic

Show ticket in the context of its epic.

gira context epic <ticket_id> [options]

Arguments:

  • ticket_id - Ticket ID to show in epic context (required)
  • Type: string
  • Pattern: ^[A-Z]{2,4}-\d+$
  • Examples: GIRA-123, GCM-456, PROJ-1

Options:

  • -a, --all - Show all epic tickets, not just related
  • Type: boolean

Examples:

gira context epic GIRA-123
gira context epic GIRA-123 --all

gira context timeline

Show activity timeline for a ticket.

gira context timeline <ticket_id> [options]

Arguments:

  • ticket_id - Ticket ID to show timeline for (required)
  • Type: string
  • Pattern: ^[A-Z]{2,4}-\d+$
  • Examples: GIRA-123, GCM-456, PROJ-1

Options:

  • -d, --days - Number of days to show
  • Type: integer
  • Default: 30
  • Examples: 7, 14, 30

Examples:

gira context timeline GIRA-123

Find tickets related by various criteria.

gira context related <ticket_id> [options]

Arguments:

  • ticket_id - Ticket ID to find related tickets for (required)
  • Type: string
  • Pattern: ^[A-Z]{2,4}-\d+$
  • Examples: GIRA-123, GCM-456, PROJ-1

Options:

  • -m, --max - Maximum results per category
  • Type: integer
  • Default: 10

Examples:

gira context related GIRA-123

gira context references

Show where this ticket is referenced (comments, commits).

gira context references <ticket_id>

Arguments:

  • ticket_id - Ticket ID to find references for (required)
  • Type: string
  • Pattern: ^[A-Z]{2,4}-\d+$
  • Examples: GIRA-123, GCM-456, PROJ-1

Examples:

gira context references GIRA-123