GitLabgitlab-org

cli

main
ply7 git calls34 ms98 KiB5 cachedprotocol v2
72 lines2.1 KiBRaw

Set an alias for a longer command.

Synopsis

Declare a word as an alias for a longer command.

Use quotation marks when you define a command, as shown in the examples.

Your expansion can include arguments and flags. If your expansion includes positional placeholders such as $1 or $2, any extra arguments that follow the invocation of the alias are inserted into those placeholders.

To run an alias through sh, a shell converter, specify the --shell flag. With shell conversion, you can compose commands with | or redirect with >. Shell aliases have these caveats:

  • Extra arguments that follow the alias are not passed to the expansion. To accept arguments, use $1, $2, and so on.
  • To accept all arguments, use $@.

On Windows, shell aliases run through sh as installed by Git for Windows. If you installed Git in another way on Windows, shell aliases might not work.

plaintext
glab alias set <alias name> '<command>' [flags]

Examples

console
# Define an alias for "mr view"
glab alias set mrv 'mr view'
# Run the alias; it expands to "glab mr view -w 123"
glab mrv -w 123

# Define an alias with a positional placeholder
glab alias set createissue 'issue create --title "$1"'
# Run the alias with an argument and an extra flag
glab createissue "My Issue" --description "Something is broken."

# Define a shell alias that pipes glab output to grep
glab alias set --shell igrep 'glab issue list --assignee="$1" | grep $2'
# Run the shell alias with two arguments
glab igrep user foo

Options

plaintext
  -s, --shell   Declare an alias to be passed through a shell interpreter.

Options inherited from parent commands

plaintext
  -h, --help   Show help for this command.
1---
2title: '`glab alias set`'
3stage: AI Clients
4group: Developer Clients
5info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/marketing/product-and-technical-marketing/technical-writing/#assignments>
6---
8<!--
9This documentation is auto generated by a script.
10Please do not edit this file directly. Run `make gen-docs` instead.
11-->
13Set an alias for a longer command.
15## Synopsis
17Declare a word as an alias for a longer command.
19Use quotation marks when you define a command, as shown in the examples.
21Your expansion can include arguments and flags. If your expansion
22includes positional placeholders such as `$1` or `$2`, any extra
23arguments that follow the invocation of the alias are inserted into
24those placeholders.
26To run an alias through `sh`, a shell converter, specify the
27`--shell` flag. With shell conversion, you can compose commands
28with `|` or redirect with `>`. Shell aliases have these caveats:
30- Extra arguments that follow the alias are not passed to the expansion.
31 To accept arguments, use `$1`, `$2`, and so on.
32- To accept all arguments, use `$@`.
34On Windows, shell aliases run through `sh` as installed by Git for
35Windows. If you installed Git in another way on Windows, shell aliases
36might not work.
38```plaintext
39glab alias set <alias name> '<command>' [flags]
40```
42## Examples
44```console
45# Define an alias for "mr view"
46glab alias set mrv 'mr view'
47# Run the alias; it expands to "glab mr view -w 123"
48glab mrv -w 123
50# Define an alias with a positional placeholder
51glab alias set createissue 'issue create --title "$1"'
52# Run the alias with an argument and an extra flag
53glab createissue "My Issue" --description "Something is broken."
55# Define a shell alias that pipes glab output to grep
56glab alias set --shell igrep 'glab issue list --assignee="$1" | grep $2'
57# Run the shell alias with two arguments
58glab igrep user foo
60```
62## Options
64```plaintext
65 -s, --shell Declare an alias to be passed through a shell interpreter.
66```
68## Options inherited from parent commands
70```plaintext
71 -h, --help Show help for this command.
72```
Diagnostics7 git calls · 34 ms
CallStatusSizeTime034 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=4
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 · 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=4273
git.response.cache=HIT
git.response.duration_ms=4
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.7 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=1744
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=5e4007a5673eb3bf5d0d7f1a1463c3b2ca3fb3bd
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=1744
git.pkt.payload.max=1717
git.sideband.band1.bytes=1717
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1717
git.pack.trailer=3f1b9ccc7756e8941d6705e8187c87fd922113e6
Open pack map
fetchtree:0200196 B · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=24
git.response.bytes=196
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=8fbc55bb8746a8fb24c4ff48dc2219698080b86c
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=196
git.pkt.payload.max=169
git.sideband.band1.bytes=169
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=169
git.pack.trailer=9e88aa21a65cd91d08f1265c673cfe787e393d72
Open pack map
fetch2001.0 KiB · hit24 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1071
git.response.cache=HIT
git.response.duration_ms=24
git.fetch.wants=d4bd342c96ac9450a805f0f77c3de3cf9cbfa94b
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=1071
git.pkt.payload.max=1044
git.sideband.band1.bytes=1044
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
a5e1280c99927fd8
Request
4cb5e989…
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