blob: fb795ddc85175bee0d98f870b1ad544ba883d77f (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
# fish(1)
## Quick Info
Fish initialization file `~/.config/fish/config.fish`
Switch between different key bindings:
- `fish_default_key_bindings` to use default key bindings
- `fish_vi_key_bindings` to use vi key bindings
## Variables
Available scopes
- `local` variable local to a block
- `global` variable global to shell instance
- `universal` variable universal to all shell instances + preserved across
shell restart
### Set/Unset Variables
```text
set <name> [<values>]
-l local scope
-g global scope
-U universal scope
-e erase variable
-S show verbose info
-x export to ENV
-u unexport from ENV
```
### Lists
In `fish` all variables are lists (start with index `1`, but lists can't
contain lists.
```text
set foo a b c d
echo $foo[1] # a
echo $foo[-1] # d
echo $foo[2..3] # b c
echo $foo[1 3] # a c
```
`$` can be seen as dereference operator.
```text
set foo a; set a 1337
echo $$foo # outputs 1337
```
Cartesian product.
```text
echo file.{h,cc}
# file.h file.cc
echo {a,b}{1,2}
# a1 b1 a2 b2
```
### Special Variables (Lists)
```text
$status # exit code of last command
$pipestatus # list of exit codes of pipe chain
$CMD_DURATION # runtime of last command in ms
```
#### `*PATH`
Lists ending with `PATH` are automatically split at `:` when used and joined
with `:` when exported to the environment.
```text
set -x BLA_PATH a:b:c:d
echo $BLA_PATH # a b c d
env | grep BLA_PATH # BLA_PATH=a:b:c:d
```
## Command Handling
```text
# sub-commands are not run in quotes
echo "ls output: "(ls)
```
### I/O redirection
```text
# 'noclobber', fail if 'log' already exists
echo foo >? log
```
## Control Flow
### `if` / `else`
```text
if grep foo bar
# do sth
else if grep foobar bar
# do sth else
else
# do sth else
end
```
### `switch`
```text
switch (echo foo)
case 'foo*'
# do start with foo
case bar dudel
# do bar and dudel
case '*'
# do else
end
```
### `while` Loop
```text
while true
echo foo
end
```
### `for` Loop
```text
for f in (ls)
echo $f
end
```
## Functions
Function arguments are passed via `$argv` list.
```text
function fn_foo
echo $argv
end
```
### Autoloading
When running a command fish attempts to autoload a function. The shell looks
for `<cmd>.fish` in the locations defined by `$fish_function_path` and loads
the function lazily if found.
This is the preferred way over monolithically defining all functions in a
startup script.
### Helper
```text
functions # list al functions
functions foo # describe function 'foo'
functions -e foo # erase function 'foo'
funced foo # edit function 'foo'
# '-e vim' to edit in vim
```
## Prompt
The prompt is defined by the output of the `fish_prompt` function.
```text
function fish_prompt
set -l cmd_ret
echo "> "(pwd) $cmd_ret" "
end
```
> Use `set_color` to manipulate terminal colors.
## Useful Builtins
```text
# history
history search <str> # search history for <str>
history merge # merge histories from fish sessions
# list
count $var # count elements in list
# string
string split SEP STRING
```
## Keymaps
```text
Shift-Tab ........... tab-completion with search
Alt-Up / Alt-Down ... search history with token under the cursor
Alt-l ............... list content of dir under cursor
Alt-p ............... append '2>&1 | less;' to current cmdline
```
## Debug
```text
status print-stack-trace .. prints function stacktrace (can be used in scripts)
breakpoint ................ halt script execution and gives shell (C-d | exit
to continue)
```
|
