<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>doc_src/commands.rst - fork/fish-shell @ master</title>
<meta name="description" content="doc_src/commands.rst in fork/fish-shell at master.">
<meta property="og:title" content="doc_src/commands.rst - fork/fish-shell @ master">
<meta property="og:description" content="doc_src/commands.rst in fork/fish-shell at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="605c466379a074cf1b5cdb2b62bc8071aab8b47b">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/fish-shell</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/fish-shell</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Johannes Altmanninger</span><span class="commit-message" data-commit="7c27c1e7d0be2c7de8ad02fe190757bf4580959d">editorconfig / doc_src: trim trailing whitespace</span><span class="snapshot-sha sha" data-commit="7c27c1e7d0be2c7de8ad02fe190757bf4580959d">7c27c1e7d</span><time datetime="2025-11-30T06:24:39+01:00" title="2025-11-30 06:24:39 +0100">2025-11-30</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/fish-shell/ref/master/">master</a><a class="all" href="/fork/fish-shell/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/fish-shell/">fish-shell</a> / <a href="/fork/fish-shell/ref/master/tree/doc_src/">doc_src</a> / <span class="cur">commands.rst</span></nav>
<span class="view-stats"><span>5.2 KiB</span><span>99 lines</span></span><span class="actions"><a class="raw" href="/fork/fish-shell/raw/653fd02df1e8957f777281e8f275539487ff6c2d/doc_src/commands.rst">raw</a></span></header>
<pre class="code src"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text">Commands</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text">========</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">This is a list of all the commands fish ships with.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">Broadly speaking, these fall into a few categories:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">Keywords</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">^^^^^^^^</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">Core language keywords that make up the syntax, like</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">- :doc:`if &lt;cmds/if&gt;` and :doc:`else &lt;cmds/else&gt;` for conditions.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">- :doc:`for &lt;cmds/for&gt;` and :doc:`while &lt;cmds/while&gt;` for loops.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">- :doc:`break &lt;cmds/break&gt;` and :doc:`continue &lt;cmds/continue&gt;` to control loops.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">- :doc:`function &lt;cmds/function&gt;` to define functions.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">- :doc:`return &lt;cmds/return&gt;` to return a status from a function.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">- :doc:`begin &lt;cmds/begin&gt;` to begin a block and :doc:`end &lt;cmds/end&gt;` to end any block (including ifs and loops).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">- :doc:`and &lt;cmds/and&gt;`, :doc:`or &lt;cmds/or&gt;` and :doc:`not &lt;cmds/not&gt;` to combine commands logically.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">- :doc:`switch &lt;cmds/switch&gt;` and :doc:`case &lt;cmds/case&gt;` to make multiple blocks depending on the value of a variable.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">- :doc:`command &lt;cmds/command&gt;` or :doc:`builtin &lt;cmds/builtin&gt;` to tell fish what sort of thing to execute</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">- :doc:`time &lt;cmds/time&gt;` to time execution</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">- :doc:`exec &lt;cmds/exec&gt;` tells fish to replace itself with a command.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">- :doc:`end &lt;cmds/end&gt;` to end a block</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">Tools</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">^^^^^</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">Builtins to do a task, like</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">- :doc:`cd &lt;cmds/cd&gt;` to change the current directory.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text">- :doc:`echo &lt;cmds/echo&gt;` or :doc:`printf &lt;cmds/printf&gt;` to produce output.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">- :doc:`set_color &lt;cmds/set_color&gt;` to colorize output.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">- :doc:`set &lt;cmds/set&gt;` to set, query or erase variables.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text">- :doc:`read &lt;cmds/read&gt;` to read input.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text">- :doc:`string &lt;cmds/string&gt;` for string manipulation.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">- :doc:`path &lt;cmds/path&gt;` for filtering paths and handling their components.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text">- :doc:`math &lt;cmds/math&gt;` does arithmetic.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text">- :doc:`argparse &lt;cmds/argparse&gt;` to make arguments easier to handle.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text">- :doc:`count &lt;cmds/count&gt;` to count arguments.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text">- :doc:`type &lt;cmds/type&gt;` to find out what sort of thing (command, builtin or function) fish would call, or if it exists at all.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text">- :doc:`test &lt;cmds/test&gt;` checks conditions like if a file exists or a string is empty.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text">- :doc:`contains &lt;cmds/contains&gt;` to see if a list contains an entry.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">- :doc:`eval &lt;cmds/eval&gt;` and :doc:`source &lt;cmds/source&gt;` to run fish code from a string or file.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text">- :doc:`status &lt;cmds/status&gt;` to get shell information, like whether it's interactive or a login shell, or which file it is currently running.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text">- :doc:`abbr &lt;cmds/abbr&gt;` manages :ref:`abbreviations`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text">- :doc:`bind &lt;cmds/bind&gt;` to change bindings.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">- :doc:`complete &lt;cmds/complete&gt;` manages :ref:`completions &lt;tab-completion&gt;`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text">- :doc:`commandline &lt;cmds/commandline&gt;` to get or change the commandline contents.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text">- :doc:`fish_config &lt;cmds/fish_config&gt;` to easily change fish's configuration, like the prompt or colorscheme.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text">- :doc:`random &lt;cmds/random&gt;` to generate random numbers or pick from a list.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text">Known functions</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text">^^^^^^^^^^^^^^^^</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text">Known functions are a customization point. You can change them to change how your fish behaves. This includes:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text">- :doc:`fish_prompt &lt;cmds/fish_prompt&gt;` and :doc:`fish_right_prompt &lt;cmds/fish_right_prompt&gt;` and :doc:`fish_mode_prompt &lt;cmds/fish_mode_prompt&gt;` to print your prompt.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text">- :doc:`fish_command_not_found &lt;cmds/fish_command_not_found&gt;` to tell fish what to do when a command is not found.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">- :doc:`fish_title &lt;cmds/fish_title&gt;` to change the terminal's title.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text">- :doc:`fish_tab_title &lt;cmds/fish_tab_title&gt;` to change the terminal tab's title.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text">- :doc:`fish_greeting &lt;cmds/fish_greeting&gt;` to show a greeting when fish starts.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text">- :doc:`fish_should_add_to_history &lt;cmds/fish_should_add_to_history&gt;` to determine if a command should be added to history</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text">Helper functions</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text">^^^^^^^^^^^^^^^^</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text">Some helper functions, often to give you information for use in your prompt:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text">- :doc:`fish_git_prompt &lt;cmds/fish_git_prompt&gt;` and :doc:`fish_hg_prompt &lt;cmds/fish_hg_prompt&gt;` to print information about the current git or mercurial repository.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text">- :doc:`fish_vcs_prompt &lt;cmds/fish_vcs_prompt&gt;` to print information for either.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text">- :doc:`fish_svn_prompt &lt;cmds/fish_svn_prompt&gt;` to print information about the current svn repository.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text">- :doc:`fish_status_to_signal &lt;cmds/fish_status_to_signal&gt;` to give a signal name from a return status.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text">- :doc:`prompt_pwd &lt;cmds/prompt_pwd&gt;` to give the current directory in a nicely formatted and shortened way.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text">- :doc:`prompt_login &lt;cmds/prompt_login&gt;` to describe the current login, with user and hostname, and to explain if you are in a chroot or connected via ssh.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text">- :doc:`prompt_hostname &lt;cmds/prompt_hostname&gt;` to give the hostname, shortened for use in the prompt.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text">- :doc:`fish_is_root_user &lt;cmds/fish_is_root_user&gt;` to check if the current user is an administrator user like root.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text">- :doc:`fish_add_path &lt;cmds/fish_add_path&gt;` to easily add a path to $PATH.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text">- :doc:`alias &lt;cmds/alias&gt;` to quickly define wrapper functions (&quot;aliases&quot;).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text">- :doc:`fish_delta &lt;cmds/fish_delta&gt;` to show what you have changed from the default configuration.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text">- :doc:`export &lt;cmds/export&gt;` as a compatibility function for other shells.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text">Helper commands</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text">^^^^^^^^^^^^^^^</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text">fish also ships some things as external commands so they can be easily called from elsewhere.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text">This includes :doc:`fish_indent &lt;cmds/fish_indent&gt;` to format fish code and :doc:`fish_key_reader &lt;cmds/fish_key_reader&gt;` to show you what escape sequence a keypress produces.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text">The full list</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text">^^^^^^^^^^^^^</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text">And here is the full list:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text">.. toctree::</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text">   :glob:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text">   :maxdepth: 1</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text">   cmds/*</span></span></pre>
</main>
</body>
</html>
