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 workflow show

Display available workflow transitions for a ticket.

gira workflow show <ticket_id> [options]

Arguments:

  • ticket_id - Ticket ID to show workflow for (required)
  • Type: string
  • Pattern: ^[A-Z]{2,4}-\d+$
  • Examples: GIRA-123, GCM-456, PROJ-1

Options:

  • -c, --check - Check if a specific transition is valid

  • Default:

  • -o, --output - Output format: text, json

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

  • Examples: json, table

  • -v, --visual - Show visual workflow position

  • Type: boolean

Examples:

gira workflow show GIRA-123

gira workflow show GIRA-123 --visual

gira workflow validate

Validate all tickets against workflow rules.

gira workflow validate [options]

Options:

  • -s, --status - Only validate tickets in this status
  • Choices: backlog, todo, in_progress, review, done
  • Default:

  • Examples: backlog, todo, in_progress

  • -t, --type - Only validate tickets of this type

  • Choices: story, task, bug, epic, feature, subtask
  • Default:

  • Examples: task, bug, feature

  • -e, --epic - Only validate tickets in this epic

  • Default:

  • -o, --output - Output format: text, json

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

  • Examples: json, table

  • -f, --fix - Attempt to auto-fix violations where possible

  • Type: boolean

Examples:

gira workflow validate

gira workflow validate --status backlog

gira workflow validate --fix

gira workflow apply

Apply a predefined workflow template.

gira workflow apply <template> [options]

Arguments:

  • template - Template name (scrum, kanban, support-desk, bug-tracking) (required)
  • Type: string

Options:

  • -f, --force - Force apply even if board config exists
  • Type: boolean

Examples:

gira workflow apply <template>

gira workflow apply <template> --force

gira workflow templates

List available workflow templates.

gira workflow templates

Examples:

gira workflow templates

gira workflow rule

Manage custom workflow rules.

gira workflow rule <action>[name] [options]

Arguments:

  • action - Action: add, remove, list (required)

  • Type: string

  • name - Rule name (for add/remove) (optional)

  • Type: string

Options:

  • -s, --status - Status condition
  • Choices: backlog, todo, in_progress, review, done
  • Default:

  • Examples: backlog, todo, in_progress

  • -r, --requires - Requirements (field:value)

  • Default:

  • -m, --message - Violation message

  • Default:

Examples:

gira workflow rule <action>

gira workflow rule <action> --status backlog

gira workflow transitions

Manage allowed status transitions.

gira workflow transitions [action][from_status][to_status]

Arguments:

  • action - Action: add, remove, or leave empty to show (optional)

  • Type: string

  • from_status - From status (optional)

  • Type: string

  • Examples: backlog, todo, in_progress

  • to_status - To status (comma-separated for multiple) (optional)

  • Type: string
  • Examples: backlog, todo, in_progress

Examples:

gira workflow transitions

gira workflow strict

Enable or disable strict workflow enforcement.

gira workflow strict <action>

Arguments:

  • action - Action: enable, disable, or status (required)
  • Type: string

Examples:

gira workflow strict <action>

gira workflow enforce

Set workflow enforcement level.

gira workflow enforce <level>

Arguments:

  • level - Enforcement level: strict, warn, or off (required)
  • Type: string

Examples:

gira workflow enforce <level>

gira workflow diagram

Display visual workflow diagram.

gira workflow diagram [options]

Options:

  • -c, --counts - Show ticket counts for each status

  • Type: boolean

  • -o, --output - Output format: text, json

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

Examples:

gira workflow diagram

gira workflow diagram --counts

gira workflow stats

Show workflow statistics and metrics.

gira workflow stats [options]

Options:

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

  • Examples: 7, 14, 30

  • -o, --output - Output format: text, json

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

Examples:

gira workflow stats

gira workflow config

Display current workflow configuration.

gira workflow config

Examples:

gira workflow config

gira workflow analyze

Analyze workflow patterns and suggest improvements.

gira workflow analyze [options]

Options:

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

  • Examples: 7, 14, 30

  • -o, --output - Output format: text, json

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

Examples:

gira workflow analyze

gira workflow migrate

Migrate tickets from one workflow to another.

gira workflow migrate <from_workflow><to_workflow> [options]

Arguments:

  • from_workflow - Source workflow (current state) (required)

  • Type: string

  • to_workflow - Target workflow to migrate to (required)

  • Type: string

Options:

  • --dry-run/--apply - Preview changes without applying
  • Type: boolean

  • Default: True

  • --backup/--no-backup - Create backup before migration

  • Type: boolean

  • Default: True

  • -f, --force - Force migration even with conflicts

  • Type: boolean

Examples:

gira workflow migrate <from_workflow> <to_workflow>

gira workflow migrate <from_workflow> <to_workflow> --dry-run/--apply