Skip to content

CLI Reference

Complete reference for all Gira commands and options.

Table of Contents

Core Commands

  • gira query - Execute queries and manage saved queries.

Global Options

These options can be used with any command:

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

Commands

gira query

Execute queries and manage saved queries.

gira query [options]

Options:

  • -e, --entity - Type of entity to search
  • Default: ticket

  • -f, --format - Output format

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

  • -l, --limit - Maximum number of results to return

  • Type: integer
  • Default:

  • -o, --offset - Number of results to skip

  • Type: integer
  • Default: 0

  • -s, --sort - Sort results by field

  • Default:

  • --filter-json - JSONPath expression to filter JSON output

  • Default:

  • --no-header - Don't show table header

  • Type: boolean

  • -v, --verbose - Show detailed error messages

  • Type: boolean

  • --save - Save query with given name

  • Default:

  • -d, --description - Description for saved query

  • Default:
  • Max length: 5000

  • --force - Overwrite existing saved query

  • Type: boolean

  • --color/--no-color - Enable/disable colored output

  • Type: boolean
  • Default: True

Examples:

gira query
gira query --format json
gira query --no-header