Fish (Unix shell)

<h2 id="features">Features</h2>
<p>Fish displays <a href="/facts/Incremental_search/1cn56QBk">incremental suggestions</a> as the user types, based on command history and the current directory. This functions similarly to <a href="/facts/Bash_(Unix_shell)/RrYLtEJT">Bash</a>'s Ctrl+R history search, but is always on, giving the user continuous feedback while typing commands. Fish also includes feature-rich <a href="/facts/Command-line_completion/MFaxnWrl">tab completion</a>, with support for expanding file paths (with <a href="/facts/Wildcard_character/LErwSxvh">wildcards</a> and <a href="/facts/Bash_(Unix_shell)/RrYLtEJT">brace expansion</a>), <a href="/facts/Environment_variable/WxkrJQpP">environment variables</a>, and command-specific completions. Command-specific completions, including options with descriptions, can be to some extent generated from the commands' <a href="/facts/Man_page/S2yYjy0J">man pages</a>, but custom completions can also be included with software or written by users of the shell.<a class="footnote-ref" id="fnref:3" href="#fn:3"><sup>3</sup></a>
</p><p>The creator of Fish preferred to add new features as commands rather than syntax. This made features more <a href="/facts/Discoverability/DgccltrA">discoverable</a>, as the built-in features allow searching commands with options and help texts. <a href="/facts/Subroutine/9vFJrg0A">Functions</a> can also include human readable descriptions. A special <i>help</i> command gives access to all the fish documentation in the user's <a href="/facts/Web_browser/2pfyymLs">web browser</a>.<a class="footnote-ref" id="fnref:4" href="#fn:4"><sup>4</sup></a>
</p>
<h2 id="syntax">Syntax</h2>
<p>The syntax resembles a <a href="/facts/POSIX/mQkSt234">POSIX</a> compatible shell (such as Bash), but deviates in many ways<a class="footnote-ref" id="fnref:5" href="#fn:5"><sup>5</sup></a>
</p>
# Variable assignment
#
# Set the variable 'foo' to the value 'bar'. 
# Fish doesn't use the = operator, which is inherently whitespace sensitive. 
# The 'set' command extends to work with arrays, scoping, etc.

> set foo bar
> echo $foo
bar
 
# Command substitution
#
# Assign the output of the command 'pwd' into the variable 'wd'. 
# Fish doesn't use backticks (``), which can't be nested and may be confused with single quotes (' ').

> set wd (pwd)
> set wd $(pwd) # since version 3.4
> echo $wd
~

# Array variables. 'A' becomes an array with 5 values:
> set A 3 5 7 9 12
# Array slicing. 'B' becomes the first two elements of 'A':
> set B $A[1 2]
> echo $B
3 5
# You can index with other arrays and even command 
# substitution output:
> echo $A[(seq 3)]
3 5 7
# Erase the third and fifth elements of 'A'
> set --erase A[$B]
> echo $A
3 5 9

# for-loop, convert jpegs to pngs
> for i in *.jpg
      convert $i (basename $i .jpg).png
  end

# fish supports multi-line history and editing.
# Semicolons work like newlines:
> for i in *.jpg; convert $i (basename $i .jpg).png; end

# while-loop, read lines /etc/passwd and output the fifth 
# colon-separated field from the file. This should be
# the user description.
> while read line
      set arr (echo $line|tr : \n)
      echo $arr[5]
  end < /etc/passwd

# String replacement (replacing all i by I)
> string replace -a "i" "I" "Wikipedia"
WIkIpedIa

<h3>No implicit subshell</h3>
<p>Some language constructs, like <a href="/facts/Pipeline_(software)/vNahQdsH">pipelines</a>, <a href="/facts/Subroutine/9vFJrg0A">functions</a> and <a href="/facts/Control_flow/2XTDfErC">loops</a>, have been implemented using so called <a href="/facts/Child_process/qwBcoGAq">subshells</a> in other <a href="/facts/Shell_(computing)/Sa67elS7">shell</a> languages. Subshells are child programs that run a few commands in order to perform a task, then exit back to the parent shell. This implementation detail typically has the side effect that any state changes made in the subshell, such as variable assignments, do not propagate to the main shell. Fish never creates subshells for language features; all <a href="/facts/Shell_builtin/9o8PrWpa">builtins</a> happen within the parent shell.
</p>
# This will not work in many other shells, since the 'read' builtin
# will run in its own subshell. In Bash, the right side of the pipe
# can't have any side effects. In ksh, the below command works, but
# the left side can't have any side effects. In fish and zsh, both
# sides can have side effects.
> cat *.txt | read line

