feat(pr create): add --json and --jq output by LouisLau-art · Pull Request #12622 · cli/cli

LouisLau-art · 2026-02-06T02:28:44Z

Fixes #11247.

Summary

Add --json and --jq support to gh pr create via a new cmdutil.AddJSONAndJQFlags helper (no JSON --template flag).
Make JSON flag validation aware of commands that do not use JSON templating.
Keep gh pr create --template <file> independent from JSON output mode.
Reject --dry-run together with --json for gh pr create.
Include number in the CreatePullRequest mutation response so --json number works.

Test

go test ./pkg/cmdutil ./pkg/cmd/pr/create ./api

LouisLau-art · 2026-03-03T08:46:01Z

Rebased this branch onto the latest trunk and force-pushed a clean branch with just the feature commit.

This should address the stale govulncheck/old-base CI issue caused by the previous 121-commit drift from trunk.

Local verification run:

go test ./pkg/cmd/pr/create ./pkg/cmdutil ./api
all passed

babakks

Thanks for the PR, @LouisLau-art, and sorry for the late review! 🙏

I haven't yet tried it to create a real PR, but the PR looks very good so that I'm mostly confident the changes are in the right direction. It just needs a few changes.

Once you update the branch, I'll go over the changes again and do proper end-to-end tests.

babakks · 2026-03-04T14:56:02Z

