Skip to content
atlcli

Fields

Fields

Section titled “Fields”

Work with Jira custom and system fields.

Prerequisites

Section titled “Prerequisites”
  • Authenticated profile (atlcli auth login)
  • Jira permission: Browse Projects

List Fields

Section titled “List Fields”
Terminal window
atlcli jira field list

Options:

FlagDescription
--customShow only custom fields
--systemShow only system fields
--typeFilter by field type

Output:

ID                    NAME                TYPE        CUSTOM
summary               Summary             string      No
priority              Priority            priority    No
customfield_10001     Story Points        number      Yes
customfield_10002     Sprint              array       Yes
customfield_10003     Epic Link           any         Yes

Search Fields

Section titled “Search Fields”

Search for fields by name:

Terminal window
atlcli jira field search "story"

Output:

ID                    NAME                TYPE
customfield_10001     Story Points        number
customfield_10016     Story point est.    number

This is useful for finding the field ID for custom fields like story points.

Get Field

Section titled “Get Field”

Get details about a specific field:

Terminal window
atlcli jira field get --id customfield_10001

Output:

Field: Story Points
ID:    customfield_10001
Type:  number
Custom: Yes
Schema: { "type": "number", "custom": "com.atlassian.jira.plugin.system.customfieldtypes:float" }

Field Options

Section titled “Field Options”

For select, multi-select, and cascading select fields, list available options:

Terminal window
atlcli jira field options --id customfield_10001

Output:

ID       VALUE
10001    Option A
10002    Option B
10003    Option C

Using Fields in Issues

Section titled “Using Fields in Issues”

Set Custom Fields

Section titled “Set Custom Fields”

Use the --field <id>=<value> flag on issue create and issue update. The flag is repeatable for multiple fields:

Terminal window
# Create with custom field
atlcli jira issue create --project PROJ --type Story --summary "Feature" \
  --field customfield_10001=5


# Update custom field
atlcli jira issue update --key PROJ-123 --field customfield_10001=8


# Set multiple fields at once
atlcli jira issue update --key PROJ-123 \
  --field customfield_10001=8 \
  --field customfield_10002='{"value":"Backend"}'

See Issues → Custom Fields for full type coercion rules and examples.

Query by Custom Fields

Section titled “Query by Custom Fields”

Use JQL to search by custom field values:

Terminal window
# By field ID
atlcli jira search --jql "cf[10001] > 3"


# By field name (if unique)
atlcli jira search --jql "'Story Points' > 3"

Common Custom Fields

Section titled “Common Custom Fields”
FieldTypical IDJQL
Story Pointscustomfield_10016cf[10016] > 0
Epic Linkcustomfield_10014'Epic Link' = PROJ-100
Sprintcustomfield_10020Sprint in openSprints()
Teamcustomfield_10017Team = 'Backend'

JSON Output

Section titled “JSON Output”
Terminal window
atlcli jira field list --json
{
  "schemaVersion": "1",
  "fields": [
    {
      "id": "customfield_10001",
      "name": "Story Points",
      "type": "number",
      "custom": true,
      "schema": {
        "type": "number",
        "custom": "com.atlassian.jira.plugin.system.customfieldtypes:float"
      }
    }
  ]
}
Section titled “Related Topics”
Jira and Confluence are trademarks of Atlassian Corporation Plc. atlcli is not affiliated with, endorsed by, or sponsored by Atlassian.