Add --json support to `gh agent-task view` by maxbeizer · Pull Request #12807 · cli/cli

maxbeizer · 2026-02-28T15:22:45Z

Summary

Add --json, --jq, and --template flags to gh agent-task view, consistent with the pattern used by gh pr view --json, gh issue view --json, etc.

When --json is provided, the view command outputs structured JSON instead of human-readable formatted output. This uses the same ExportData interface and SessionFields as the companion list PR.

Available fields

id, name, state, repository, user, createdAt, updatedAt, completedAt, pullRequestNumber, pullRequestUrl, pullRequestTitle, pullRequestState

Example usage

# Get session details as JSON
gh agent-task view <session-id> --json id,name,state,pullRequestUrl

# Filter with jq
gh agent-task view <session-id> --json state --jq '.state'

# Use a Go template
gh agent-task view <session-id> --json name,state --template '{{.name}}: {{.state}}'

Companion to #12806 — together they address the --json portion of #12805.

Add --json, --jq, and --template flags to `gh agent-task view`, consistent with the pattern used by `gh pr view --json`, `gh issue view --json`, etc. This reuses the same ExportData interface and SessionFields defined for list, applying them to the single-session view output. Closes cli#12805 (partial) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

- Rename 'status' field to 'state' for consistency with struct and UI - Add missing JSON fields: completedAt, user, pullRequestTitle, pullRequestState - Add test for nil PullRequest with --json - Expand existing JSON test to cover new fields Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Adds structured output support to gh agent-task view by wiring the standard --json/--jq/--template flags into the command and making capi.Session exportable via the existing JSON exporter mechanism.

Changes:

Add --json, --jq, and --template flags to gh agent-task view and route output through cmdutil.Exporter when enabled.
Define capi.SessionFields and implement (*capi.Session).ExportData to provide a stable JSON schema for sessions.
Add tests covering JSON export output for a populated session and a session with a nil pull request.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
pkg/cmd/agent-task/view/view.go	Adds exporter plumbing + JSON flags to the `view` command and emits JSON when enabled.
pkg/cmd/agent-task/capi/sessions.go	Introduces `SessionFields` and `ExportData` implementation for JSON export of sessions.
pkg/cmd/agent-task/view/view_test.go	Adds unit tests validating JSON output behavior from `viewRun`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-01T15:21:23Z

@@ -289,6 +292,10 @@ func viewRun(opts *ViewOptions) error {
 		return printLogs(opts, capiClient, session.ID)
 	}

+	if opts.Exporter != nil {
+		return opts.Exporter.Write(opts.IO, session)
+	}


--json can currently be combined with --log/--follow, but in that case the command will print logs (non-JSON) because the opts.Log branch runs before the exporter. This makes --json effectively ignored for that flag combination and is inconsistent with other commands where JSON output takes precedence. Consider either (1) erroring when --json is used with --log/--follow, or (2) prioritizing opts.Exporter output over the log path (and documenting/handling what happens to --log).

See below for a potential fix:

if opts.Exporter != nil { return opts.Exporter.Write(opts.IO, session) } if opts.Log { return printLogs(opts, capiClient, session.ID) }

@maxbeizer I think we should do this one. I think it makes sense to guard here to communicate how we intend this flag to be used - wdyt?

I think it should be a cmdutil.MutuallyExclusive call though. I think that's simpler than what Copilot suggests.

yeah I think that's a good call. I'll fire it up

actually maybe I already did that in https://github.com/cli/cli/pull/12807/changes#diff-5760262b356b8dfb67879a14750425ac861491f46fe9f4112c6f7dd17a3317e7 🤔 yesterday was kind a blur

ah yeah I missed that too. I think we're good then 🙌

- Prioritize --json output over --log/--follow so JSON is not silently ignored - Emit null for zero createdAt/updatedAt values, consistent with completedAt Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Consistent with completedAt handling. Addresses Copilot review feedback from companion PR cli#12807. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

BagToad

