Skip to content

CLI Reference

Complete reference for all Gira commands and options.

Table of Contents

Epic 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 epic update

Update an existing epic.

gira epic update [epic_id] [options]

Arguments:

  • epic_id - Epic ID to update (required unless using --stdin) (optional)
  • Type: string
  • Pattern: ^EPIC-\d{3}$
  • Examples: EPIC-001, EPIC-002

Options:

  • -t, --title - New title
  • Default:
  • Min length: 3
  • Max length: 200

  • -d, --description - New description (use '-' for stdin, 'editor' to open editor)

  • Default:
  • Max length: 5000

  • --description-file - Read description from a file

  • Default:
  • Examples: ticket-description.md, docs/feature-spec.md, /tmp/bug-report.txt

  • -s, --status - New status (draft, active, completed)

  • Choices: backlog, todo, in_progress, review, done
  • Default:
  • Examples: backlog, todo, in_progress

  • -o, --owner - New owner email

  • Default:
  • Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
  • Examples: user@example.com, john.doe@company.org

  • --target-date - New target date (YYYY-MM-DD)

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

  • --add-ticket - Add ticket to epic (can be used multiple times)

  • Type: array
  • Default:

  • --remove-ticket - Remove ticket from epic (can be used multiple times)

  • Type: array
  • Default:

  • --output - Output format: text, json

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

  • -q, --quiet - Only output epic ID

  • Type: boolean

  • --stdin - Read JSON array of epic updates from stdin

  • Type: boolean

  • --jsonl - Read JSONL (JSON Lines) format for streaming large datasets

  • Type: boolean

  • --dry-run - Preview changes without saving them

  • Type: boolean

Examples:

gira epic update EPIC-001 --status active
gira epic update EPIC-002 --add-ticket GCM-123 --add-ticket GCM-124