Skip to content

CLI Reference

Complete reference for all Gira commands and options.

Table of Contents

Comments

Global Options

These options can be used with any command:

  • --help - Show help message and exit
  • --version - Show version number and exit

Commands

gira comment add

Add a comment to a ticket or epic.

gira comment add <entity_id> [options]

Arguments:

  • entity_id - Ticket or Epic ID to add comment to (e.g., GCM-123 or EPIC-001) (required)
  • Type: string

Options:

  • -c, --content - Comment content

  • Default:

  • --content-file - Read comment content from a file

  • Default:

  • Examples: comment.md, update-notes.txt, ./feedback/review-comments.md

  • -e, --editor - Open editor for comment

  • Type: boolean

  • -a, --attach - Attach file(s) to the comment (can be used multiple times)

  • Type: array
  • Default:

Examples:

gira comment add GCM-123

gira comment add PROJ-456 --message "Fixed the issue with login timeout"

gira comment list

List all comments on a ticket or epic.

gira comment list <entity_id> [options]

Arguments:

  • entity_id - Ticket or Epic ID to show comments for (e.g., GCM-123 or EPIC-001) (required)
  • Type: string

Options:

  • -l, --limit - Limit number of comments shown
  • Type: integer

  • Default:

  • -r, --reverse - Show oldest comments first

  • Type: boolean

  • -f, --format - Output format

  • Type: enum
  • Choices: TABLE, JSON, YAML, CSV, TSV, TEXT, IDS
  • Default: text

  • Examples: json, table

  • --json - Output in JSON format (shorthand for --format json)

  • Type: boolean

  • --fields - Comma-separated list of fields to include in JSON output (e.g., 'id,author,content' or use aliases like 'comment_basics')

  • Default:

  • --filter-json - JSONPath expression to filter JSON output (e.g., '$[?(@.author=="john@example.com")].content')

  • Default:

  • -v, --verbose - Show detailed information including attachment details

  • Type: boolean

  • --color - Enable syntax highlighting for JSON output (default: no color for AI compatibility)

  • Type: boolean

  • --no-color - Explicitly disable syntax highlighting (default is already no color)

  • Type: boolean

Examples:

gira comment list <entity_id>

gira comment list <entity_id> --format json

gira comment list <entity_id> --reverse

gira comment delete

Delete a comment from a ticket or epic.

gira comment delete <entity_id><comment_id> [options]

Arguments:

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

  • Type: string

  • comment_id - Comment ID to delete (required)

  • Type: string

Options:

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

Examples:

gira comment delete <entity_id> <comment_id>

gira comment delete <entity_id> <comment_id> --force

gira comment attach

Attach files to an existing comment.

gira comment attach [entity_id][comment_id][file_paths] [options]

Arguments:

  • entity_id - Ticket or Epic ID (e.g., GCM-123, 123, or EPIC-001) (optional)

  • Type: string

  • comment_id - Comment ID to attach files to (optional)

  • Type: string

  • file_paths - Path(s) to file(s) to attach (optional)

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

Options:

  • -i, --interactive - Run in interactive mode

  • Type: boolean

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

  • Default:

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

  • Default:

Examples:

gira comment attach

gira comment attach --interactive

gira comment detach

gira comment detach <entity_id><comment_id>[filenames] [options]

Arguments:

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

  • Type: string

  • comment_id - Comment ID to remove attachments from (required)

  • Type: string

  • filenames - Filename(s) to remove (if not specified, use --all) (optional)

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

Options:

  • -a, --all - Remove all attachments from the comment

  • Type: boolean

  • -f, --force - Skip confirmation prompt

  • Type: boolean

Examples:

gira comment detach <entity_id> <comment_id>

gira comment detach <entity_id> <comment_id> --all

gira comment download

gira comment download <entity_id><comment_id>[filenames] [options]

Arguments:

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

  • Type: string

  • comment_id - Comment ID to download attachments from (required)

  • Type: string

  • filenames - Specific filename(s) to download (downloads all if not specified) (optional)

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

Options:

  • -o, --output - Output directory (defaults to current directory)
  • Choices: text, json, table, csv
  • Default:

  • Examples: json, table

  • -a, --all - Download all attachments (default if no filenames specified)

  • Type: boolean

  • -f, --overwrite - Overwrite existing files

  • Type: boolean

Examples:

gira comment download <entity_id> <comment_id>

gira comment download <entity_id> <comment_id> --all