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 webhook add

Add a new webhook endpoint.

gira webhook add <name><url> [options]

Arguments:

  • name - Name for the webhook endpoint (required)

  • Type: string

  • url - Webhook URL to send events to (required)

  • Type: string

Options:

  • -e, --events - Comma-separated list of events to send (or '*' for all)

  • Default: ticket_created,ticket_updated,ticket_moved

  • -t, --template - Template to apply for formatting (slack, discord, etc.)

  • Default:

  • -f, --filter - Filter events using Gira query language

  • Default:

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

  • --auth-type - Authentication type (bearer, api_key, basic)

  • Default:

  • --auth-token - Authentication token (use ${ENV_VAR} for environment variables)

  • Default:

  • --auth-key - Authentication header key (for api_key auth)

  • Default:

  • --auth-username - Username for basic auth (use ${ENV_VAR} for environment variables)

  • Default:

  • --auth-password - Password for basic auth (use ${ENV_VAR} for environment variables)

  • Default:

  • --timeout - Request timeout in seconds (default: global setting)

  • Type: integer

  • Default:

  • --retry-attempts - Number of retry attempts (default: global setting)

  • Type: integer

  • Default:

  • --headers - Additional headers as JSON string

  • Default:

  • --enabled/--disabled - Whether the webhook is enabled

  • Type: boolean
  • Default: True

Examples:

gira webhook add <name> <url>

gira webhook add <name> <url> --enabled/--disabled

gira webhook remove

Remove a webhook endpoint.

gira webhook remove <name> [options]

Arguments:

  • name - Name of the webhook endpoint to remove (required)
  • Type: string

Options:

  • -f, --force - Skip confirmation prompt
  • Type: boolean

Examples:

gira webhook remove <name>

gira webhook remove <name> --force

gira webhook list

List configured webhook endpoints.

gira webhook list [options]

Options:

  • -v, --verbose - Show detailed information about each webhook
  • Type: boolean

Examples:

gira webhook list

gira webhook list --verbose

gira webhook test

Test a webhook endpoint with a sample payload.

gira webhook test <name> [options]

Arguments:

  • name - Name of the webhook endpoint to test (required)
  • Type: string

Options:

  • -e, --event - Event type for the test payload (default: test)
  • Default: test

Examples:

gira webhook test <name>

gira webhook enable

Enable webhooks globally or a specific webhook endpoint.

gira webhook enable [name]

Arguments:

  • name - Name of specific webhook to enable (omit to enable globally) (optional)
  • Type: string

Examples:

gira webhook enable

gira webhook disable

Disable webhooks globally or a specific webhook endpoint.

gira webhook disable [name] [options]

Arguments:

  • name - Name of specific webhook to disable (omit to disable globally) (optional)
  • Type: string

Options:

  • -f, --force - Skip confirmation prompt for global disable
  • Type: boolean

Examples:

gira webhook disable

gira webhook disable --force

gira webhook health

Check webhook endpoint health and connectivity.

gira webhook health [name] [options]

Arguments:

  • name - Name of webhook to check (omit to check all) (optional)
  • Type: string

Options:

  • -v, --verbose - Show detailed health information
  • Type: boolean

Examples:

gira webhook health

gira webhook health --verbose

gira webhook stats

Show webhook delivery statistics.

gira webhook stats [name]

Arguments:

  • name - Name of webhook to show stats for (omit to show all) (optional)
  • Type: string

Examples:

gira webhook stats

gira webhook webhook filter help

Show help for webhook filter expressions.

gira webhook webhook filter help

Examples:

gira webhook filter help

gira webhook webhook filter validate

Validate a webhook filter expression.

gira webhook webhook filter validate <expression>

Arguments:

  • expression - Filter expression to validate (required)
  • Type: string

Examples:

gira webhook filter validate <expression>