Skip to content

CLI Reference

Complete reference for all Gira commands and options.

Table of Contents

Comments

Global Options

These options can be used with any command:

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

Commands

gira comment list

List all comments on a ticket or epic.

gira comment list <entity_id> [options]

Arguments:

  • entity_id - Ticket or Epic ID to show comments for (e.g., GCM-123 or EPIC-001) (required)
  • Type: string

Options:

  • -l, --limit - Limit number of comments shown
  • Type: integer

  • Default:

  • -r, --reverse - Show oldest comments first

  • Type: boolean

  • -f, --format - Output format

  • Type: enum
  • Choices: TABLE, JSON, YAML, CSV, TSV, TEXT, IDS
  • Default: text

  • Examples: json, table

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

  • Type: boolean

  • --fields - Comma-separated list of fields to include in JSON output (e.g., 'id,author,content' or use aliases like 'comment_basics')

  • Default:

  • --filter-json - JSONPath expression to filter JSON output (e.g., '$[?(@.author=="john@example.com")].content')

  • Default:

  • -v, --verbose - Show detailed information including attachment details

  • 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 comment list <entity_id>

gira comment list <entity_id> --format json

gira comment list <entity_id> --reverse