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 metrics overview

Display comprehensive metrics overview for the project.

gira metrics overview [options]

Options:

  • -f, --format - Output format: human, json
  • Choices: text, json, table, csv
  • Default: human

  • Examples: json, table

  • -d, --days - Number of days to analyze for trends

  • Type: integer
  • Default: 30

  • Examples: 7, 14, 30

  • --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 metrics overview

gira metrics overview --format json

gira metrics overview --color

gira metrics velocity

Display team velocity trends across sprints.

gira metrics velocity [options]

Options:

  • -n, --limit - Number of sprints to display
  • Type: integer

  • Default: 5

  • -f, --format - Output format: human, json, csv

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

  • Examples: json, table

  • --all - Show all sprints including active ones

  • 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 metrics velocity

gira metrics velocity --format json

gira metrics velocity --all

Display ticket creation, completion, and backlog trends over time.

gira metrics trends [options]

Options:

  • -d, --days - Number of days to analyze
  • Type: integer
  • Default: 30

  • Examples: 7, 14, 30

  • -f, --format - Output format: human, json, csv

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

  • Examples: json, table

  • --type - Filter by ticket type

  • Default:

  • --priority - Filter by priority

  • Choices: low, medium, high, critical
  • Default:

  • Examples: medium, high

  • --assignee - Filter by assignee

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

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

  • --epic - Filter by epic ID

  • 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 metrics trends

gira metrics trends --format json --priority medium

gira metrics trends --color

gira metrics duration

Analyze time tickets spend in each status to identify bottlenecks.

gira metrics duration [options]

Options:

  • -d, --days - Analyze tickets from last N days
  • Type: integer
  • Default:

  • Examples: 7, 14, 30

  • -f, --format - Output format: human, json, csv

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

  • Examples: json, table

  • --type - Filter by ticket type

  • Default:

  • --priority - Filter by priority

  • Choices: low, medium, high, critical
  • Default:

  • Examples: medium, high

  • --no-cache - Bypass cache and force fresh analysis

  • Type: boolean

  • --no-progress - Disable progress indicator

  • Type: boolean

  • --force-batch - Force batch git operations (for testing)

  • Type: boolean

  • --working-hours - Calculate durations using business hours only

  • Type: boolean

  • Examples: 7, 14, 30

  • --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 metrics duration

gira metrics duration --format json --priority medium

gira metrics duration --no-cache