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

Add attachment(s) to a ticket or epic.

gira attachment add <entity_id><file_paths> [options]

Arguments:

  • entity_id - Ticket or epic ID to attach file to (e.g., PROJ-123, 123, or EPIC-001) (required)

  • Type: string

  • file_paths - Path(s) to file(s) or directory to attach (required)

  • Type: array
  • Examples: .gira/config.json, /path/to/file.txt, ./relative/path.md

Options:

  • -n, --note - Optional description or note for the attachments

  • Default:

  • -t, --type - Entity type: ticket or epic (auto-detected if not specified)

  • Default:

  • --commit/--no-commit - Automatically commit the attachment pointers

  • Type: boolean

  • Default: True

  • -u, --user - User adding the attachment (defaults to git user)

  • Default:

  • -i, --include - Include only files matching pattern (e.g., '*.pdf')

  • Default:

  • -e, --exclude - Exclude files matching pattern (e.g., '*.tmp')

  • Default:

Examples:

gira attachment add <entity_id> .gira/config.json

gira attachment add <entity_id> .gira/config.json --commit/--no-commit

gira attachment cat

gira attachment cat <entity_id><filename> [options]

Arguments:

  • entity_id - Entity ID (e.g., GCM-123 or EPIC-001) (required)

  • Type: string

  • filename - Attachment filename to stream (required)

  • Type: string
  • Examples: .gira/config.json, /path/to/file.txt, ./relative/path.md

Options:

  • -t, --type - Entity type (ticket or epic)
  • Default:

Examples:

gira attachment cat <entity_id> .gira/config.json

gira attachment download

Download attachment(s) to specified location without opening.

gira attachment download <entity_id><patterns> [options]

Arguments:

  • entity_id - Entity ID (e.g., GCM-123 or EPIC-001) (required)

  • Type: string

  • patterns - Attachment filename(s) or pattern(s) to download (required)

  • Type: array

Options:

  • -t, --type - Entity type (ticket or epic)

  • Default:

  • -o, --output - Output directory (defaults to current directory)

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

  • Examples: json, table

  • -q, --quiet - Suppress progress output

  • Type: boolean

  • -f, --force - Overwrite existing files without prompting

  • Type: boolean

  • -a, --all - Download all attachments for the entity

  • Type: boolean
  • Examples: .gira/config.json, /path/to/file.txt, ./relative/path.md

Examples:

gira attachment download <entity_id> <patterns>

gira attachment download <entity_id> <patterns> --quiet

gira attachment list

List all attachments for a ticket or epic.

gira attachment list <entity_id> [options]

Arguments:

  • entity_id - Ticket or epic ID to list attachments for (e.g., PROJ-123 or EPIC-001) (required)
  • Type: string

Options:

  • -t, --type - Entity type: ticket or epic (auto-detected if not specified)

  • Default:

  • -f, --format - Output format: table, json, or simple

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

  • Examples: json, table

  • --file-type - Filter by file type/extension (e.g., pdf, png, xlsx)

  • Default:

  • Examples: .gira/config.json, /path/to/file.txt, ./relative/path.md

  • --after - Show attachments uploaded after date (YYYY-MM-DD)

  • Default:

  • --before - Show attachments uploaded before date (YYYY-MM-DD)

  • Default:

  • -p, --show-provider - Show storage provider details

  • Type: boolean

Examples:

gira attachment list <entity_id>

gira attachment list <entity_id> --format json

gira attachment list <entity_id> --show-provider

gira attachment open

gira attachment open <entity_id><attachment_ids> [options]

Arguments:

  • entity_id - Entity ID (e.g., GCM-123 or EPIC-001) (required)

  • Type: string

  • attachment_ids - Attachment ID(s) to open (required)

  • Type: array

Options:

  • -t, --type - Entity type (ticket or epic)

  • Default:

  • -d, --download-only - Download without opening

  • Type: boolean

  • -o, --output - Output directory for downloads

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

  • Examples: json, table

  • --no-cache - Skip cache and download fresh copy

  • Type: boolean

  • -f, --force - Overwrite existing files

  • Type: boolean

Examples:

gira attachment open <entity_id> <attachment_ids>

gira attachment open <entity_id> <attachment_ids> --download-only

gira attachment remove

gira attachment remove <entity_id><attachment_ids> [options]

Arguments:

  • entity_id - Entity ID (e.g., GCM-123 or EPIC-001) (required)

  • Type: string

  • attachment_ids - Attachment filename(s) or ID(s) to remove (required)

  • Type: array

Options:

  • -t, --type - Entity type (ticket or epic)

  • Default:

  • -r, --delete-remote - Also delete files from remote storage

  • Type: boolean

  • -n, --dry-run - Preview changes without executing

  • Type: boolean

  • -f, --force - Skip confirmation prompts

  • Type: boolean

  • --no-commit - Don't auto-commit changes to Git

  • Type: boolean

Examples:

gira attachment remove <entity_id> <attachment_ids>

gira attachment remove <entity_id> <attachment_ids> --delete-remote