GitLabgitlab-org
cli
main
1package completion
3import (
4 "fmt"
6 "github.com/MakeNowJust/heredoc/v2"
7 "github.com/spf13/cobra"
9 "gitlab.com/gitlab-org/cli/internal/iostreams"
10 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
11)
13func NewCmdCompletion(io *iostreams.IOStreams) *cobra.Command {
14 var (
15 shellType string
17 // description will not be added if true
18 excludeDesc = false
19 )
21 completionCmd := &cobra.Command{
22 Use: "completion",
23 Short: "Generate shell completion scripts.",
24 Long: heredoc.Docf(`
25 This command outputs code meant to be saved to a file, or immediately
26 evaluated by an interactive shell. To load completions:
28 ### Bash
30 To load completions in your current shell session:
32 %[2]sshell
33 source <(glab completion -s bash)
34 %[2]s
36 To load completions for every new session, run this command one time:
38 #### Linux
40 %[2]sshell
41 glab completion -s bash > /etc/bash_completion.d/glab
42 %[2]s
44 #### macOS
46 %[2]sshell
47 glab completion -s bash > /usr/local/etc/bash_completion.d/glab
48 %[2]s
50 ### Zsh
52 If shell completion is not already enabled in your environment you must
53 enable it. Run this command one time:
55 %[2]sshell
56 echo "autoload -U compinit; compinit" >> ~/.zshrc
57 %[2]s
59 To load completions in your current shell session:
61 %[2]sshell
62 source <(glab completion -s zsh); compdef _glab glab
63 %[2]s
65 To load completions for every new session, run this command one time:
67 #### Linux
69 %[2]sshell
70 glab completion -s zsh > "${fpath[1]}/_glab"
71 %[2]s
73 #### macOS
75 For older versions of macOS, you might need this command:
77 %[2]sshell
78 glab completion -s zsh > /usr/local/share/zsh/site-functions/_glab
79 %[2]s
81 The Homebrew version of glab should install completions automatically.
83 ### fish
85 To load completions in your current shell session:
87 %[2]sshell
88 glab completion -s fish | source
89 %[2]s
91 To load completions for every new session, run this command one time:
93 %[2]sshell
94 glab completion -s fish > ~/.config/fish/completions/glab.fish
95 %[2]s
97 ### PowerShell
99 To load completions in your current shell session:
101 %[2]sshell
102 glab completion -s powershell | Out-String | Invoke-Expression
103 %[2]s
105 To load completions for every new session, add the output of the above command
106 to your PowerShell profile.
108 When installing glab through a package manager, however, you might not need
109 more shell configuration to support completions.
110 For Homebrew, see [brew shell completion](https://docs.brew.sh/Shell-Completion)
111 `, "`", "```"),
112 Example: heredoc.Doc(`
113 # Load completions in the current zsh session
114 source <(glab completion -s zsh); compdef _glab glab
116 # Print the bash completion script
117 glab completion -s bash`),
118 Args: cobra.NoArgs,
119 ValidArgsFunction: cobra.NoFileCompletions,
120 Annotations: map[string]string{
121 mcpannotations.Exclude: "true",
122 },
123 RunE: func(cmd *cobra.Command, args []string) error {
124 out := io.StdOut
125 rootCmd := cmd.Parent()
127 switch shellType {
128 case "bash":
129 return rootCmd.GenBashCompletionV2(out, !excludeDesc)
130 case "zsh":
131 if excludeDesc {
132 return rootCmd.GenZshCompletionNoDesc(out)
133 }
134 return rootCmd.GenZshCompletion(out)
135 case "powershell":
136 if excludeDesc {
137 return rootCmd.GenPowerShellCompletion(out)
138 }
139 return rootCmd.GenPowerShellCompletionWithDesc(out)
140 case "fish":
141 return rootCmd.GenFishCompletion(out, !excludeDesc)
142 default:
143 return fmt.Errorf("unsupported shell type %q", shellType)
144 }
145 },
146 }
148 completionCmd.Flags().StringVarP(&shellType, "shell", "s", "bash", "Shell type: bash, zsh, fish, powershell.")
149 completionCmd.Flags().BoolVarP(&excludeDesc, "no-desc", "", false, "Do not include shell completion description.")
150 return completionCmd
151}
Diagnostics7 git calls · 222 ms
CallStatusSizeTime0222 ms
discover200185 B2 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=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=fb03183b7909876778f740d196d7516811003517Open pack map
fetchtree:0200141 B · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=211 git.response.bytes=141 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=e5835cf798680bd01d4e28781c86c55fee5f6735 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=141 git.pkt.payload.max=114 git.sideband.band1.bytes=114 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=114 git.pack.trailer=6fc1b1903c528fda8b455fd927ca640d9a5ede46Open pack map
fetch2001.4 KiB211 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1409 git.response.cache=MISS git.response.duration_ms=211 git.fetch.wants=3be851001771a3ce41616b40ab0653cb091d4c0d 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=1409 git.pkt.payload.max=1382 git.sideband.band1.bytes=1382 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
- a5e1eaab7dd7452a
- Request
- a78d8788…
- 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