<h4>Variable assignment example</h4>
<p>This Bash example doesn't do what it seems: because the loop body is a subshell, the update to $found is not persistent.
</p>
found=''
cat /etc/fstab | while read dev mnt rest; do
  if test "$mnt" = "/"; then
    found="$dev"
  fi
done

<p>Workaround:
</p>
found=''
while read dev mnt rest; do
  if test "$mnt" = "/"; then
    found="$dev"
  fi
done < /etc/fstab

<p>Fish example:
</p>
set found ''
cat /etc/fstab | while read dev mnt rest
  if test "$mnt" = "/"
    set found $dev
  end
end

<h2 id="universal-variables">Universal variables</h2>
<p>Fish has a feature known as universal variables, which allows a user to permanently assign a value to a variable across all the user's running fish shells. The variable value is remembered across logouts and reboots, and updates are immediately propagated to all running shells.
</p>
# This will make emacs the default text editor. The '--universal' (or '-U') tells fish to
# make this a universal variable.
> set --universal EDITOR emacs

# This command will make the current working directory part of the fish
# prompt turn blue on all running fish instances.
> set --universal fish_color_cwd blue

<h2 id="other-features">Other features</h2>
<ul><li>Advanced tab completion (with support for writing custom completions).</li>
<li><a href="/facts/Syntax_highlighting/cLCr5a6w">Syntax highlighting</a> with extensive error checking.</li>
<li>Support for the <a href="/facts/X_Window_System/ac2vRIQL">X</a> <a href="/facts/Clipboard_(software)/CI8zUmP2">clipboard</a>.</li>
<li>Smart <a href="/facts/Computer_terminal/fSlx05qV">terminal</a> handling based on <a href="/facts/Terminfo/7lxnrBV0">terminfo</a>.</li>
<li>Searchable <a href="/facts/Command_history/nnyw8DFc">command history</a>.</li>
<li>Web-based configuration (<a href="https://fishshell.com/docs/current/cmds/fish_config.html">fish_config</a>).</li></ul>
<h2 id="bashfish-translation-table">Bash/fish translation table</h2>
<table><tbody><tr><th>Feature</th><th>Bash syntax</th><th>fish syntax</th><th>Comment</th></tr><tr><td>variable expansion:with word splitting and <a href="/facts/Glob_(programming)/IIPcqW8o">glob</a> interpretation</td><td>$var<p>or</p>${var[@]}<p>or</p>${var[*]}</td><td>deliberately omitted</td><td>Identified as a primary cause of bugs in posix compatible shell languages<a class="footnote-ref" id="fnref:6" href="#fn:6"><sup>6</sup></a></td></tr><tr><td>variable expansion:scalar</td><td>"$var"</td><td>deliberately omitted</td><td>Every variable is an array</td></tr><tr><td>variable expansion:array</td><td>"${var[@]}"</td><td>$var</td><td rowspan="2">Quoting not necessary to suppress word splitting and glob interpretation. Instead, quoting signifies serialization.</td></tr><tr><td>variable expansion:as a space separated string</td><td>"${var[*]}"</td><td>"$var"</td></tr><tr><td>edit line in text editor</td><td>Ctrl+X,Ctrl+E</td><td>Alt+E</td><td>Upon invocation, moves line input to a text editor</td></tr><tr><td>evaluate line input</td><td>Ctrl+Alt+E</td><td>—<a class="footnote-ref" id="fnref:7" href="#fn:7"><sup>7</sup></a></td><td>Evaluates expressions in-place on the line editor</td></tr><tr><td>history completion</td><td>Ctrl+R</td><td>implicit</td><td></td></tr><tr><td>history substitution</td><td>!!</td><td>deliberately omitted</td><td>Not discoverable</td></tr><tr><td>explicit subshell</td><td>(expression)</td><td>fish -c expression</td></tr><tr><td>command substitution</td><td>"$(expression)" </td><td><p>"$(expression)" or (expression | string collect)</p></td><td></td></tr><tr><td>process substitution</td><td><(expression)</td><td>(expression | psub)</td><td rowspan="5">Command, not syntax</td></tr><tr><td>logical operators</td><td>!cmd && echo FAIL || echo OK</td><td>not commandand echo FAILor echo OK</td></tr><tr><td>variable assignment</td><td>var=value </td><td>set var value</td></tr><tr><td>string processing:replace</td><td>"${HOME/alice/bob}"</td><td>string replace alice bob $HOME</td></tr><tr><td>string processing:remove prefix or suffix pattern, non-greedily or greedily</td><td>var=a.b.c"${var#*.}"  #b.c"${var##*.}" #c"${var%.*}"  #a.b"${var%%.*}" #a</td><td>string replace --regex '.*?\.(.*)' '$1' a.b.c #b.cstring replace --regex '.*\.(.*)' '$1' a.b.c  #cstring replace --regex '(.*)\..*' '$1' a.b.c  #a.bstring replace --regex '(.*?)\..*' '$1' a.b.c #a</td></tr><tr><td>export variable</td><td>export var </td><td>set --export var </td><td rowspan="5">Options discoverable via tab completion</td></tr><tr><td>function-local variable</td><td>local var</td><td>by default</td></tr><tr><td>scope-local variable</td><td>no equivalent</td><td>set --local var</td></tr><tr><td>remove variable</td><td>unset var </td><td>set --erase var </td></tr><tr><td>check if a variable exists</td><td>test -v var</td><td>set --query var</td></tr><tr><td>array initialization</td><td>var=( a b c ) </td><td>set var a b c</td><td rowspan="6">Every variable is an array</td></tr><tr><td>array iteration</td><td>for i in "${var[@]}"; do  echo "$i"done</td><td>for i in $var  echo $iend</td></tr><tr><td>argument vector:all arguments</td><td>"$@" </td><td>$argv </td></tr><tr><td>argument vector:indexing</td><td>"$1" </td><td>$argv[1] </td></tr><tr><td>argument vector:length</td><td>$#</td><td>(count $argv)</td></tr><tr><td>argument vector:shift</td><td>shift</td><td>set --erase argv[1]</td></tr><tr><td>array representation in environment variables</td><td>PATH="$PATH:$HOME/.local/bin"</td><td>set PATH $PATH $HOME/.local/bin</td><td>fish assumes colon as array delimiter for translating variables to and from the environment. This aligns with many array-like environment variables, like $PATH and $LS_COLORS.</td></tr><tr><td>export and run</td><td>LANG=C.UTF-8 python3 </td><td>env LANG=C.UTF-8 python3</td><td>env LANG=C.UTF-8 python3 works in any shell, as env is a standalone program.</td></tr><tr><td>arithmetic</td><td>$((10/3))</td><td>math '10/3'</td><td>expr 10 / 3 works in any shell, as expr is a standalone program.</td></tr><tr><td><a href="/facts/String_literal/Fj41vtVm">escape sequence</a></td><td>$'\e'</td><td>\e </td><td>printf '\e' works in both shells; their printf builtins are both compatible with the GNU printf standalone program.<a class="footnote-ref" id="fnref:8" href="#fn:8"><sup>8</sup></a></td></tr><tr><td>single quoted string:escape sequences</td><td>'mom'\''s final backslash: \'</td><td>'mom\'s final backslash: \\'</td><td>Bash only requires replacement of the single quote itself in single quoted strings, but the replacement is 4 characters long. The same replacement works in fish, but fish supports a regular escape sequence for this, thus requires escaping backslashes too (except permits single backslashes that don't precede another backslash or single quote).</td></tr></tbody></table>
<h2 id="see-also">See also</h2>
<ul>
<li>Free and open-source software portal</li></ul>
<ul><li><a href="/facts/Comparison_of_command_shells/VjrMgygY">Comparison of command shells</a></li>
<li><a href="/facts/Unix/0pNL2seI">Unix</a></li></ul>

