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/api"
10 "gitlab.com/gitlab-org/cli/internal/cmdutils"
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 apiClient func(repoHost string) (*api.Client, error)
19 io *iostreams.IOStreams
21 // Pagination
22 page int
23 perPage int
25 showKeyIDs bool
26 outputFormat string
27}
29func NewCmdList(f cmdutils.Factory) *cobra.Command {
30 opts := &options{
31 io: f.IO(),
32 apiClient: f.ApiClient,
33 }
34 cmd := &cobra.Command{
35 Use: "list",
36 Short: "Get a list of SSH keys for the currently authenticated user.",
37 Long: heredoc.Docf(`Each row shows the key's title, key, usage type, and creation date.
38 Pass %[1]s--show-id%[1]s to also display the key ID, which the %[1]sget%[1]s and %[1]sdelete%[1]s
39 commands accept as an argument.
40 `, "`"),
41 Example: heredoc.Doc(`
42 # List your SSH keys
43 glab ssh-key list
45 # Include the key ID in the output
46 glab ssh-key list --show-id`),
47 Args: cobra.NoArgs,
48 ValidArgsFunction: cobra.NoFileCompletions,
49 Annotations: map[string]string{
50 mcpannotations.Safe: "true",
51 },
52 RunE: func(cmd *cobra.Command, args []string) error {
53 return opts.run()
54 },
55 }
57 cmd.Flags().BoolVarP(&opts.showKeyIDs, "show-id", "", false, "Shows IDs of SSH keys.")
58 cmd.Flags().IntVarP(&opts.page, "page", "p", 1, "Page number.")
59 cmd.Flags().IntVarP(&opts.perPage, "per-page", "P", 30, "Number of items to list per page.")
60 cmdutils.EnableJSONOutput(cmd, opts.io, &opts.outputFormat)
62 return cmd
63}
65func (o *options) run() error {
66 c, err := o.apiClient("")
67 if err != nil {
68 return err
69 }
70 client := c.Lab()
72 sshKeyListOptions := &gitlab.ListSSHKeysOptions{
73 ListOptions: gitlab.ListOptions{
74 Page: int64(o.page),
75 PerPage: int64(o.perPage),
76 },
77 }
78 keys, _, err := client.Users.ListSSHKeys(sshKeyListOptions)
79 if err != nil {
80 return cmdutils.WrapError(err, "failed to get SSH keys.")
81 }
83 if o.outputFormat == "json" {
84 return o.io.PrintJSON(keys)
85 }
87 cs := o.io.Color()
88 table := tableprinter.NewTablePrinter()
89 isTTy := o.io.IsOutputTTY()
91 if len(keys) > 0 {
92 if o.showKeyIDs {
93 table.AddRow("ID", "Title", "Key", "Usage type", "Created At")
94 } else {
95 table.AddRow("Title", "Key", "Usage type", "Created At")
96 }
97 }
99 for _, key := range keys {
100 createdAt := key.CreatedAt.String()
101 if o.showKeyIDs {
102 table.AddCell(key.ID)
103 }
104 if isTTy {
105 createdAt = utils.TimeToPrettyTimeAgo(*key.CreatedAt)
106 }
107 table.AddRow(key.Title, key.Key, key.UsageType, cs.Gray(createdAt))
108 }
110 o.io.LogInfo(table.String())
112 return nil
113}
Diagnostics8 git calls · 206 ms
CallStatusSizeTime0206 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=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 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 · 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: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=0 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=44Open pack map
fetchtree:02001.8 KiB · hit0 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=0 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:0200289 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=289 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=1dd4ebf804b44e69b594244d57246af8b61f1ed3 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=289 git.pkt.payload.max=262 git.sideband.band1.bytes=262 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=262 git.pack.trailer=d2a3ec46393f5a5492eae3096186e74c059a8aafOpen 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=194 git.response.bytes=134 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=2e478a5e66b073a3c25b0d5887f2e5f736762674 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=32f419b2ad1d3f14972bb0261b2a67b9ecb35fb1Open pack map
fetch2001.3 KiB194 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1338 git.response.cache=MISS git.response.duration_ms=194 git.fetch.wants=d998303e5cd406b3f4897c79a814f0c6fa30a86b 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=1338 git.pkt.payload.max=1311 git.sideband.band1.bytes=1311 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
- a5e2c39afce6aedd
- Request
- 2035fb21…
- 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