Skip to content

CLI Reference

Complete reference for all Gira commands and options.

Table of Contents

Sprint Management

Global Options

These options can be used with any command:

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

Commands

gira sprint list

List all sprints.

gira sprint list [options]

Options:

  • -q, --query - Query expression (e.g., 'status:active AND name:~"sprint"')
  • Default:

  • Examples: ..py$, ^test_., (bug|fix):

  • --status - Filter by sprint status (planned, active, completed)

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

  • Examples: backlog, todo, in_progress

  • --after - Show sprints that start after this date (YYYY-MM-DD)

  • Default:

  • --before - Show sprints that end before this date (YYYY-MM-DD)

  • Default:

  • --between - Show sprints within date range (YYYY-MM-DD,YYYY-MM-DD)

  • Default:

  • --min-tickets - Show sprints with at least this many tickets

  • Type: integer

  • Default:

  • --active - Show only active sprints (deprecated: use --status active)

  • Type: boolean

  • --completed - Show only completed sprints (deprecated: use --status completed)

  • Type: boolean

  • --search - Search text in sprint fields (default: name and goal)

  • Default:

  • --search-in - Specify fields to search: name, goal, id, status, all (can be used multiple times)

  • Type: array

  • Default:

  • --exact-match - Perform exact string match instead of fuzzy match

  • Type: boolean

  • --regex-search - Treat search pattern as a regular expression

  • Type: boolean

  • Examples: ..py$, ^test_., (bug|fix):

  • --case-sensitive-search - Make search case-sensitive

  • Type: boolean

  • -f, --format - Output format

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

  • 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,name,status' or use aliases like 'sprint_basics')

  • Default:

  • --filter-json - JSONPath expression to filter JSON output (e.g., '$[?(@.status=="active")].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 sprint list

gira sprint list --status backlog --format json

gira sprint list --active