Config Commands
The config group lets you inspect and manage the active ajat configuration
without editing YAML by hand.
These commands are useful for repeatable workstation setup, CI preparation, and
support scenarios where you need a clear audit trail of configuration changes.
Sensitive values such as jira.api_token are always masked when displayed.
The config command family is available before license activation or full
credential setup, so you can prepare a machine before it is fully provisioned.
config create
Creates a new config file at the default location, pre-filled with all available
settings and their default values. Sensitive values such as jira.api_token are
left blank for you to fill in afterwards.
ajat config createIf a config file already exists, the command stops and leaves it untouched. Pass
--force (-f) to overwrite it and reset to defaults.
ajat config create --forceconfig where
Prints the absolute path to the active config file. The command prints the path whether or not the file exists.
ajat config whereExample output:
/Users/alice/Library/Application Support/ajat/config.yamlFlags
| Flag | Description |
|---|---|
--exists | Exit non-zero if the configuration file does not exist on disk |
--shell-escape | Quote the path so it can be pasted into a shell command |
# Fail if the file does not yet exist
ajat config where --exists
# Open the file in your editor
$EDITOR "$(ajat config where --shell-escape)"config list
Displays the complete effective configuration as YAML, including values loaded
from AJAT_ environment variables and CLI flags.
ajat config listUse this when you need to inspect the effective configuration instead of only the values written to disk.
Sample output
debug:
dir: debug
enabled: false
http:
client:
base_timeout: 1s
max_retries: 3
max_timeout: 30s
proxy: ""
jira:
api_token: AT************************************************************3D
domain: <tenant>.atlassian.net
type: cloud
username: <user>@<domain>
log:
file: ""
format: text
level: infoThe API token is automatically masked in the output, so the result is safe to share when reporting an issue or reviewing your setup. All other values are shown as-is.
config get
Retrieves the effective value of a single configuration key, printed as a YAML fragment. Keys use dot-notation. The key can be passed as an argument or piped in on standard input.
ajat config get KEYExamples
ajat config get jira.domain
ajat config get log.level
ajat config get http.client.max_retries
# Read the key from standard input
echo "jira.domain" | ajat config getThe value returned is the one ajat will actually use after applying its
precedence: CLI flags, then AJAT_ environment variables, then the config file,
then defaults. jira.api_token is masked.
config set
Saves a configuration value to the config file on disk. Keys use dot-notation and the value is written verbatim. If the config file does not exist yet, it is created with defaults before the value is written.
ajat config set KEY VALUEExamples
# Jira Cloud credentials
ajat config set jira.domain acme.atlassian.net
ajat config set jira.username you@acme.com
ajat config set jira.api_token YOUR_API_TOKEN
# Logging
ajat config set log.level debug
ajat config set log.format json
ajat config set log.file /var/log/ajat.log
# HTTP
ajat config set http.client.max_retries 5
ajat config set http.client.proxy "http://proxy.corp.example.com:8080"AJAT_ environment variables and command-line flags still override whatever you
save here.
Available config keys
| Key | Description |
|---|---|
jira.domain | Bare Jira Cloud hostname |
jira.username | Atlassian account email |
jira.api_token | Jira API token (masked in output) |
jira.type | Jira deployment type (defaults to cloud) |
http.client.max_retries | Number of HTTP retry attempts |
http.client.base_timeout | Base request timeout (e.g. 1s) |
http.client.max_timeout | Max request timeout (e.g. 30s) |
http.client.proxy | HTTP/HTTPS proxy URL |
log.level | Log level: debug, info, warn, error |
log.format | Log format: text, json |
log.file | Log output: stdout, stderr, or a file path |
debug.enabled | Enable debug mode (true / false) |
debug.dir | Directory for debug artefacts |
config validate
Checks the effective configuration for problems without contacting Jira or
making any network call. It exits 0 when the configuration is valid and
non-zero with an actionable message when it is not, which makes it a useful gate
in setup scripts and CI pipelines.
ajat config validateAdd --require-credentials to also confirm that jira.domain,
jira.username, and jira.api_token are set — the same check the export and
report commands run before they connect to Jira.
ajat config validate --require-credentialsRecommended workflow
- run
ajat config create - set the Jira connection values with
config set - confirm them with
config getorconfig list - run
ajat config validate --require-credentials - run
ajat doctor
See Configuration for the full precedence model,
the AJAT_ environment variable table, and proxy setup, and
Utilities for doctor and the rest of the diagnostic
commands.