GitLabgitlab-org

cli

main
ply7 git calls207 ms99 KiB5 cachedprotocol v2
85 lines3.9 KiBRaw

Update issue.

Synopsis

Change an issue's labels, assignees, milestone, title, or description. Use --label and --unlabel to add or remove labels.

Use --estimate and --spend to track time on the issue, the same as the /estimate and /spend quick actions. Durations use the GitLab time tracking format, for example 1mo 2w 3d 4h 5m. --spend adds to the time already spent. --remove-estimate and --remove-time-spent reset the estimate and the time spent.

--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. Without --description the references are added to the description the issue already has, instead of replacing it.

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/.

plaintext
glab issue update <id> [flags]

Examples

console
glab issue update 42 --label ui,ux
glab issue update 42 --unlabel working

# Read the description from a file
glab issue update 42 --description-file description.md

# Read the description from standard input
cat description.md | glab issue update 42 --description-file -

# Add a screenshot to the existing description
glab issue update 42 --attach ./screenshot.png

# Set a time estimate and log time spent
glab issue update 42 --estimate 2d --spend 1h30m

# Reset the time estimate and the time spent
glab issue update 42 --remove-estimate --remove-time-spent

Options

plaintext
  -a, --assignee strings          Assign users by username. Prefix with '!' or '-' to remove from existing assignees, or '+' to add new. Otherwise, replace existing assignees with these users. 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              Make issue 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.
      --estimate string           Set the time estimate for the issue, for example '2d' or '3h30m'.
  -l, --label strings             Add labels.
      --lock-discussion           Lock discussion on issue.
  -m, --milestone string          Title of the milestone to assign Set to "" or 0 to unassign.
  -p, --public                    Make issue public.
      --remove-estimate           Remove the time estimate from the issue.
      --remove-time-spent         Remove all time spent from the issue.
      --spend string              Add time spent on the issue, for example '1h30m'.
  -t, --title string              Title of issue.
      --unassign                  Unassign all users.
  -u, --unlabel strings           Remove labels.
      --unlock-discussion         Unlock discussion on issue.
  -w, --weight int                Set weight of 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 update`'
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-->
13Update issue.
15## Synopsis
17Change an issue's labels, assignees, milestone, title, or
18description. Use `--label` and `--unlabel` to add or remove
19labels.
21Use `--estimate` and `--spend` to track time on the issue, the same as the `/estimate` and `/spend` quick actions. Durations use the GitLab time tracking format, for example `1mo 2w 3d 4h 5m`. `--spend` adds to the time already spent. `--remove-estimate` and `--remove-time-spent` reset the estimate and the time spent.
23`--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. Without `--description` the references are added to the description the issue already has, instead of replacing it.
25The `--attach` flag is an experiment. It might be
26unstable or removed at any time, and is not ready for production use.
27For more information, see
28<https://docs.gitlab.com/policy/development_stages_support/>.
30```plaintext
31glab issue update <id> [flags]
32```
34## Examples
36```console
37glab issue update 42 --label ui,ux
38glab issue update 42 --unlabel working
40# Read the description from a file
41glab issue update 42 --description-file description.md
43# Read the description from standard input
44cat description.md | glab issue update 42 --description-file -
46# Add a screenshot to the existing description
47glab issue update 42 --attach ./screenshot.png
49# Set a time estimate and log time spent
50glab issue update 42 --estimate 2d --spend 1h30m
52# Reset the time estimate and the time spent
53glab issue update 42 --remove-estimate --remove-time-spent
54```
56## Options
58```plaintext
59 -a, --assignee strings Assign users by username. Prefix with '!' or '-' to remove from existing assignees, or '+' to add new. Otherwise, replace existing assignees with these users. Multiple usernames can be comma-separated or specified by repeating the flag.
60 --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.
61 -c, --confidential Make issue confidential.
62 -d, --description string Issue description. Set to "-" to open an editor.
63 --description-file string Read the issue description from a file. Use "-" to read from standard input.
64 --due-date string A date in 'YYYY-MM-DD' format.
65 --estimate string Set the time estimate for the issue, for example '2d' or '3h30m'.
66 -l, --label strings Add labels.
67 --lock-discussion Lock discussion on issue.
68 -m, --milestone string Title of the milestone to assign Set to "" or 0 to unassign.
69 -p, --public Make issue public.
70 --remove-estimate Remove the time estimate from the issue.
71 --remove-time-spent Remove all time spent from the issue.
72 --spend string Add time spent on the issue, for example '1h30m'.
73 -t, --title string Title of issue.
74 --unassign Unassign all users.
75 -u, --unlabel strings Remove labels.
76 --unlock-discussion Unlock discussion on issue.
77 -w, --weight int Set weight of the issue.
78```
80## Options inherited from parent commands
82```plaintext
83 -h, --help Show help for this command.
84 -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.
85```
Diagnostics7 git calls · 207 ms
CallStatusSizeTime0207 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 KiB · hit2 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=HIT
git.response.duration_ms=2
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 · 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=4273
git.response.cache=HIT
git.response.duration_ms=3
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 · hit6 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=6
git.response.bytes=433
git.response.cache=HIT
git.response.duration_ms=6
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.6 KiB193 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=193
git.response.bytes=1606
git.response.cache=MISS
git.response.duration_ms=193
git.fetch.wants=805629412c60ddb80cc4f3d06f871b521b4438cd
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=1606
git.pkt.payload.max=1579
git.sideband.band1.bytes=1579
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
a5e129647dcb7fd8
Request
04b04987…
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