<h2 id="external-links">External links</h2>
<ul><li><a href="https://fishshell.com">Official website</a>  – containing documentation and downloads</li>
<li><a href="https://github.com/fish-shell/fish-shell">fish</a> on <a href="/facts/GitHub/n1hNCsc3">GitHub</a> (active)</li>
<li><a href="https://web.archive.org/web/20110726104750/http://gitorious.org/fish-shell/">fish</a> on <a href="/facts/Gitorious/6GJkbTQV">Gitorious</a> (obsolete)</li>
<li><a href="http://sourceforge.net/projects/fish/">fish</a> on <a href="/facts/SourceForge/lxYAgUAX">SourceForge</a> (obsolete)</li>
<li><a href="https://lists.sourceforge.net/lists/listinfo/fish-users">Fish-users</a> – general discussion list for fish users</li>
<li><a href="https://github.com/fish-shell/fish-shell/wiki/Shell-Translation-Dictionary">Shell Translation Dictionary</a> - another Bash/Fish translation table</li></ul>

<h2 id="references">References</h2>

<ol>
<li id="fn:1"><p>Liljencrantz, Axel (2005-05-17). "Fish - A user-friendly shell". Linux Weekly News. Retrieved 2010-03-24. <a href="https://lwn.net/Articles/136232" target="_blank">https://lwn.net/Articles/136232</a> <a href="#fnref:1" class="footnote-back-ref">↩</a></p></li>
<li id="fn:2"><p>"Fish docs: design". Retrieved 2021-04-09. <a href="https://fishshell.com/docs/current/design.html" target="_blank">https://fishshell.com/docs/current/design.html</a> <a href="#fnref:2" class="footnote-back-ref">↩</a></p></li>
<li id="fn:3"><p>"Writing your own completions". fish shell. Archived from the original on 2024-08-31. <a href="https://fishshell.com/docs/current/completions.html" target="_blank">https://fishshell.com/docs/current/completions.html</a> <a href="#fnref:3" class="footnote-back-ref">↩</a></p></li>
<li id="fn:4"><p>Linux.com. CLI Magic: Enhancing the shell with fish. Retrieved 2010-03-24. <a href="https://www.linux.com/news/cli-magic-enhancing-shell-fish" target="_blank">https://www.linux.com/news/cli-magic-enhancing-shell-fish</a> <a href="#fnref:4" class="footnote-back-ref">↩</a></p></li>
<li id="fn:5"><p>Paul, Ryan (19 December 2005). "An in-depth look at fish: the friendly interactive shell". Ars Technica. Retrieved 10 March 2015. the Posix syntax has several missing or badly implemented features, including variable scoping, arrays, and functions. For this reason, fish strays from the Posix syntax in several important places. <a href="https://arstechnica.com/information-technology/2005/12/linux-20051218/2/" target="_blank">https://arstechnica.com/information-technology/2005/12/linux-20051218/2/</a> <a href="#fnref:5" class="footnote-back-ref">↩</a></p></li>
<li id="fn:6"><p>"Bash Pitfalls". Retrieved 2016-07-10. This page shows common errors that Bash programmers make. (...) You will save yourself from many of these pitfalls if you simply always use quotes and never use word splitting for any reason! Word splitting is a broken legacy misfeature inherited from the Bourne shell that's stuck on by default if you don't quote expansions. The vast majority of pitfalls are in some way related to unquoted expansions, and the ensuing word splitting and globbing that result. <a href="http://mywiki.wooledge.org/BashPitfalls" target="_blank">http://mywiki.wooledge.org/BashPitfalls</a> <a href="#fnref:6" class="footnote-back-ref">↩</a></p></li>
<li id="fn:7"><p>"RFC: Add binding to expand/evaluate tokens on commandline". GitHub. 2013-05-16. Retrieved 2021-04-09. <a href="https://github.com/fish-shell/fish-shell/issues/751" target="_blank">https://github.com/fish-shell/fish-shell/issues/751</a> <a href="#fnref:7" class="footnote-back-ref">↩</a></p></li>
<li id="fn:8"><p>"printf does not support \e". fish issues. 11 Jul 2013. Retrieved 24 March 2016. <a href="https://github.com/fish-shell/fish-shell/issues/910" target="_blank">https://github.com/fish-shell/fish-shell/issues/910</a> <a href="#fnref:8" class="footnote-back-ref">↩</a></p></li>
</ol>

Fish (Unix shell) open-in-new

Fish (Unix shell)