GitLabgitlab-org

cli

main
ply7 git calls327 ms98 KiB5 cachedprotocol v2
71 lines2.6 KiBRaw

Comment on an issue in GitLab.

Synopsis

Without --message, opens an editor at a terminal, and otherwise reads the comment from standard input, such as when input is piped or redirected.

--attach uploads a file and references it at the end of the comment. Repeat the flag for more than one file, or pass - to read the file from standard input. An attachment is content on its own, so a comment with only --attach does not prompt for a body. When standard input is not a terminal, it is read as the comment body, unless --attach - reads the file from standard input. The command waits until standard input closes, so to post only the attachment from a script, redirect standard input from /dev/null.

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 note <issue-id> [flags]

Aliases

plaintext
comment

Examples

console
# Comment on issue 123, opening an editor for the message
glab issue note 123

# Comment with the message given inline
glab issue note 123 --message "Looking into this now."

# Create an internal note, visible only to project members
glab issue note 123 --message "Rotating the leaked token now." --internal

# Attach a screenshot alongside the message
glab issue note 123 --message "Here is the repro." --attach ./screenshot.png

# Attach an image piped from the clipboard
pngpaste - | glab issue note 123 --attach -

# Comment with the message read from a file
glab issue note 123 < comment.md

Options

plaintext
      --attach stringArray   (EXPERIMENTAL) Upload a file and reference it at the end of the comment. Use "-" to read the file from standard input. Repeat the flag to attach multiple files.
      --internal             Create the note as an internal note, visible only to project members.
  -m, --message string       Message text.

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 note`'
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-->
13Comment on an issue in GitLab.
15## Synopsis
17Without `--message`, opens an editor at a terminal, and otherwise reads the comment from standard input, such as when input is piped or redirected.
19`--attach` uploads a file and references it at the end of the comment. Repeat the flag for more than one file, or pass `-` to read the file from standard input. An attachment is content on its own, so a comment with only `--attach` does not prompt for a body. When standard input is not a terminal, it is read as the comment body, unless `--attach -` reads the file from standard input. The command waits until standard input closes, so to post only the attachment from a script, redirect standard input from `/dev/null`.
21The `--attach` flag is an experiment. It might be
22unstable or removed at any time, and is not ready for production use.
23For more information, see
24<https://docs.gitlab.com/policy/development_stages_support/>.
26```plaintext
27glab issue note <issue-id> [flags]
28```
30## Aliases
32```plaintext
33comment
34```
36## Examples
38```console
39# Comment on issue 123, opening an editor for the message
40glab issue note 123
42# Comment with the message given inline
43glab issue note 123 --message "Looking into this now."
45# Create an internal note, visible only to project members
46glab issue note 123 --message "Rotating the leaked token now." --internal
48# Attach a screenshot alongside the message
49glab issue note 123 --message "Here is the repro." --attach ./screenshot.png
51# Attach an image piped from the clipboard
52pngpaste - | glab issue note 123 --attach -
54# Comment with the message read from a file
55glab issue note 123 < comment.md
56```
58## Options
60```plaintext
61 --attach stringArray (EXPERIMENTAL) Upload a file and reference it at the end of the comment. Use "-" to read the file from standard input. Repeat the flag to attach multiple files.
62 --internal Create the note as an internal note, visible only to project members.
63 -m, --message string Message text.
64```
66## Options inherited from parent commands
68```plaintext
69 -h, --help Show help for this command.
70 -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.
71```
Diagnostics7 git calls · 327 ms
CallStatusSizeTime0327 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 · 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=32926
git.response.cache=HIT
git.response.duration_ms=3
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 · 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=4273
git.response.cache=HIT
git.response.duration_ms=5
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 · 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=1744
git.response.cache=HIT
git.response.duration_ms=2
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 · hit7 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=7
git.response.bytes=433
git.response.cache=HIT
git.response.duration_ms=7
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.2 KiB311 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=311
git.response.bytes=1245
git.response.cache=MISS
git.response.duration_ms=311
git.fetch.wants=27a5fa20a4e7b40bbbd9bd862e8d7febde8782db
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=1245
git.pkt.payload.max=1218
git.sideband.band1.bytes=1218
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
a5e122ebaebb7fd8
Request
a7cf0a8c…
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