GitLabgitlab-org
cli
main
1package note
3import (
4 "context"
6 "github.com/MakeNowJust/heredoc/v2"
7 "github.com/spf13/cobra"
9 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
11 "gitlab.com/gitlab-org/cli/internal/cmdutils"
12 "gitlab.com/gitlab-org/cli/internal/commands/mr/mrutils"
13 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
14 "gitlab.com/gitlab-org/cli/internal/text"
15)
17type listOptions struct {
18 factory cmdutils.Factory
20 args []string
21 noteType string
22 state string
23 filePath string
24 outputFormat string
25}
27func NewCmdList(f cmdutils.Factory) *cobra.Command {
28 opts := &listOptions{
29 factory: f,
30 }
32 mrNoteListCmd := &cobra.Command{
33 Use: "list [<id> | <branch>]",
34 Short: "List merge request discussions. (EXPERIMENTAL)",
35 Long: heredoc.Docf(`Fetches and displays merge request discussions.
37 Human-readable output shows an eight-character prefix for each non-system
38 discussion. Use the characters before the ellipsis with
39 %[1]sglab mr note create --reply%[1]s. JSON output preserves the full discussion ID in the %[1]sid%[1]s field of each discussion object. Extract it with:
40 %[1]sglab mr note list -F json | jq -r '.[].id'%[1]s.
42 Supports filtering by note type, resolution state, and file path.
43 Supports JSON output for scripting.
44 `, "`") + text.ExperimentalString,
45 Example: heredoc.Doc(`
46 # List all discussions on the current branch's MR
47 glab mr note list
49 # List diff comments only
50 glab mr note list --type diff
52 # List unresolved discussions
53 glab mr note list --state unresolved
55 # List discussions on a specific file
56 glab mr note list --file src/main.go
58 # JSON output for scripting
59 glab mr note list -F json | jq '.[].notes[].body'
61 # List discussions on MR 123
62 glab mr note list 123`),
63 Args: cobra.MaximumNArgs(1),
64 Annotations: map[string]string{
65 mcpannotations.Safe: "true",
66 },
67 RunE: func(cmd *cobra.Command, args []string) error {
68 opts.complete(args)
69 return opts.run(cmd.Context())
70 },
71 }
73 mrNoteListCmd.Flags().VarP(
74 cmdutils.NewEnumValue([]string{"all", "general", "diff", "system"}, "all", &opts.noteType),
75 "type", "t", "Note type: all, general, diff, system.",
76 )
77 mrNoteListCmd.Flags().Var(
78 cmdutils.NewEnumValue([]string{"all", "resolved", "unresolved"}, "all", &opts.state),
79 "state", "Resolution state: all, resolved, unresolved.",
80 )
81 mrNoteListCmd.Flags().StringVar(&opts.filePath, "file", "", "Show only diff notes on this file path.")
82 cmdutils.EnableJSONOutput(mrNoteListCmd, f.IO(), &opts.outputFormat)
84 return mrNoteListCmd
85}
87func (o *listOptions) complete(args []string) {
88 o.args = args
89}
91func (o *listOptions) run(ctx context.Context) error {
92 client, err := o.factory.GitLabClient()
93 if err != nil {
94 return err
95 }
97 mr, repo, err := mrutils.MRFromArgs(ctx, o.factory, o.args, "any")
98 if err != nil {
99 return err
100 }
102 discussions, err := mrutils.ListAllDiscussions(ctx, client, repo.FullName(), mr.IID, &gitlab.ListMergeRequestDiscussionsOptions{})
103 if err != nil {
104 return err
105 }
107 filterOpts := mrutils.FilterOpts{}
108 if o.noteType != "all" {
109 filterOpts.Type = o.noteType
110 }
111 if o.state != "all" {
112 filterOpts.State = o.state
113 }
114 filterOpts.FilePath = o.filePath
116 filtered := mrutils.FilterDiscussions(discussions, filterOpts)
118 if o.outputFormat == "json" {
119 return o.factory.IO().PrintJSON(filtered)
120 }
122 out := o.factory.IO().StdOut
123 if len(filtered) == 0 {
124 o.factory.IO().LogInfo("No discussions found.")
125 return nil
126 }
128 showSystemLogs := o.noteType == "system" || o.noteType == "all"
130 mrutils.PrintDiscussions(out, o.factory.IO(), filtered, mrutils.PrintDiscussionsOptions{
131 ShowSystemLogs: showSystemLogs,
132 ShowSingleNoteDiscussionPrefix: true,
133 })
135 return nil
136}
Diagnostics8 git calls · 270 ms
CallStatusSizeTime0270 ms
discover200185 B4 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch 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 KiB3 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=3 git.response.bytes=59849 git.response.cache=UPDATING git.response.duration_ms=3 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
fetchcombine:blob:none+tree:2 · deepen 12004.2 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=4273 git.response.cache=HIT git.response.duration_ms=2 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: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=1 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=44Open pack map
fetchtree:02001.8 KiB · hit1 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=1857 git.response.cache=HIT git.response.duration_ms=1 git.fetch.filter=tree:0 git.fetch.wants=dce174ff8c632a19d17eea99c8a9b7c37fb2b592 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=1857 git.pkt.payload.max=1830 git.sideband.band1.bytes=1830 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=1830 git.pack.trailer=fb03183b7909876778f740d196d7516811003517Open pack map
fetchtree:0200746 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=746 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=f3d413a22af5a9c2fe9aa49709b1cb36d1351a7f 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=746 git.pkt.payload.max=719 git.sideband.band1.bytes=719 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=719 git.pack.trailer=330baf80c59a4208b55120dff7dd824b7952b790Open pack map
fetchtree:0200540 B · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=257 git.response.bytes=540 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=d1be7f980a856805fa31e30e01fff4db335cbe1b 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=540 git.pkt.payload.max=513 git.sideband.band1.bytes=513 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=513 git.pack.trailer=6c82398efd91c9e023d583b948fde889bd4991b2Open pack map
fetch2001.5 KiB257 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1555 git.response.cache=MISS git.response.duration_ms=257 git.fetch.wants=9d26a25f828452566c54724cc20afe1dd789cfee 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=1555 git.pkt.payload.max=1528 git.sideband.band1.bytes=1528 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
- a5e2b3e2cbe2cf33
- Request
- 025327f9…
- 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