+				createPullRequest(input: $input) {
+					pullRequest {
+						id
+						number
+						url
+					}


Please remote the extra tab:

Suggested change

createPullRequest(input: $input) {

pullRequest {

id

number

url

}

createPullRequest(input: $input) {

pullRequest {

id

number

url

}

babakks · 2026-03-04T15:02:59Z

+				opts.Body = "my body"
+				opts.HeadBranch = "feature"
+				exporter := cmdutil.NewJSONExporter()
+				exporter.SetFields([]string{"id", "url", "number"})


Instead of the inline slice, it's better to use the createOutputFields variable in here, to make sure we're covering all fields here.

Suggested change

exporter.SetFields([]string{"id", "url", "number"})

exporter.SetFields(createOutputFields)

babakks · 2026-03-04T15:07:10Z

+	Exporter cmdutil.Exporter
 }

+var createOutputFields = []string{"id", "url", "number"}


We need a test for this, similar to:

cli/pkg/cmd/pr/view/view_test.go

Lines 29 to 79 in 42ed61f

func TestJSONFields(t *testing.T) {

jsonfieldstest.ExpectCommandToSupportJSONFields(t, NewCmdView, []string{

"additions",

"assignees",

"author",

"autoMergeRequest",

"baseRefName",

"baseRefOid",

"body",

"changedFiles",

"closed",

"closedAt",

"closingIssuesReferences",

"comments",

"commits",

"createdAt",

"deletions",

"files",

"fullDatabaseId",

"headRefName",

"headRefOid",

"headRepository",

"headRepositoryOwner",

"id",

"isCrossRepository",

"isDraft",

"labels",

"latestReviews",

"maintainerCanModify",

"mergeCommit",

"mergeStateStatus",

"mergeable",

"mergedAt",

"mergedBy",

"milestone",

"number",

"potentialMergeCommit",

"projectCards",

"projectItems",

"reactionGroups",

"reviewDecision",

"reviewRequests",

"reviews",

"state",

"statusCheckRollup",

"title",

"updatedAt",

"url",

})

}

babakks · 2026-03-04T15:22:47Z

-						{ "data": { "createPullRequest": { "pullRequest": {
-							"URL": "https://github.com/OWNER/REPO/pull/12"
-						} } } }`,
+							{ "data": { "createPullRequest": { "pullRequest": {
+								"ID": "PR_kwDOA",
+								"Number": 12,
+								"URL": "https://github.com/OWNER/REPO/pull/12"
+							} } } }`,


We need to also update all other test cases (lots of them, not just in this test function), to include the newly added number field. The correct notation should be number, but since we've used Pascal casing for ID and URL (I don't know why 🤷), I recommended keeping it (i.e. adding Number instead of number).

babakks · 2026-03-04T15:26:25Z

+	setupJsonFlags(cmd, exportTarget, fields, true)
+}
+
+func AddJSONAndJQFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string) {


We need a godoc above this to avoid future confusion/questions:

Suggested change

func AddJSONAndJQFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string) {

// AddJSONAndJQFlags adds --json and --jq flags, but not --template. Shorthands are also omitted.

//

// Meant to be used in cases where --template (or -t) is already taken.

func AddJSONAndJQFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string) {

babakks · 2026-03-04T15:33:13Z

+	var tplFlag *pflag.Flag
+	if withTemplateFlag {
+		tplFlag = f.Lookup("template")
+	}
+
+	templateValue := ""
+	if tplFlag != nil {
+		templateValue = tplFlag.Value.String()
+	}
+


Let's simplify this:

Suggested change

var tplFlag *pflag.Flag

if withTemplateFlag {

tplFlag = f.Lookup("template")

}

templateValue := ""

if tplFlag != nil {

templateValue = tplFlag.Value.String()

}

var tplFlag *pflag.Flag

var templateValue string

if withTemplateFlag {

tplFlag = f.Lookup("template")

templateValue = tplFlag.Value.String()

}

babakks · 2026-03-04T15:37:16Z

+		name        string
+		fields      []string
+		args        []string
+		withTplFlag bool


Maybe name this field templateFlagTaken with a short comment on the intent:

Suggested change

withTplFlag bool

// templateFlagTaken indicates that the host command already has a --template flag for a different purpose (e.g. pr create).

templateFlagTaken bool

babakks · 2026-05-13T12:19:00Z

I'm closing this PR in favour of #13348 as seems to be stale now.

LouisLau-art requested a review from a team as a code owner February 6, 2026 02:28

LouisLau-art requested a review from babakks February 6, 2026 02:28

LouisLau-art temporarily deployed to cli-automation February 6, 2026 02:28 — with GitHub Actions Inactive

cliAutomation added the external pull request originating outside of the CLI core team label Feb 6, 2026

babakks mentioned this pull request Feb 10, 2026

Add --json and --jq to gh pr create #11247

Open

yuvrajangadsingh mentioned this pull request Feb 20, 2026

feat(pr create): add --json and --jq flags for structured output #12728

Closed

feat(pr create): add --json and --jq output

42ed61f

LouisLau-art force-pushed the feat/pr-create-json-output branch from 509440e to 42ed61f Compare March 3, 2026 08:45

babakks requested changes Mar 4, 2026

View reviewed changes

coderabbitai Bot mentioned this pull request May 2, 2026

docs(workflow): design and build a new PRD and task planning workflow NTCoding/living-architecture#370

Merged

SebTardif mentioned this pull request May 4, 2026

Add --json and --jq flags to gh pr create #13348

Open

coderabbitai Bot mentioned this pull request May 12, 2026

[codex] Add address review command and workflow shakacode/control-plane-flow#286

Merged

babakks closed this May 13, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(pr create): add --json and --jq output#12622

feat(pr create): add --json and --jq output#12622
LouisLau-art wants to merge 1 commit into
cli:trunkfrom
LouisLau-art:feat/pr-create-json-output

LouisLau-art commented Feb 6, 2026

Uh oh!

LouisLau-art commented Mar 3, 2026

Uh oh!

babakks left a comment

Uh oh!

babakks Mar 4, 2026

Uh oh!

babakks Mar 4, 2026

Uh oh!

babakks Mar 4, 2026

Uh oh!

babakks Mar 4, 2026

Uh oh!

babakks Mar 4, 2026

Uh oh!

babakks Mar 4, 2026

Uh oh!

babakks Mar 4, 2026

Uh oh!

babakks commented May 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	exporter.SetFields([]string{"id", "url", "number"})
	exporter.SetFields(createOutputFields)

	func TestJSONFields(t *testing.T) {
	jsonfieldstest.ExpectCommandToSupportJSONFields(t, NewCmdView, []string{
	"additions",
	"assignees",
	"author",
	"autoMergeRequest",
	"baseRefName",
	"baseRefOid",
	"body",
	"changedFiles",
	"closed",
	"closedAt",
	"closingIssuesReferences",
	"comments",
	"commits",
	"createdAt",
	"deletions",
	"files",
	"fullDatabaseId",
	"headRefName",
	"headRefOid",
	"headRepository",
	"headRepositoryOwner",
	"id",
	"isCrossRepository",
	"isDraft",
	"labels",
	"latestReviews",
	"maintainerCanModify",
	"mergeCommit",
	"mergeStateStatus",
	"mergeable",
	"mergedAt",
	"mergedBy",
	"milestone",
	"number",
	"potentialMergeCommit",
	"projectCards",
	"projectItems",
	"reactionGroups",
	"reviewDecision",
	"reviewRequests",
	"reviews",
	"state",
	"statusCheckRollup",
	"title",
	"updatedAt",
	"url",
	})
	}

	withTplFlag bool
	// templateFlagTaken indicates that the host command already has a --template flag for a different purpose (e.g. pr create).
	templateFlagTaken bool

Conversation

LouisLau-art commented Feb 6, 2026

Summary

Test

Uh oh!

LouisLau-art commented Mar 3, 2026

Uh oh!

babakks left a comment

Choose a reason for hiding this comment

Uh oh!

babakks Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

babakks Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

babakks Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

babakks Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

babakks Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

babakks Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

babakks Mar 4, 2026

Choose a reason for hiding this comment

Uh oh!

babakks commented May 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants