Skip to Content
Atlassian Jiraajatv1.0.xConfig Commands

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 create

If 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 --force

config where

Prints the absolute path to the active config file. The command prints the path whether or not the file exists.

ajat config where

Example output:

/Users/alice/Library/Application Support/ajat/config.yaml

Flags

FlagDescription
--existsExit non-zero if the configuration file does not exist on disk
--shell-escapeQuote 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 list

Use 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: info

The 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 KEY

Examples

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 get

The 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 VALUE

Examples

# 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

KeyDescription
jira.domainBare Jira Cloud hostname
jira.usernameAtlassian account email
jira.api_tokenJira API token (masked in output)
jira.typeJira deployment type (defaults to cloud)
http.client.max_retriesNumber of HTTP retry attempts
http.client.base_timeoutBase request timeout (e.g. 1s)
http.client.max_timeoutMax request timeout (e.g. 30s)
http.client.proxyHTTP/HTTPS proxy URL
log.levelLog level: debug, info, warn, error
log.formatLog format: text, json
log.fileLog output: stdout, stderr, or a file path
debug.enabledEnable debug mode (true / false)
debug.dirDirectory 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 validate

Add --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-credentials

  1. run ajat config create
  2. set the Jira connection values with config set
  3. confirm them with config get or config list
  4. run ajat config validate --require-credentials
  5. 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.

Last updated on