GitLabgitlab-org

cli

main
ply8 git calls669 ms96 KiB5 cachedprotocol v2
91 lines4.0 KiBRaw

Update work items in a project or group. (EXPERIMENTAL)

Synopsis

The command uses your repository context to detect scope automatically.

Use --group to target a group or subgroup. --group and --repo are mutually exclusive.

--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 work item already has, instead of replacing it. Uploads are project-scoped, so --attach cannot be combined with --group.

--parent accepts a work item ID in the current scope, a reference such as group/project#123, or a URL.

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

plaintext
glab work-items update <iid> [flags]

Examples

console
# Update a work item in current project
glab work-items update 42 --description "this issue tracks a new feature"

# Update a work item in a group
glab work-items update 40 --group MYGROUP --description "this epic tracks a new feature"

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

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

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

# Move a work item to another iteration
glab work-items update 42 --iteration 123

# Move a work item under work item 40
glab work-items update 42 --parent 40

# Set the status of a work item
glab work-items update 42 --status in-progress

# Move a work item under a work item in another project
glab work-items update 42 --parent https://gitlab.com/my-group/my-project/-/work_items/40

Options

plaintext
  -a, --assignee strings          Update the work item assignee with the supplied GitLab usernames.
      --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.
  -d, --description string        Update the description for the work item.
      --description-file string   Read the work item description from a file. Use "-" to read from standard input.
      --duedate string            Update the due date for the work item.
  -g, --group string              Update work items for a group or subgroup.
      --iteration int             Move the work item to the iteration with this ID.
      --jq string                 Filter JSON output with a jq expression.
  -m, --milestone string          Update the work item milestone with the title or ID.
  -F, --output string             Format output as: text, json. (default "text")
      --parent string             Set the parent work item by <id>, reference, or URL.
  -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.
      --startdate string          Update the start date for the work item.
      --status string             Set the work item status: todo, in-progress, done, wont-do, or duplicate. Needs the status widget, which is Premium and Ultimate only.
  -t, --title string              Update the title for the work item.
  -w, --weight int                Update the weight value for the work item.

Options inherited from parent commands

plaintext
  -h, --help   Show help for this command.
1---
2title: '`glab work-items 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 work items in a project or group. (EXPERIMENTAL)
15## Synopsis
17The command uses your repository context to detect scope automatically.
19Use `--group` to target a group or subgroup. `--group` and `--repo` are mutually exclusive.
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. Without `--description` the references are added to the description the work item already has, instead of replacing it. Uploads are project-scoped, so `--attach` cannot be combined with `--group`.
23`--parent` accepts a work item ID in the current scope, a reference such as `group/project#123`, or a URL.
25This feature is an experiment and is not ready for production use.
26It might be unstable or removed at any time.
27For more information, see
28<https://docs.gitlab.com/policy/development_stages_support/>.
30```plaintext
31glab work-items update <iid> [flags]
32```
34## Examples
36```console
37# Update a work item in current project
38glab work-items update 42 --description "this issue tracks a new feature"
40# Update a work item in a group
41glab work-items update 40 --group MYGROUP --description "this epic tracks a new feature"
43# Read the description from a file
44glab work-items update 42 --description-file description.md
46# Read the description from standard input
47cat description.md | glab work-items update 42 --description-file -
49# Add a screenshot to the existing description
50glab work-items update 42 --attach ./screenshot.png
52# Move a work item to another iteration
53glab work-items update 42 --iteration 123
55# Move a work item under work item 40
56glab work-items update 42 --parent 40
58# Set the status of a work item
59glab work-items update 42 --status in-progress
61# Move a work item under a work item in another project
62glab work-items update 42 --parent https://gitlab.com/my-group/my-project/-/work_items/40
64```
66## Options
68```plaintext
69 -a, --assignee strings Update the work item assignee with the supplied GitLab usernames.
70 --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.
71 -d, --description string Update the description for the work item.
72 --description-file string Read the work item description from a file. Use "-" to read from standard input.
73 --duedate string Update the due date for the work item.
74 -g, --group string Update work items for a group or subgroup.
75 --iteration int Move the work item to the iteration with this ID.
76 --jq string Filter JSON output with a jq expression.
77 -m, --milestone string Update the work item milestone with the title or ID.
78 -F, --output string Format output as: text, json. (default "text")
79 --parent string Set the parent work item by <id>, reference, or URL.
80 -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.
81 --startdate string Update the start date for the work item.
82 --status string Set the work item status: todo, in-progress, done, wont-do, or duplicate. Needs the status widget, which is Premium and Ultimate only.
83 -t, --title string Update the title for the work item.
84 -w, --weight int Update the weight value for the work item.
85```
87## Options inherited from parent commands
89```plaintext
90 -h, --help Show help for this command.
91```
Diagnostics8 git calls · 669 ms
CallStatusSizeTime0669 ms
discover200185 B94 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
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 KiB243 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=149
git.response.bytes=59849
git.response.cache=EXPIRED
git.response.duration_ms=149
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 · hit5 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=5
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=5
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
fetchtree:02001.1 KiB · 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=1112
git.response.cache=HIT
git.response.duration_ms=6
git.fetch.filter=tree:0
git.fetch.wants=fed5065f0120a857fec6fa567dcdacfd34c3187b
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=1112
git.pkt.payload.max=1085
git.sideband.band1.bytes=1085
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1085
git.pack.trailer=792a8e6885c3db50fcc6be7a28de09363c6fb5e4
Open pack map
fetchtree:0200650 B · 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=650
git.response.cache=HIT
git.response.duration_ms=4
git.fetch.filter=tree:0
git.fetch.wants=e2312cec91295d8042fa9ab0265a7cd64fad5c13
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=650
git.pkt.payload.max=623
git.sideband.band1.bytes=623
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=623
git.pack.trailer=140f0d5f3d6c8c8ef55e7d2581e9a7bd5f2fd4d6
Open pack map
fetchtree:02001.7 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=1744
git.response.cache=HIT
git.response.duration_ms=4
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:0200226 B · hit5 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=5
git.response.bytes=226
git.response.cache=HIT
git.response.duration_ms=5
git.fetch.filter=tree:0
git.fetch.wants=6023826ffccf67d62168a71d6c590336f6e01dec
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=226
git.pkt.payload.max=199
git.sideband.band1.bytes=199
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=199
git.pack.trailer=0dc57e2ae7461493f34493a1c28ae25cdea607cd
Open pack map
fetch2001.6 KiB402 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=402
git.response.bytes=1616
git.response.cache=MISS
git.response.duration_ms=402
git.fetch.wants=9c77f2881fbf02ac1c77ba592d58cfb651a02160
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=1616
git.pkt.payload.max=1589
git.sideband.band1.bytes=1589
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
a5e98e54d86bcf3e
Request
a5b995e1…
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