natsu0529 · Jul 6, 2026 · Jul 10, 2026 · Jul 10, 2026 · Jul 13, 2026
@@ -0,0 +1,36 @@
+# Use gh as a credential helper
+exec gh auth setup-git
+
+# Create a repository with a file so it has a default branch
+exec gh repo create $ORG/$SCRIPT_NAME-$RANDOM_STRING --add-readme --private
+
+# Defer repo cleanup
+defer gh repo delete --yes $ORG/$SCRIPT_NAME-$RANDOM_STRING
+
+# Clone the repo
+exec gh repo clone $ORG/$SCRIPT_NAME-$RANDOM_STRING
+
+# Prepare a branch to PR
+cd $SCRIPT_NAME-$RANDOM_STRING
+exec git checkout -b feature-branch
+exec git commit --allow-empty -m 'Empty Commit'
+exec git push -u origin feature-branch
+
+# Create the PR, exporting the created PR as JSON
+exec gh pr create --title 'Feature Title' --body 'Feature Body' --json id,number,url
+stdout '"id":'
+stdout '"number":1'
+stdout '"url":'
+
+# Check the PR is indeed created
+exec gh pr view
+stdout 'Feature Title'
+
+# Prepare another branch to PR
+exec git checkout -b feature-branch-2
+exec git commit --allow-empty -m 'Empty Commit'
+exec git push -u origin feature-branch-2
+
+# Create the PR, extracting the PR number with a jq expression
+exec gh pr create --title 'Feature Title 2' --body 'Feature Body 2' --json number --jq .number
+stdout '^2$'
@@ -468,10 +468,11 @@ func CreatePullRequest(client *Client, repo *Repository, params map[string]inter
 			createPullRequest(input: $input) {
 				pullRequest {
 					id
+					number
 					url
 				}
 			}
-	}`
+		}`
 
 	inputParams := map[string]interface{}{
 		"repositoryId": repo.ID,

@@ -73,9 +73,14 @@ type CreateOptions struct {
 	MaintainerCanModify bool
 	Template            string
 
-	DryRun bool
+	DryRun   bool
+	Exporter cmdutil.Exporter
 }
 
+// createOutputFields are the fields that can be exported with `--json` after
+// creating a pull request.
+var createOutputFields = []string{"id", "number", "url"}
+
 // creationRefs is an interface that provides the necessary information for creating a pull request in the API.
 // Upcasting to concrete implementations can provide further context on other operations (forking and pushing).
 type creationRefs interface {
@@ -331,6 +336,10 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
 				return cmdutil.FlagErrorf("`--dry-run` is not supported when using `--web`")
 			}
 
+			if opts.DryRun && opts.Exporter != nil {
+				return cmdutil.FlagErrorf("`--dry-run` is not supported when using `--json`")
+			}
+
 			if runF != nil {
 				return runF(opts)
 			}
@@ -360,6 +369,11 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
 	fl.StringVarP(&opts.Template, "template", "T", "", "Template `file` to use as starting body text")
 	fl.BoolVar(&opts.DryRun, "dry-run", false, "Print details instead of creating the PR. May still push git changes.")
 
+	// `pr create` already uses `--template` (and `-T`) for PR templates, so only
+	// the `--json` and `--jq` flags are added here, without the `--template`
+	// output formatting flag.
+	cmdutil.AddJSONAndJQFlags(cmd, &opts.Exporter, createOutputFields)
+
 	_ = cmdutil.RegisterBranchCompletionFlags(f.GitClient, cmd, "base", "head")
 
 	_ = cmd.RegisterFlagCompletionFunc("reviewer", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
@@ -1065,7 +1079,7 @@ func submitPR(opts CreateOptions, ctx CreateContext, state shared.IssueMetadataS
 	opts.IO.StartProgressIndicator()
 	pr, err := api.CreatePullRequest(client, ctx.PRRefs.BaseRepo(), params)
 	opts.IO.StopProgressIndicator()
-	if pr != nil {
+	if pr != nil && opts.Exporter == nil {
 		fmt.Fprintln(opts.IO.Out, pr.URL)
 	}
 	if err != nil {
@@ -1074,6 +1088,9 @@ func submitPR(opts CreateOptions, ctx CreateContext, state shared.IssueMetadataS
 		}
 		return fmt.Errorf("pull request create failed: %w", err)
 	}
+	if opts.Exporter != nil {
+		return opts.Exporter.Write(opts.IO, pr)
+	}
 	return nil
 }
 

@@ -24,12 +24,21 @@ import (
 	"github.com/cli/cli/v2/pkg/cmdutil"
 	"github.com/cli/cli/v2/pkg/httpmock"
 	"github.com/cli/cli/v2/pkg/iostreams"
+	"github.com/cli/cli/v2/pkg/jsonfieldstest"
 	"github.com/cli/cli/v2/test"
 	"github.com/google/shlex"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
+func TestJSONFields(t *testing.T) {
+	jsonfieldstest.ExpectCommandToSupportJSONFields(t, NewCmdCreate, []string{
+		"id",
+		"number",
+		"url",
+	})
+}
+
 func TestNewCmdCreate(t *testing.T) {
 	tmpFile := filepath.Join(t.TempDir(), "my-body.md")
 	err := os.WriteFile(tmpFile, []byte("a body from file"), 0600)
@@ -203,6 +212,44 @@ func TestNewCmdCreate(t *testing.T) {
 			cli:      "--web --dry-run",
 			wantsErr: true,
 		},
+		{
+			name:     "dry-run and json",
+			tty:      false,
+			cli:      "--title mytitle --body '' --dry-run --json number",
+			wantsErr: true,
+		},
+		{
+			name:     "web and json",
+			tty:      false,
+			cli:      "--title mytitle --body '' --web --json number",
+			wantsErr: true,
+		},
+		{
+			name:     "jq without json",
+			tty:      false,
+			cli:      "--title mytitle --body '' --jq .number",
+			wantsErr: true,
+		},
+		{
+			name:     "unknown json field",
+			tty:      false,
+			cli:      "--title mytitle --body '' --json headRefName",
+			wantsErr: true,
+		},
+		{
+			name:     "json with pr template",
+			tty:      true,
+			cli:      "--template bug_fix.md --json number",
+			wantsErr: false,
+			wantsOpts: CreateOptions{
+				Title:               "",
+				TitleProvided:       false,
+				Body:                "",
+				BodyProvided:        false,
+				MaintainerCanModify: true,
+				Template:            "bug_fix.md",
+			},
+		},
 		{
 			name:     "editor by cli",
 			tty:      true,
@@ -384,6 +431,116 @@ func Test_createRun(t *testing.T) {
 			},
 			expectedOut: "https://github.com/OWNER/REPO/pull/12\n",
 		},
+		{
+			name: "nontty json output",
+			httpStubs: func(reg *httpmock.Registry, t *testing.T) {
+				reg.Register(
+					httpmock.GraphQL(`mutation PullRequestCreate\b`),
+					httpmock.GraphQLMutation(`
+						{ "data": { "createPullRequest": { "pullRequest": {
+							"ID": "NEWPULLID",
+							"Number": 12,
+							"URL": "https://github.com/OWNER/REPO/pull/12"
+						} } } }`,
+						func(input map[string]interface{}) {
+							assert.Equal(t, "REPOID", input["repositoryId"])
+							assert.Equal(t, "my title", input["title"])
+							assert.Equal(t, "my body", input["body"])
+						}))
+			},
+			setup: func(opts *CreateOptions, t *testing.T) func() {
+				opts.TitleProvided = true
+				opts.BodyProvided = true
+				opts.Title = "my title"
+				opts.Body = "my body"
+				opts.HeadBranch = "feature"
+				exporter := cmdutil.NewJSONExporter()
+				exporter.SetFields([]string{"id", "number", "url"})
+				opts.Exporter = exporter
+				return func() {}
+			},
+			expectedOut: "{\"id\":\"NEWPULLID\",\"number\":12,\"url\":\"https://github.com/OWNER/REPO/pull/12\"}\n",
+		},
+		{
+			name: "tty json output",
+			tty:  true,
+			httpStubs: func(reg *httpmock.Registry, t *testing.T) {
+				reg.Register(
+					httpmock.GraphQL(`mutation PullRequestCreate\b`),
+					httpmock.GraphQLMutation(`
+						{ "data": { "createPullRequest": { "pullRequest": {
+							"ID": "NEWPULLID",
+							"Number": 12,
+							"URL": "https://github.com/OWNER/REPO/pull/12"
+						} } } }`,
+						func(input map[string]interface{}) {}))
+			},
+			setup: func(opts *CreateOptions, t *testing.T) func() {
+				opts.TitleProvided = true
+				opts.BodyProvided = true
+				opts.Title = "my title"
+				opts.Body = "my body"
+				opts.HeadBranch = "feature"
+				exporter := cmdutil.NewJSONExporter()
+				exporter.SetFields([]string{"id", "number", "url"})
+				opts.Exporter = exporter
+				return func() {}
+			},
+			expectedOut:    "{\"id\":\"NEWPULLID\",\"number\":12,\"url\":\"https://github.com/OWNER/REPO/pull/12\"}\n",
+			expectedErrOut: "\nCreating pull request for feature into master in OWNER/REPO\n\n",
+		},
+		{
+			name: "json output with jq filter",
+			httpStubs: func(reg *httpmock.Registry, t *testing.T) {
+				reg.Register(
+					httpmock.GraphQL(`mutation PullRequestCreate\b`),
+					httpmock.GraphQLMutation(`
+						{ "data": { "createPullRequest": { "pullRequest": {
+							"ID": "NEWPULLID",
+							"Number": 12,
+							"URL": "https://github.com/OWNER/REPO/pull/12"
+						} } } }`,
+						func(input map[string]interface{}) {}))
+			},
+			setup: func(opts *CreateOptions, t *testing.T) func() {
+				opts.TitleProvided = true
+				opts.BodyProvided = true
+				opts.Title = "my title"
+				opts.Body = "my body"
+				opts.HeadBranch = "feature"
+				exporter := cmdutil.NewJSONExporter()
+				exporter.SetFields([]string{"id", "number", "url"})
+				exporter.SetFilter(".number")
+				opts.Exporter = exporter
+				return func() {}
+			},
+			expectedOut: "12\n",
+		},
+		{
+			name: "json output does not print URL",
+			httpStubs: func(reg *httpmock.Registry, t *testing.T) {
+				reg.Register(
+					httpmock.GraphQL(`mutation PullRequestCreate\b`),
+					httpmock.GraphQLMutation(`
+						{ "data": { "createPullRequest": { "pullRequest": {
+							"Number": 12,
+							"URL": "https://github.com/OWNER/REPO/pull/12"
+						} } } }`,
+						func(input map[string]interface{}) {}))
+			},
+			setup: func(opts *CreateOptions, t *testing.T) func() {
+				opts.TitleProvided = true
+				opts.BodyProvided = true
+				opts.Title = "my title"
+				opts.Body = "my body"
+				opts.HeadBranch = "feature"
+				exporter := cmdutil.NewJSONExporter()
+				exporter.SetFields([]string{"number"})
+				opts.Exporter = exporter
+				return func() {}
+			},
+			expectedOut: "{\"number\":12}\n",
+		},
 		{
 			name: "same head and base branch should error",
 			setup: func(opts *CreateOptions, t *testing.T) func() {

@@ -29,7 +29,7 @@ func AddJSONFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string) {
 	addJqFlag(f, "q")
 	addTemplateFlag(f, "t")
 
-	setupJsonFlags(cmd, exportTarget, fields)
+	setupJsonFlags(cmd, exportTarget, fields, true)
 }
 
 func AddJSONFlagsWithoutShorthand(cmd *cobra.Command, exportTarget *Exporter, fields []string) {
@@ -38,7 +38,18 @@ func AddJSONFlagsWithoutShorthand(cmd *cobra.Command, exportTarget *Exporter, fi
 	addJqFlag(f, "")
 	addTemplateFlag(f, "")
 
-	setupJsonFlags(cmd, exportTarget, fields)
+	setupJsonFlags(cmd, exportTarget, fields, true)
+}
+
+// AddJSONAndJQFlags adds the `--json` and `--jq` flags to the given command, without
+// the `--template` flag or any shorthands. It is meant for commands where `--template`
+// (or a shorthand) is already taken for another purpose, such as `pr create`.
+func AddJSONAndJQFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string) {
+	f := cmd.Flags()
+	addJsonFlag(f)
+	addJqFlag(f, "")
+
+	setupJsonFlags(cmd, exportTarget, fields, false)
 }
 
 func addJsonFlag(f *pflag.FlagSet) {
@@ -51,7 +62,7 @@ func addTemplateFlag(f *pflag.FlagSet, shorthand string) {
 	f.StringP("template", shorthand, "", "Format JSON output using a Go template; see \"gh help formatting\"")
 }
 
-func setupJsonFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string) {
+func setupJsonFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string, withTemplateFlag bool) {
 
 	_ = cmd.RegisterFlagCompletionFunc("json", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 		var results []string
@@ -77,7 +88,7 @@ func setupJsonFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string)
 				return err
 			}
 		}
-		if export, err := checkJSONFlags(c); err == nil {
+		if export, err := checkJSONFlags(c, withTemplateFlag); err == nil {
 			if export == nil {
 				*exportTarget = nil
 			} else {
@@ -118,13 +129,24 @@ func setupJsonFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string)
 	cmd.Annotations["help:json-fields"] = strings.Join(fields, ",")
 }
 
-func checkJSONFlags(cmd *cobra.Command) (*jsonExporter, error) {
+// checkJSONFlags validates the JSON-related flags of the given command and, if
+// `--json` is in use, builds an exporter from their values. When withTemplateFlag
+// is false, the `--template` flag is not part of the JSON flags group and is
+// ignored, even if the host command defines a flag with the same name for
+// another purpose.
+func checkJSONFlags(cmd *cobra.Command, withTemplateFlag bool) (*jsonExporter, error) {
 	f := cmd.Flags()
 	jsonFlag := f.Lookup("json")
 	jqFlag := f.Lookup("jq")
-	tplFlag := f.Lookup("template")
 	webFlag := f.Lookup("web")
 
+	var tplFlag *pflag.Flag
+	var templateValue string
+	if withTemplateFlag {
+		tplFlag = f.Lookup("template")
+		templateValue = tplFlag.Value.String()
+	}
+
 	if jsonFlag.Changed {
 		if webFlag != nil && webFlag.Changed {
 			return nil, errors.New("cannot use `--web` with `--json`")
@@ -133,11 +155,11 @@ func checkJSONFlags(cmd *cobra.Command) (*jsonExporter, error) {
 		return &jsonExporter{
 			fields:   jv.GetSlice(),
 			filter:   jqFlag.Value.String(),
-			template: tplFlag.Value.String(),
+			template: templateValue,
 		}, nil
 	} else if jqFlag.Changed {
 		return nil, errors.New("cannot use `--jq` without specifying `--json`")
-	} else if tplFlag.Changed {
+	} else if tplFlag != nil && tplFlag.Changed {
 		return nil, errors.New("cannot use `--template` without specifying `--json`")
 	}
 	return nil, nil
@@ -219,6 +241,10 @@ func (e *jsonExporter) SetFields(fields []string) {
 	e.fields = fields
 }
 
+func (e *jsonExporter) SetFilter(filter string) {
+	e.filter = filter
+}
+
 // Write serializes data into JSON output written to w. If the object passed as data implements exportable,
 // or if data is a map or slice of exportable object, ExportData() will be called on each object to obtain
 // raw data for serialization.