LGTM - thanks for doing this.

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.87.3` → `v2.88.1` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>cli/cli (cli/cli)</summary> ### [`v2.88.1`](https://github.com/cli/cli/releases/tag/v2.88.1): GitHub CLI 2.88.1 [Compare Source](cli/cli@v2.88.0...v2.88.1) #### Fix `pr` commands failing with `read:project` scope error v2.88.0 introduced a regression where `pr` commands would fail with the error: ``` error: your authentication token is missing required scopes [read:project] To request it, run: gh auth refresh -s read:project ``` Previously, missing read:project scope was gracefully handled, and project data was silently skipped. A change inadvertently broke the error matching that enabled this graceful degradation. v2.88.1 reverts these changes so that `pr` commands work correctly without requiring the `read:project` scope. #### What's Changed - Migrate Windows code signing from client secret to OIDC by [@BagToad](https://github.com/BagToad) in [#12911](cli/cli#12911) - Revert "refactor: deduplicate scope error handling between api/client.go and project queries" by [@williammartin](https://github.com/williammartin) in [#12914](cli/cli#12914) - Revert "fix: clarify scope error while creating issues for projects" by [@williammartin](https://github.com/williammartin) in [#12915](cli/cli#12915) **Full Changelog**: <cli/cli@v2.88.0...v2.88.1> ### [`v2.88.0`](https://github.com/cli/cli/releases/tag/v2.88.0): GitHub CLI 2.88.0 [Compare Source](cli/cli@v2.87.3...v2.88.0) ####

Request Copilot Code Review from `gh` <img width="80%" height="80%" alt="image" src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fcli%2Fcli%2Fpull%2F%3Ca+href%3D"https://github.com/user-attachments/assets/c9b86700-5934-44b6-9210-227495a18d8e">https://github.com/user-attachments/assets/c9b86700-5934-44b6-9210-227495a18d8e" /> `gh pr create` and `gh pr edit` now support [Copilot Code Review](https://docs.github.com/en/copilot/using-github-copilot/code-review/using-copilot-code-review) as a reviewer. Request a review with `--add-reviewer @copilot`, or select Copilot interactively from the searchable reviewer prompt. Create a pull request and request review from Copilot: ``` gh pr create --reviewer @copilot ``` Edit a pull request and request review from Copilot: ``` gh pr edit --add-reviewer @copilot ``` #### Close issues as duplicates with `gh issue close --duplicate-of` You can now close issues as duplicates and link to a duplicate issue directly from the CLI. The new `--duplicate-of` flag accepts an issue number or URL and marks the closed issue as a duplicate of the referenced one. You can also use `--reason duplicate` to set the close reason without linking a specific issue. ``` # Close as duplicate, linking to the original issue gh issue close 123 --duplicate-of 456 # Close with duplicate reason only gh issue close 123 --reason duplicate ``` #### JSON support for `gh agent-task` `gh agent-task list` and `gh agent-task view` now support `--json`, `--jq`, and `--template` flags, consistent with other `gh` commands. ``` gh agent-task list --json id,name,state gh agent-task view <id> --json state --jq '.state' ``` #### What's Changed ##### ✨ Features - `gh pr create`: login-based reviewer requests and search-based interactive selection by [@BagToad](https://github.com/BagToad) in [#12627](cli/cli#12627) - `gh pr view` and `gh issue view`: show friendly display names for all actors by [@BagToad](https://github.com/BagToad) in [#12854](cli/cli#12854) - `gh issue close`: add `--duplicate-of` flag and duplicate reason by [@tksohishi](https://github.com/tksohishi) in [#12811](cli/cli#12811) - `gh pr diff`: add `--exclude` flag to filter files from diff output by [@yuvrajangadsingh](https://github.com/yuvrajangadsingh) in [#12655](cli/cli#12655) - `gh pr view/list`: add `changeType` field to files JSON output by [@yuvrajangadsingh](https://github.com/yuvrajangadsingh) in [#12657](cli/cli#12657) - `gh repo clone`: add `--no-upstream` flag by [@4RH1T3CT0R7](https://github.com/4RH1T3CT0R7) in [#12686](cli/cli#12686) - `gh repo edit`: add `--squash-merge-commit-message` flag by [@yuvrajangadsingh](https://github.com/yuvrajangadsingh) in [#12846](cli/cli#12846) - `gh browse`: add `--blame` flag by [@masonmcelvain](https://github.com/masonmcelvain) in [#11486](cli/cli#11486) - `gh agent-task list`: add `--json` support by [@maxbeizer](https://github.com/maxbeizer) in [#12806](cli/cli#12806) - `gh agent-task view`: add `--json` support by [@maxbeizer](https://github.com/maxbeizer) in [#12807](cli/cli#12807) - `gh copilot`: set `COPILOT_GH` env var when launching Copilot CLI by [@devm33](https://github.com/devm33) in [#12821](cli/cli#12821) ##### 🐛 Fixes - Fix `gh project item-edit` error when editing Draft Issue with only one (`--title`/`--body`) flag by [@ManManavadaria](https://github.com/ManManavadaria) in [#12787](cli/cli#12787) - Fix extension install error message showing raw struct instead of `owner/repo` by [@Copilot](https://github.com/Copilot) in [#12836](cli/cli#12836) - Fix incorrect integer conversion from int to uint16 in port forwarder by [@BagToad](https://github.com/BagToad) in [#12831](cli/cli#12831) - Fix invalid ANSI SGR escape code in JSON and diff colorization by [@BagToad](https://github.com/BagToad) in [#12720](cli/cli#12720) - Fix assignees `databaseId` always being `0` in `--json` output by [@srt32](https://github.com/srt32) in [#12783](cli/cli#12783) - Fix error when `--remote` flag used with repo argument by [@majiayu000](https://github.com/majiayu000) in [#12375](cli/cli#12375) - Fix redundant API call in `gh issue view --comments` by [@VishnuVV27](https://github.com/VishnuVV27) in [#12652](cli/cli#12652) - Clarify scope error while creating issues for projects by [@elijahthis](https://github.com/elijahthis) in [#12596](cli/cli#12596) - Reject pull request-only search qualifiers in `gh issue list` by [@LouisLau-art](https://github.com/LouisLau-art) in [#12623](cli/cli#12623) - Prevent `.git/config` corruption on repeated `issue develop --name` invocation by [@gunadhya](https://github.com/gunadhya) in [#12651](cli/cli#12651) - Use pre-compiled regexp for matching Content-Type by [@itchyny](https://github.com/itchyny) in [#12781](cli/cli#12781) - Isolate generated licenses per platform (os/arch) by [@babakks](https://github.com/babakks) in [#12774](cli/cli#12774) ##### 📚 Docs & Chores - Add examples to `gh issue close` help text by [@BagToad](https://github.com/BagToad) in [#12830](cli/cli#12830) - Customizable install `prefix` in Makefile by [@scarf005](https://github.com/scarf005) in [#11714](cli/cli#11714) - Deduplicate scope error handling between `api/client.go` and project queries by [@yuvrajangadsingh](https://github.com/yuvrajangadsingh) in [#12845](cli/cli#12845) - Remove unnecessary `StateReason` and `StateReasonDuplicate` feature detection by [@BagToad](https://github.com/BagToad) in [#12838](cli/cli#12838) - Update Go version requirement to 1.26+ by [@BagToad](https://github.com/BagToad) in [#12864](cli/cli#12864) - Add monthly pitch surfacing workflow by [@tidy-dev](https://github.com/tidy-dev) in [#12894](cli/cli#12894) #####

Dependencies - Bump Go from 1.25.7 to 1.26.1 by [@BagToad](https://github.com/BagToad) in [#12860](cli/cli#12860) - chore(deps): bump golang.org/x/sync from 0.19.0 to 0.20.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#12886](cli/cli#12886) - chore(deps): bump google.golang.org/grpc from 1.79.1 to 1.79.2 by [@dependabot](https://github.com/dependabot)\[bot] in [#12851](cli/cli#12851) - chore(deps): bump github.com/docker/cli from 29.0.3+incompatible to 29.2.0+incompatible by [@dependabot](https://github.com/dependabot)\[bot] in [#12842](cli/cli#12842) - chore(deps): bump google.golang.org/grpc from 1.78.0 to 1.79.1 by [@dependabot](https://github.com/dependabot)\[bot] in [#12759](cli/cli#12759) - chore(deps): bump goreleaser/goreleaser-action from 6.4.0 to 7.0.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#12760](cli/cli#12760) - chore(deps): bump actions/upload-artifact from 6 to 7 by [@dependabot](https://github.com/dependabot)\[bot] in [#12797](cli/cli#12797) - chore(deps): bump actions/download-artifact from 7 to 8 by [@dependabot](https://github.com/dependabot)\[bot] in [#12796](cli/cli#12796) - chore(deps): bump actions/attest-build-provenance from 3.2.0 to 4.1.0 by [@dependabot](https://github.com/dependabot)\[bot] in [#12795](cli/cli#12795) - chore(deps): bump github.com/gabriel-vasile/mimetype from 1.4.11 to 1.4.13 by [@dependabot](https://github.com/dependabot)\[bot] in [#12615](cli/cli#12615) #### New Contributors - [@srt32](https://github.com/srt32) made their first contribution in [#12783](cli/cli#12783) - [@itchyny](https://github.com/itchyny) made their first contribution in [#12781](cli/cli#12781) - [@VishnuVV27](https://github.com/VishnuVV27) made their first contribution in [#12652](cli/cli#12652) - [@elijahthis](https://github.com/elijahthis) made their first contribution in [#12596](cli/cli#12596) - [@ManManavadaria](https://github.com/ManManavadaria) made their first contribution in [#12787](cli/cli#12787) - [@maxbeizer](https://github.com/maxbeizer) made their first contribution in [#12806](cli/cli#12806) - [@LouisLau-art](https://github.com/LouisLau-art) made their first contribution in [#12623](cli/cli#12623) - [@4RH1T3CT0R7](https://github.com/4RH1T3CT0R7) made their first contribution in [#12686](cli/cli#12686) - [@yuvrajangadsingh](https://github.com/yuvrajangadsingh) made their first contribution in [#12657](cli/cli#12657) - [@masonmcelvain](https://github.com/masonmcelvain) made their first contribution in [#11486](cli/cli#11486) - [@scarf005](https://github.com/scarf005) made their first contribution in [#11714](cli/cli#11714) - [@tksohishi](https://github.com/tksohishi) made their first contribution in [#12811](cli/cli#12811) - [@tidy-dev](https://github.com/tidy-dev) made their first contribution in [#12894](cli/cli#12894) **Full Changelog**: <cli/cli@v2.87.3...v2.88.0> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

github-actions bot added external pull request originating outside of the CLI core team needs-triage needs to be reviewed labels Feb 28, 2026

maxbeizer and others added 2 commits March 1, 2026 08:57

Fix gofmt alignment in view_test.go

250d5a8

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

maxbeizer mentioned this pull request Mar 1, 2026

Add --json support to gh agent-task list #12806

Merged

maxbeizer marked this pull request as ready for review March 1, 2026 15:17

maxbeizer requested a review from a team as a code owner March 1, 2026 15:17

maxbeizer requested review from babakks and Copilot March 1, 2026 15:17

Copilot started reviewing on behalf of maxbeizer March 1, 2026 15:18 View session

Copilot AI reviewed Mar 1, 2026

View reviewed changes

Address Copilot review feedback

0d05a8a

- Prioritize --json output over --log/--follow so JSON is not silently ignored - Emit null for zero createdAt/updatedAt values, consistent with completedAt Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

maxbeizer mentioned this pull request Mar 2, 2026

Feature request: --json support and finer-grained status for gh agent-task #12805

Closed

BagToad approved these changes Mar 2, 2026

View reviewed changes

BagToad merged commit ad41bb9 into cli:trunk Mar 2, 2026
11 checks passed

cameronfleet-paxos mentioned this pull request Mar 16, 2026

gh agent-task view --log: add --json support for structured agent logs #12947

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add --json support to `gh agent-task view`#12807

Add --json support to `gh agent-task view`#12807
BagToad merged 4 commits intocli:trunkfrom
maxbeizer:agent-task-view-json

maxbeizer commented Feb 28, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 1, 2026

Uh oh!

BagToad Mar 2, 2026

Uh oh!

BagToad Mar 2, 2026

Uh oh!

maxbeizer Mar 2, 2026

Uh oh!

maxbeizer Mar 2, 2026

Uh oh!

BagToad Mar 2, 2026

Uh oh!

Uh oh!

BagToad left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

maxbeizer commented Feb 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Available fields

Example usage

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

BagToad Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

BagToad Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

maxbeizer Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

maxbeizer Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

BagToad Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BagToad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

maxbeizer commented Feb 28, 2026 •

edited

Loading