Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Last updated Mar 27, 2026

Output Format

All commands return a consistent JSON envelope:

1
2
{
  "command": "jira issues search",
  "request": { "site": "myco", "jql": "..." },
  "data": {
    "edges": [
      {
        "node": {
          "key": "PROJ-123",
          "summary": "Fix login bug",
          "status": { "name": "In Progress" },
          "webUrl": "https://myco.atlassian.net/browse/PROJ-123"
        }
      }
    ]
  }
}

Reading Results

  • Lists: Access items via data.edges[].node
  • Single items: Access directly via data
  • Fields are flat: Use .summary, .status.name, .webUrl — not .fields.summary

JSON Processing

1
2
# Pipe to jq for processing
twg jira issues search --jql "project = PROJ" -o json | \
  jq '.data.edges[].node | {key, summary, status: .status.name}'

# Save to file for large results
twg work query --scope me --since 30d --output-file /tmp/work.json

Agent Mode

When called by agents, append --mode agent to produce quieter output with stripped hints and warnings from envelopes:

1
2
twg work query --scope me --since 7d --mode agent

Rate this page: