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 create

Create a new sprint.

gira sprint create <name> [options]

Arguments:

  • name - Sprint name (required)
  • Type: string

Options:

  • -g, --goal - Sprint goal
  • Default:

  • --goal-file - Read goal from a file

  • Default:
  • Examples: sprint-goals.md, objectives/q1-goals.txt, ./planning/sprint-15.md

  • -s, --start-date - Start date (YYYY-MM-DD, defaults to today)

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

  • -e, --end-date - End date (YYYY-MM-DD, overrides duration)

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

  • -d, --duration - Duration in days (ignored if end-date is provided)

  • Type: integer
  • Default: 14
  • Examples: 7, 14, 30

  • -q, --quiet - Quiet mode - only show sprint ID

  • Type: boolean

Examples:

gira sprint create "Sprint 23" --goal "Complete authentication features" --duration 14
gira sprint create "Q1 Sprint 1" --start-date 2025-01-15 --duration 21