Skip to content

CLI Reference

Complete reference for all Gira commands and options.

Table of Contents

Core 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 board

Display the kanban board.

gira board [options]

Options:

  • -a, --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

  • -p, --priority - Filter by priority

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

  • -t, --type - Filter by ticket type

  • Default:

  • -l, --label - Filter by label

  • Default:

  • --story-points-eq - Filter by exact story point value

  • Type: integer
  • Default:

  • --story-points-gt - Filter by story points greater than value

  • Type: integer
  • Default:

  • --story-points-lt - Filter by story points less than value

  • Type: integer
  • Default:

  • --created-after - Filter tickets created after date (YYYY-MM-DD)

  • Default:
  • Pattern: ^\d{4}-\d{2}-\d{2}$
  • Examples: 2025-01-20, 2025-12-31

  • --created-before - Filter tickets created before date (YYYY-MM-DD)

  • Default:
  • Pattern: ^\d{4}-\d{2}-\d{2}$
  • Examples: 2025-01-20, 2025-12-31

  • --updated-after - Filter tickets updated after date (YYYY-MM-DD)

  • Default:
  • Pattern: ^\d{4}-\d{2}-\d{2}$
  • Examples: 2025-01-20, 2025-12-31

  • --updated-before - Filter tickets updated before date (YYYY-MM-DD)

  • Default:
  • Pattern: ^\d{4}-\d{2}-\d{2}$
  • Examples: 2025-01-20, 2025-12-31

  • --due-after - Filter tickets due after date (YYYY-MM-DD)

  • Default:

  • --due-before - Filter tickets due before date (YYYY-MM-DD)

  • Default:

  • --due-on - Filter tickets due on specific date (YYYY-MM-DD)

  • Default:

  • --overdue - Show only tickets past their due date

  • Type: boolean

  • --has-comments - Show only tickets that have comments

  • Type: boolean

  • --no-comments - Show only tickets without comments

  • Type: boolean

  • --has-parent - Show only subtasks that have a parent ticket

  • Type: boolean

  • --no-parent - Show only tickets that are not subtasks

  • Type: boolean

  • --in-sprint - Filter tickets in a specific sprint

  • Default:

  • --not-in-sprint - Filter tickets not in a specific sprint

  • Default:

  • --not-in-epic - Filter tickets not linked to a specific epic

  • Default:

  • -c, --compact - Show compact view

  • Type: boolean

  • --fast - Use optimized display for large projects

  • 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

  • --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 board
gira board --assignee user@example.com --priority medium
gira board --overdue