GitLabgitlab-org
cli
main
1package list
3import (
4 "github.com/MakeNowJust/heredoc/v2"
5 "github.com/spf13/cobra"
7 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
9 "gitlab.com/gitlab-org/cli/internal/cmdutils"
10 "gitlab.com/gitlab-org/cli/internal/glrepo"
11 "gitlab.com/gitlab-org/cli/internal/iostreams"
12 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
13 "gitlab.com/gitlab-org/cli/internal/tableprinter"
14 "gitlab.com/gitlab-org/cli/internal/utils"
15)
17type options struct {
18 gitlabClient func() (*gitlab.Client, error)
19 io *iostreams.IOStreams
20 baseRepo func() (glrepo.Interface, error)
22 // Pagination
23 page int
24 perPage int
26 showKeyIDs bool
27 outputFormat string
28}
30func NewCmdList(f cmdutils.Factory) *cobra.Command {
31 opts := &options{
32 io: f.IO(),
33 gitlabClient: f.GitLabClient,
34 baseRepo: f.BaseRepo,
35 }
36 cmd := &cobra.Command{
37 Use: "list",
38 Short: "Get a list of deploy keys for the current project.",
39 Long: heredoc.Docf(`Each row shows the key's title, key, push access, and creation date.
40 Pass %[1]s--show-id%[1]s to also display the key ID, which the %[1]sget%[1]s and %[1]sdelete%[1]s
41 commands accept as an argument. Use %[1]s--repo%[1]s to target a project other than
42 the current one.
43 `, "`"),
44 Example: heredoc.Doc(`
45 # List the current project's deploy keys
46 glab deploy-key list
48 # Include the key ID in the output
49 glab deploy-key list --show-id`),
50 Args: cobra.NoArgs,
51 ValidArgsFunction: cobra.NoFileCompletions,
52 Annotations: map[string]string{
53 mcpannotations.Safe: "true",
54 },
55 RunE: func(cmd *cobra.Command, args []string) error {
56 return opts.run()
57 },
58 }
60 cmd.Flags().BoolVarP(&opts.showKeyIDs, "show-id", "", false, "Shows IDs of deploy keys.")
61 cmd.Flags().IntVarP(&opts.page, "page", "p", 1, "Page number.")
62 cmd.Flags().IntVarP(&opts.perPage, "per-page", "P", 30, "Number of items to list per page.")
63 cmdutils.EnableJSONOutput(cmd, opts.io, &opts.outputFormat)
65 return cmd
66}
68func (o *options) run() error {
69 client, err := o.gitlabClient()
70 if err != nil {
71 return err
72 }
74 listProjectDeployKeysOptions := &gitlab.ListProjectDeployKeysOptions{
75 ListOptions: gitlab.ListOptions{
76 Page: int64(o.page),
77 PerPage: int64(o.perPage),
78 },
79 }
81 baseRepo, err := o.baseRepo()
82 if err != nil {
83 return err
84 }
86 keys, _, err := client.DeployKeys.ListProjectDeployKeys(baseRepo.FullName(), listProjectDeployKeysOptions)
87 if err != nil {
88 return cmdutils.WrapError(err, "failed to get deploy keys.")
89 }
91 if o.outputFormat == "json" {
92 return o.io.PrintJSON(keys)
93 }
95 cs := o.io.Color()
96 table := tableprinter.NewTablePrinter()
97 isTTy := o.io.IsOutputTTY()
99 if len(keys) > 0 {
100 if o.showKeyIDs {
101 table.AddRow("ID", "Title", "Key", "Can Push", "Created At")
102 } else {
103 table.AddRow("Title", "Key", "Can Push", "Created At")
104 }
105 }
107 for _, key := range keys {
108 createdAt := key.CreatedAt.String()
109 if o.showKeyIDs {
110 table.AddCell(key.ID)
111 }
112 if isTTy {
113 createdAt = utils.TimeToPrettyTimeAgo(*key.CreatedAt)
114 }
115 table.AddRow(key.Title, key.Key, key.CanPush, cs.Gray(createdAt))
116 }
118 o.io.LogInfo(table.String())
120 return nil
121}
Diagnostics8 git calls · 55 ms
CallStatusSizeTime055 ms
discover200185 B3 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 KiB2 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=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=3 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
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=4 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.8 KiB · hit4 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=1857 git.response.cache=HIT git.response.duration_ms=4 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:0200227 B · hit2 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=227 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=250e56c3e2d782c6373a9538c740837f85243a75 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=227 git.pkt.payload.max=200 git.sideband.band1.bytes=200 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=200 git.pack.trailer=e13cfdecc4907e32538df2da5c8a114f27dcffd1Open pack map
fetchtree:0200134 B · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=40 git.response.bytes=134 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=469d2962e679af3d1e1750b60c5155c4cd98591a 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=134 git.pkt.payload.max=107 git.sideband.band1.bytes=107 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=107 git.pack.trailer=6307c42081a6c2603b909657c0a988aa0ff400d2Open pack map
fetch2001.4 KiB · hit40 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1403 git.response.cache=HIT git.response.duration_ms=40 git.fetch.wants=9e552393be80108f27d0094d35b917da79c665d4 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=1403 git.pkt.payload.max=1376 git.sideband.band1.bytes=1376 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
- a5e2ca453ce04b67
- Request
- 7ab5e8f7…
- 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