GitLabgitlab-org

cli

main
ply8 git calls332 ms99 KiB6 cachedprotocol v2
135 lines3.1 KiBRaw
1package add
3import (
4 "errors"
5 "io"
6 "os"
8 "github.com/MakeNowJust/heredoc/v2"
9 "github.com/spf13/cobra"
11 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
13 "gitlab.com/gitlab-org/cli/internal/cmdutils"
14 "gitlab.com/gitlab-org/cli/internal/glrepo"
15 "gitlab.com/gitlab-org/cli/internal/iostreams"
16 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
19type options struct {
20 gitlabClient func() (*gitlab.Client, error)
21 io *iostreams.IOStreams
22 baseRepo func() (glrepo.Interface, error)
24 title string
25 key string
26 expiresAt string
27 canPush bool
29 keyFile string
32func NewCmdAdd(f cmdutils.Factory) *cobra.Command {
33 opts := &options{
34 io: f.IO(),
35 gitlabClient: f.GitLabClient,
36 baseRepo: f.BaseRepo,
37 }
38 cmd := &cobra.Command{
39 Use: "add [key-file]",
40 Short: "Add a deploy key to a GitLab project.",
41 Long: heredoc.Doc(`
42 Creates a new deploy key.
44 Requires the '--title' flag.
45 `),
46 Example: heredoc.Doc(`
47 # Read deploy key from stdin and upload.
48 glab deploy-key add -t "my title"
50 # Read deploy key from specified key file and upload
51 cat ~/.ssh/id_ed25519.pub | glab deploy-key add --title='test' -
53 # Read deploy key from specified key file, upload and set "can push" attribute.
54 glab deploy-key add ~/.ssh/id_ed25519.pub -t "my title" --can-push true`),
55 Args: cobra.MaximumNArgs(1),
56 Annotations: map[string]string{
57 mcpannotations.Destructive: "true",
58 },
59 RunE: func(cmd *cobra.Command, args []string) error {
60 if err := opts.complete(args); err != nil {
61 return err
62 }
64 return opts.run()
65 },
66 }
68 cmd.Flags().StringVarP(&opts.title, "title", "t", "", "New deploy key's title.")
69 cmd.Flags().BoolVarP(&opts.canPush, "can-push", "c", false, "If true, deploy keys can be used for pushing code to the repository.")
70 cmd.Flags().StringVarP(&opts.expiresAt, "expires-at", "e", "", "The expiration date of the deploy key, using the ISO-8601 format: YYYY-MM-DDTHH:MM:SSZ.")
72 _ = cmd.MarkFlagRequired("title")
74 return cmd
77func (o *options) complete(args []string) error {
78 if len(args) == 0 {
79 if o.io.IsInteractive() {
80 return &cmdutils.FlagError{Err: errors.New("missing key file")}
81 }
82 o.keyFile = "-"
83 } else {
84 o.keyFile = args[0]
85 }
87 return nil
90func (o *options) run() error {
91 client, err := o.gitlabClient()
92 if err != nil {
93 return err
94 }
96 var keyFileReader io.Reader
97 if o.keyFile == "-" {
98 keyFileReader = o.io.In
99 defer o.io.In.Close()
100 } else {
101 f, err := os.Open(o.keyFile)
102 if err != nil {
103 return err
104 }
105 defer f.Close()
107 keyFileReader = f
108 }
110 keyInBytes, err := io.ReadAll(keyFileReader)
111 if err != nil {
112 return cmdutils.WrapError(err, "failed to read deploy key file.")
113 }
115 o.key = string(keyInBytes)
117 baseRepo, err := o.baseRepo()
118 if err != nil {
119 return err
120 }
122 err = UploadDeployKey(client, baseRepo.FullName(), o.title, o.key, o.canPush, o.expiresAt)
123 if err != nil {
124 return cmdutils.WrapError(err, "failed to add new deploy key.")
125 }
127 if o.io.IsOutputTTY() {
128 cs := o.io.Color()
129 o.io.LogInfof("%s New deploy key added.\n", cs.GreenCheck())
130 } else {
131 o.io.LogInfo("New deploy key added.\n")
132 }
134 return nil
Diagnostics8 git calls · 332 ms
CallStatusSizeTime0332 ms
discover200185 B3 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 KiB · hit3 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=HIT
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
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=2
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=44
Open 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=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:02001.8 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=1857
git.response.cache=HIT
git.response.duration_ms=3
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=fb03183b7909876778f740d196d7516811003517
Open 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=2
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=e13cfdecc4907e32538df2da5c8a114f27dcffd1
Open pack map
fetchtree:0200197 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=197
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=20fdd2a1a0b305f7513b8bf53ba13c3e020a10b0
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=197
git.pkt.payload.max=170
git.sideband.band1.bytes=170
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=170
git.pack.trailer=022508b671f3045ee2c61f4a26ede0c79df6615b
Open pack map
fetch2001.4 KiB318 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=318
git.response.bytes=1403
git.response.cache=MISS
git.response.duration_ms=318
git.fetch.wants=987fe9dd17ec358eac7a11621c4c882054da4546
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
a5eafa41cd34b1bb
Request
37aff3fe…
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