GitLabgitlab-org

cli

main
ply7 git calls195 ms99 KiB4 cachedprotocol v2
98 lines4.8 KiBRaw

Create an issue.

Synopsis

Opens an editor to draft the issue unless you pass a title and description. Use --web to create the issue in your browser, or --template to start from an issue template.

--attach uploads a file and references it at the end of the description. Repeat the flag for more than one file, or pass - to read the file from standard input. An attachment satisfies the description requirement, so --title with --attach completes without prompting.

The --attach flag is an experiment. It might be unstable or removed at any time, and is not ready for production use. For more information, see https://docs.gitlab.com/policy/development_stages_support/.

The --recover flag is an experiment: it might be unstable or removed at any time, and is not ready for production use. For more information, see https://docs.gitlab.com/policy/development_stages_support/.

plaintext
glab issue create [flags]

Aliases

plaintext
new

Examples

console
glab issue create
glab issue new
glab issue create -m release-2.0.0 -t "we need this feature" --label important
glab issue new -t "Fix CVE-YYYY-XXXX" -l security --linked-mr 123
glab issue create -m release-1.0.1 -t "security fix" --label security --web --recover
glab issue create -t "Bug Report" --template bug
glab issue create -t "Feature Request" --template feature_proposal.md --yes

# Use a template file from outside the repository
glab issue create -t "Bug Report" --template ~/team-templates/bug.md

# Read the description from a file
glab issue create -t "we need this feature" --description-file description.md

# Read the description from standard input
cat description.md | glab issue create -t "we need this feature" --description-file -

# Attach a screenshot to the description
glab issue create -t "Login button misaligned" -d "See below." --attach ./screenshot.png

Options

plaintext
  -a, --assignee usernames        Assign issue to people by their usernames. Multiple usernames can be comma-separated or specified by repeating the flag.
      --attach stringArray        (EXPERIMENTAL) Upload a file and reference it at the end of the description. Use "-" to read the file from standard input. Repeat the flag to attach multiple files.
  -c, --confidential              Set an issue to be confidential.
  -d, --description string        Issue description. Set to "-" to open an editor.
      --description-file string   Read the issue description from a file. Use "-" to read from standard input.
      --due-date string           A date in 'YYYY-MM-DD' format.
      --epic int                  ID of the epic to add the issue to.
  -l, --label strings             Add label by name. Multiple labels can be comma-separated or specified by repeating the flag.
      --link-type string          Type for the issue link. (default "relates_to")
      --linked-issues ints        The IIDs of issues that this issue links to. Multiple IIDs can be comma-separated or specified by repeating the flag.
      --linked-mr int             The IID of a merge request in which to resolve all issues.
  -m, --milestone string          The global ID or title of a milestone to assign.
      --no-editor                 Don't open editor to enter a description. If set to true, uses prompt.
      --recover                   Save the options to a file if the issue fails to be created. If the file exists, the options will be loaded from the recovery file. (EXPERIMENTAL)
      --template string           Template to pre-populate the description. A name is looked up in '.gitlab/issue_templates/' of the local repository, and the '.md' extension is optional. A value that is absolute or contains a path separator is read as a file path, for example '~/templates/bug.md'.
  -e, --time-estimate string      Set time estimate for the issue.
  -s, --time-spent string         Set time spent for the issue.
  -t, --title string              Issue title.
      --web                       Continue issue creation with web interface.
  -w, --weight int                Issue weight. Valid values are greater than or equal to 0.
  -y, --yes                       Don't prompt for confirmation to submit the issue.

Options inherited from parent commands

plaintext
  -h, --help          Show help for this command.
  -R, --repo string   Select another repository. You can use either OWNER/REPO or GROUP/NAMESPACE/REPO. The full URL or Git URL is also accepted.
1---
2title: '`glab issue create`'
3stage: AI Clients
4group: Developer Clients
5info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/marketing/product-and-technical-marketing/technical-writing/#assignments>
6---
8<!--
9This documentation is auto generated by a script.
10Please do not edit this file directly. Run `make gen-docs` instead.
11-->
13Create an issue.
15## Synopsis
17Opens an editor to draft the issue unless you pass a title and
18description. Use `--web` to create the issue in your browser, or
19`--template` to start from an issue template.
21`--attach` uploads a file and references it at the end of the description. Repeat the flag for more than one file, or pass `-` to read the file from standard input. An attachment satisfies the description requirement, so `--title` with `--attach` completes without prompting.
23The `--attach` flag is an experiment. It might be
24unstable or removed at any time, and is not ready for production use.
25For more information, see
26<https://docs.gitlab.com/policy/development_stages_support/>.
28The `--recover` flag is an experiment: it might be unstable or
29removed at any time, and is not ready for production use. For more
30information, see
31<https://docs.gitlab.com/policy/development_stages_support/>.
33```plaintext
34glab issue create [flags]
35```
37## Aliases
39```plaintext
40new
41```
43## Examples
45```console
46glab issue create
47glab issue new
48glab issue create -m release-2.0.0 -t "we need this feature" --label important
49glab issue new -t "Fix CVE-YYYY-XXXX" -l security --linked-mr 123
50glab issue create -m release-1.0.1 -t "security fix" --label security --web --recover
51glab issue create -t "Bug Report" --template bug
52glab issue create -t "Feature Request" --template feature_proposal.md --yes
54# Use a template file from outside the repository
55glab issue create -t "Bug Report" --template ~/team-templates/bug.md
57# Read the description from a file
58glab issue create -t "we need this feature" --description-file description.md
60# Read the description from standard input
61cat description.md | glab issue create -t "we need this feature" --description-file -
63# Attach a screenshot to the description
64glab issue create -t "Login button misaligned" -d "See below." --attach ./screenshot.png
65```
67## Options
69```plaintext
70 -a, --assignee usernames Assign issue to people by their usernames. Multiple usernames can be comma-separated or specified by repeating the flag.
71 --attach stringArray (EXPERIMENTAL) Upload a file and reference it at the end of the description. Use "-" to read the file from standard input. Repeat the flag to attach multiple files.
72 -c, --confidential Set an issue to be confidential.
73 -d, --description string Issue description. Set to "-" to open an editor.
74 --description-file string Read the issue description from a file. Use "-" to read from standard input.
75 --due-date string A date in 'YYYY-MM-DD' format.
76 --epic int ID of the epic to add the issue to.
77 -l, --label strings Add label by name. Multiple labels can be comma-separated or specified by repeating the flag.
78 --link-type string Type for the issue link. (default "relates_to")
79 --linked-issues ints The IIDs of issues that this issue links to. Multiple IIDs can be comma-separated or specified by repeating the flag.
80 --linked-mr int The IID of a merge request in which to resolve all issues.
81 -m, --milestone string The global ID or title of a milestone to assign.
82 --no-editor Don't open editor to enter a description. If set to true, uses prompt.
83 --recover Save the options to a file if the issue fails to be created. If the file exists, the options will be loaded from the recovery file. (EXPERIMENTAL)
84 --template string Template to pre-populate the description. A name is looked up in '.gitlab/issue_templates/' of the local repository, and the '.md' extension is optional. A value that is absolute or contains a path separator is read as a file path, for example '~/templates/bug.md'.
85 -e, --time-estimate string Set time estimate for the issue.
86 -s, --time-spent string Set time spent for the issue.
87 -t, --title string Issue title.
88 --web Continue issue creation with web interface.
89 -w, --weight int Issue weight. Valid values are greater than or equal to 0.
90 -y, --yes Don't prompt for confirmation to submit the issue.
91```
93## Options inherited from parent commands
95```plaintext
96 -h, --help Show help for this command.
97 -R, --repo string Select another repository. You can use either OWNER/REPO or GROUP/NAMESPACE/REPO. The full URL or Git URL is also accepted.
98```
Diagnostics7 git calls · 195 ms
CallStatusSizeTime0195 ms
discover200185 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=185
git.server.agent=git/2.56.g1891de4-Linux
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch server-option object-format
git.server.fetch=shallow wait-for-done filter
git.protocol.version=2
git.pkt.frames=9
git.pkt.data=7
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=185
git.pkt.payload.max=35
ls-refs20058 KiB4 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=59849
git.response.cache=UPDATING
git.response.duration_ms=4
git.protocol.version=2
git.pkt.frames=731
git.pkt.data=730
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=59849
git.pkt.payload.max=143
git.ls_refs.count=730
git.ls_refs.head=refs/heads/main
fetchtree:0 · deepen 1020032 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=22
git.pkt.data=20
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=32926
git.pkt.payload.max=32046
git.sideband.band1.bytes=32046
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=80
git.pack.bytes=32046
git.pack.ofs_delta=36
git.pack.ref_delta=0
git.pack.chain.max=2
git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91
git.pack.full=44
Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit4 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=4
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=4
git.fetch.filter=combine:blob:none+tree:2
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=1
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=4273
git.pkt.payload.max=4173
git.sideband.band1.bytes=4173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=11
git.pack.bytes=4173
git.fetch.wide.objects=11
git.fetch.wide.extra_bytes=3930
git.fetch.wide.blobs=0
fetchtree:02001.7 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=1744
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=5e4007a5673eb3bf5d0d7f1a1463c3b2ca3fb3bd
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1744
git.pkt.payload.max=1717
git.sideband.band1.bytes=1717
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1717
git.pack.trailer=3f1b9ccc7756e8941d6705e8187c87fd922113e6
Open pack map
fetchtree:0200433 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=433
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=0f525b789b7ad436bcbb0793a355127f165d1dc7
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=433
git.pkt.payload.max=406
git.sideband.band1.bytes=406
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=406
git.pack.trailer=51566f8ab4e7791e970c94f5afc929d32742687d
Open pack map
fetch2001.9 KiB181 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=181
git.response.bytes=1955
git.response.cache=MISS
git.response.duration_ms=181
git.fetch.wants=b1166cbafdb8c5714b5be57e6b70b2660d6e5a85
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1955
git.pkt.payload.max=1928
git.sideband.band1.bytes=1928
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://gitlab.com/gitlab-org/cli
Ref
refs/heads/main
Commit
0dd7574dce9e385c5c30540e6c15657adc6bdce9
cf-ray
a5e124050ec47fd8
Request
526ecfb8…
Protocol
v2 · sha1
Agent
git/2.56.g1891de4-Linux
Filter
advertised
Fetch
shallow wait-for-done filter
Capabilities
agent ls-refs fetch server-option object-format