GitLabgitlab-org
cli
main
1package get
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/api"
12 "gitlab.com/gitlab-org/cli/internal/cmdutils"
13 "gitlab.com/gitlab-org/cli/internal/iostreams"
14 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
15 "gitlab.com/gitlab-org/cli/internal/tableprinter"
16 "gitlab.com/gitlab-org/cli/internal/text"
17)
19type options struct {
20 io *iostreams.IOStreams
21 apiClient func(repoHost string) (*api.Client, error)
23 controllerID int64
24 outputFormat string
25}
27func NewCmd(f cmdutils.Factory) *cobra.Command {
28 opts := &options{
29 io: f.IO(),
30 apiClient: f.ApiClient,
31 }
33 cmd := &cobra.Command{
34 Use: "get <controller-id> [flags]",
35 Short: `Get details of a runner controller. (EXPERIMENTAL)`,
36 Long: heredoc.Docf(`
37 Retrieves details of a single runner controller, including its
38 connection status. This is an administrator-only feature.
39 %s`, text.ExperimentalString),
40 Args: cobra.ExactArgs(1),
41 Example: heredoc.Doc(`
42 # Get runner controller with ID 42
43 glab runner-controller get 42
45 # Get runner controller as JSON
46 glab runner-controller get 42 --output json`),
47 Annotations: map[string]string{
48 mcpannotations.Safe: "true",
49 },
50 RunE: func(cmd *cobra.Command, args []string) error {
51 if err := opts.complete(args); err != nil {
52 return err
53 }
54 return opts.run(cmd.Context())
55 },
56 }
58 fl := cmd.Flags()
59 fl.VarP(cmdutils.NewEnumValue([]string{"text", "json"}, "text", &opts.outputFormat), "output", "F", "Format output as: text, json.")
61 cmdutils.AddJQFlag(cmd, f.IO())
62 return cmd
63}
65func (o *options) complete(args []string) error {
66 id, err := cmdutils.ParseID(args[0], "runner controller ID")
67 if err != nil {
68 return err
69 }
70 o.controllerID = id
71 return nil
72}
74func (o *options) run(ctx context.Context) error {
75 apiClient, err := o.apiClient("")
76 if err != nil {
77 return err
78 }
79 client := apiClient.Lab()
81 controller, _, err := client.RunnerControllers.GetRunnerController(o.controllerID, gitlab.WithContext(ctx))
82 if err != nil {
83 return cmdutils.WrapError(err, "failed to get runner controller")
84 }
86 switch o.outputFormat {
87 case "json":
88 return o.io.PrintJSON(controller)
89 default:
90 return o.printDetails(controller)
91 }
92}
94func (o *options) printDetails(controller *gitlab.RunnerControllerDetails) error {
95 c := o.io.Color()
96 table := tableprinter.NewTablePrinter()
97 table.AddRow(c.Bold("ID"), controller.ID)
98 table.AddRow(c.Bold("Description"), controller.Description)
99 table.AddRow(c.Bold("State"), formatState(c, controller.State))
100 table.AddRow(c.Bold("Connected"), formatConnected(c, controller.Connected))
101 table.AddRow(c.Bold("Created At"), controller.CreatedAt)
102 table.AddRow(c.Bold("Updated At"), controller.UpdatedAt)
103 o.io.LogInfof("%s", table.Render())
104 return nil
105}
107func formatState(c *iostreams.ColorPalette, state gitlab.RunnerControllerStateValue) string {
108 switch state {
109 case gitlab.RunnerControllerStateDisabled:
110 return c.Gray(string(state))
111 case gitlab.RunnerControllerStateDryRun:
112 return c.Yellow(string(state))
113 case gitlab.RunnerControllerStateEnabled:
114 return c.Green(string(state))
115 default:
116 return string(state)
117 }
118}
120func formatConnected(c *iostreams.ColorPalette, connected bool) string {
121 if connected {
122 return c.Green("yes")
123 }
124 return c.Gray("no")
125}
Diagnostics8 git calls · 223 ms
CallStatusSizeTime0223 ms
discover200185 B5 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:0200323 B · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=14 git.response.bytes=323 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=8185a1b139a07a59fba10180a7318233adb22fc3 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=323 git.pkt.payload.max=296 git.sideband.band1.bytes=296 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=296 git.pack.trailer=ac106711ec2e15414437a5964de4b85c86703290Open pack map
fetchtree:0200134 B · hit14 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=198 git.response.bytes=134 git.response.cache=HIT git.response.duration_ms=14 git.fetch.filter=tree:0 git.fetch.wants=eecbe0edd6a945a3a73f70e431de4294f59885e2 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=995cd9c1e997abcf9bd74cdbc3c8e0eee234626fOpen pack map
fetch2001.3 KiB198 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1341 git.response.cache=MISS git.response.duration_ms=198 git.fetch.wants=b1ccf91472246ffb0c192d96697bf9a74865684d 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=1341 git.pkt.payload.max=1314 git.sideband.band1.bytes=1314 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
- a5e1d930fc24a151
- Request
- 23ffe735…
- 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