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 storage configure

Configure storage backend for attachments.

gira storage configure [options]

Options:

  • -p, --provider - Storage provider (s3, r2, b2, gcs, azure)
  • Default:

  • -b, --bucket - Storage bucket name

  • Default:

  • --test/--no-test - Test connection after configuration

  • Type: boolean
  • Default: True

  • --update-project/--no-update-project - Update project configuration

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

  • --encrypt/--no-encrypt - Encrypt stored credentials

  • Type: boolean

Examples:

gira storage configure
gira storage configure --test/--no-test

gira storage status

Check storage configuration and credential status.

gira storage status

Examples:

gira storage status

gira storage validate

Validate storage credentials and show detailed information.

gira storage validate [options]

Options:

  • -p, --provider - Storage provider to validate (s3, r2, b2, gcs, azure)
  • Default:

  • --help-credentials - Show credential help for providers

  • Type: boolean

Examples:

gira storage validate
gira storage validate --help-credentials