CLI Reference¶
Complete reference for all Gira commands and options.
Table of Contents¶
Configuration¶
-
gira config rename-prefix
- Rename the ticket ID prefix for the entire project. -
gira config reset
- Reset configuration to default values. -
gira config set
- Set a configuration value.
Global Options¶
These options can be used with any command:
--help
- Show help message and exit--version
- Show version number and exit
Commands¶
gira config set
¶
Set a configuration value.
Arguments:
key
- Configuration key (e.g., user.name) (required)-
Type: string
-
value
- Configuration value (required) - Type: string
Options:
-g, --global
- Set in global config (not implemented)- Type: boolean
- Examples: .py, **/.json, src/**/*.ts
Examples:
gira config get
¶
Arguments:
key
- Configuration key to get (show all if not specified) (optional)- Type: string
Options:
-l, --list
- List all configuration keys-
Type: boolean
-
-f, --format
- Output format: table, json - Choices: text, json, table, csv
- Default: table
-
Examples: json, table
-
--json
- Output as JSON (shorthand for --format json) -
Type: boolean
-
--fields
- Comma-separated list of fields to include in JSON output (for filtering config keys) - Default:
Examples:
gira config reset
¶
Reset configuration to default values.
Arguments:
key
- Configuration key to reset (reset all if not specified) (optional)- Type: string
Options:
-f, --force
- Skip confirmation prompt- Type: boolean
Examples:
gira config rename-prefix
¶
Rename the ticket ID prefix for the entire project.
Arguments:
new_prefix
- New ticket ID prefix (2-5 uppercase letters) (required)- Type: string
Options:
-f, --force
- Skip confirmation prompts- Type: boolean
Examples: