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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
|
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Writing your own prompt — fish-shell 4.2.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4da8bbd6" />
<link rel="stylesheet" type="text/css" href="_static/pydoctheme.css?v=f89b4716" />
<script src="_static/documentation_options.js?v=6fb65176"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Design" href="design.html" />
<link rel="prev" title="Writing your own completions" href="completions.html" />
<link rel="shortcut icon" type="image/png" href="_static/fish.png" />
</head><body><div id="fmain">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li><img src="_static/fish.png" alt=""
style="width: 80px; height: 80px; vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://fishshell.com/">fish-shell</a> »</li>
<a href="index.html">fish-shell 4.2.1 documentation</a> »
<li class="nav-item nav-item-this"><a href="">Writing your own prompt</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="search.html" method="get">
<input placeholder="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</li>
<div id="old-docs-notice" style="display: none">
This documents an old version of fish.
<a href="../current/">See the latest release.</a>
</div>
</ul>
</div>
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Documents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently asked questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="interactive.html">Interactive use</a></li>
<li class="toctree-l1"><a class="reference internal" href="language.html">The fish language</a></li>
<li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="fish_for_bash_users.html">Fish for bash users</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="completions.html">Writing your own completions</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Writing your own prompt</a></li>
<li class="toctree-l1"><a class="reference internal" href="design.html">Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="relnotes.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="terminal-compatibility.html">Terminal Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing To Fish</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h4><a href="index.html">Sections</a></h4>
<ul>
<li><a class="reference internal" href="#">Writing your own prompt</a><ul>
<li><a class="reference internal" href="#our-first-prompt">Our first prompt</a></li>
<li><a class="reference internal" href="#formatting">Formatting</a></li>
<li><a class="reference internal" href="#adding-color">Adding color</a></li>
<li><a class="reference internal" href="#shortening-the-working-directory">Shortening the working directory</a></li>
<li><a class="reference internal" href="#status">Status</a></li>
<li><a class="reference internal" href="#transient-prompt">Transient prompt</a></li>
<li><a class="reference internal" href="#save-the-prompt">Save the prompt</a></li>
<li><a class="reference internal" href="#where-to-go-from-here">Where to go from here?</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="writing-your-own-prompt">
<h1>Writing your own prompt<a class="headerlink" href="#writing-your-own-prompt" title="Link to this heading">¶</a></h1>
<p>Fish ships a number of prompts that you can view with the <a class="reference internal" href="cmds/fish_config.html"><span class="doc">fish_config</span></a> command, and many users have shared their prompts online.</p>
<p>However, you can also write your own, or adjust an existing prompt. This is a good way to get used to fish’s <a class="reference internal" href="language.html"><span class="doc">scripting language</span></a>.</p>
<p>Unlike other shells, fish’s prompt is built by running a function - <a class="reference internal" href="cmds/fish_prompt.html"><span class="doc">fish_prompt</span></a>. Or, more specifically, three functions:</p>
<ul class="simple">
<li><p><a class="reference internal" href="cmds/fish_prompt.html"><span class="doc">fish_prompt</span></a>, which is the main prompt function</p></li>
<li><p><a class="reference internal" href="cmds/fish_right_prompt.html"><span class="doc">fish_right_prompt</span></a>, which is shown on the right side of the terminal.</p></li>
<li><p><a class="reference internal" href="cmds/fish_mode_prompt.html"><span class="doc">fish_mode_prompt</span></a>, which is shown if <a class="reference internal" href="interactive.html#vi-mode"><span class="std std-ref">vi mode</span></a> is used.</p></li>
</ul>
<p>These functions are run, and whatever they print is displayed as the prompt (minus one trailing newline).</p>
<p>Here, we will just be writing a simple fish_prompt.</p>
<section id="our-first-prompt">
<h2>Our first prompt<a class="headerlink" href="#our-first-prompt" title="Link to this heading">¶</a></h2>
<p>Let’s look at a very simple example:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">function</span><span class="w"> </span><span class="no">fish_prompt</span>
<span class="w"> </span><span class="nf">echo</span><span class="w"> </span><span class="o">$PWD</span><span class="w"> </span><span class="s1">'>'</span>
<span class="nf">end</span>
</pre></div>
</div>
<p>This prints the current working directory (<span class="target" id="index-0"></span><a class="reference internal" href="language.html#envvar-PWD"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PWD</span></code></a>) and a <code class="docutils literal notranslate"><span class="pre">></span></code> symbol to show where the prompt ends. The <code class="docutils literal notranslate"><span class="pre">></span></code> is <a class="reference internal" href="language.html#quotes"><span class="std std-ref">quoted</span></a> because otherwise it would signify a <a class="reference internal" href="language.html#redirects"><span class="std std-ref">redirection</span></a>.</p>
<p>Because we’ve used <a class="reference internal" href="cmds/echo.html"><span class="doc">echo</span></a>, it adds spaces between the two so it ends up looking like (assuming <code class="docutils literal notranslate"><span class="pre">_</span></code> is your cursor):</p>
<pre class="highlight literal-block"><span class="white">/home/tutorial ></span>_</pre>
</section>
<section id="formatting">
<h2>Formatting<a class="headerlink" href="#formatting" title="Link to this heading">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">echo</span></code> adds spaces between its arguments. If you don’t want those, you can use <a class="reference internal" href="cmds/string-join.html"><span class="doc">string join</span></a> like this:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">function</span><span class="w"> </span><span class="no">fish_prompt</span>
<span class="w"> </span><span class="nf">string</span><span class="w"> </span><span class="no">join</span><span class="w"> </span><span class="s1">''</span><span class="w"> </span><span class="no">--</span><span class="w"> </span><span class="o">$PWD</span><span class="w"> </span><span class="s1">'>'</span>
<span class="nf">end</span>
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">--</span></code> indicates to <code class="docutils literal notranslate"><span class="pre">string</span></code> that no options can come after it, in case we extend this with something that can start with a <code class="docutils literal notranslate"><span class="pre">-</span></code>.</p>
<p>There are other ways to remove the space, including <code class="docutils literal notranslate"><span class="pre">echo</span> <span class="pre">-s</span></code> and <a class="reference internal" href="cmds/printf.html"><span class="doc">printf</span></a>.</p>
</section>
<section id="adding-color">
<h2>Adding color<a class="headerlink" href="#adding-color" title="Link to this heading">¶</a></h2>
<p>This prompt is functional, but a bit boring. We could add some color.</p>
<p>Fortunately, fish offers the <a class="reference internal" href="cmds/set_color.html"><span class="doc">set_color</span></a> command, so you can do:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">echo</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">red</span><span class="o">)</span><span class="no">foo</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">set_color</span></code> can also handle RGB colors like <code class="docutils literal notranslate"><span class="pre">set_color</span> <span class="pre">23b455</span></code>, and other formatting options including bold and italics.</p>
<p>So, taking our previous prompt and adding some color:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">function</span><span class="w"> </span><span class="no">fish_prompt</span>
<span class="w"> </span><span class="nf">string</span><span class="w"> </span><span class="no">join</span><span class="w"> </span><span class="s1">''</span><span class="w"> </span><span class="no">--</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">green</span><span class="o">)</span><span class="w"> </span><span class="o">$PWD</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">normal</span><span class="o">)</span><span class="w"> </span><span class="s1">'>'</span>
<span class="nf">end</span>
</pre></div>
</div>
<p>A “normal” color tells the terminal to go back to its normal formatting options.</p>
<p><code class="docutils literal notranslate"><span class="pre">set_color</span></code> works by producing an escape sequence, which is a special piece of text that terminals
interpret as instructions - for example, to change color. So <code class="docutils literal notranslate"><span class="pre">set_color</span> <span class="pre">red</span></code> produces the same
effect as:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">echo</span><span class="w"> </span><span class="se">\e\[</span><span class="no">31m</span>
</pre></div>
</div>
<p>Although you can write your own escape sequences by hand, it’s much easier to use <code class="docutils literal notranslate"><span class="pre">set_color</span></code>.</p>
</section>
<section id="shortening-the-working-directory">
<h2>Shortening the working directory<a class="headerlink" href="#shortening-the-working-directory" title="Link to this heading">¶</a></h2>
<p>This is fine, but our <span class="target" id="index-1"></span><a class="reference internal" href="language.html#envvar-PWD"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PWD</span></code></a> can be a bit long, and we are typically only interested in the last few directories. We can shorten this with the <a class="reference internal" href="cmds/prompt_pwd.html"><span class="doc">prompt_pwd</span></a> helper that will give us a shortened working directory:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">function</span><span class="w"> </span><span class="no">fish_prompt</span>
<span class="w"> </span><span class="nf">string</span><span class="w"> </span><span class="no">join</span><span class="w"> </span><span class="s1">''</span><span class="w"> </span><span class="no">--</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">green</span><span class="o">)</span><span class="w"> </span><span class="o">(</span><span class="nf">prompt_pwd</span><span class="o">)</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">normal</span><span class="o">)</span><span class="w"> </span><span class="s1">'>'</span>
<span class="nf">end</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">prompt_pwd</span></code> takes options to control how much to shorten. For instance, if we want to display the last two directories, we’d use <code class="docutils literal notranslate"><span class="pre">prompt_pwd</span> <span class="pre">--full-length-dirs</span> <span class="pre">2</span></code>:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">function</span><span class="w"> </span><span class="no">fish_prompt</span>
<span class="w"> </span><span class="nf">string</span><span class="w"> </span><span class="no">join</span><span class="w"> </span><span class="s1">''</span><span class="w"> </span><span class="no">--</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">green</span><span class="o">)</span><span class="w"> </span><span class="o">(</span><span class="nf">prompt_pwd</span><span class="w"> </span><span class="no">--full-length-dirs</span><span class="w"> </span><span class="no">2</span><span class="o">)</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">normal</span><span class="o">)</span><span class="w"> </span><span class="s1">'>'</span>
<span class="nf">end</span>
</pre></div>
</div>
<p>With a current directory of “/home/tutorial/Music/Lena Raine/Oneknowing”, this would print</p>
<pre class="highlight literal-block"><span class="green">~/M/Lena Raine/Oneknowing</span>>_</pre>
</section>
<section id="status">
<h2>Status<a class="headerlink" href="#status" title="Link to this heading">¶</a></h2>
<p>One important bit of information that every command returns is the <a class="reference internal" href="language.html#variables-status"><span class="std std-ref">status</span></a>. This is a whole number from 0 to 255, and usually it is used as an error code - 0 if the command returned successfully, or a number from 1 to 255 if not.</p>
<p>It’s useful to display this in your prompt, but showing it when it’s 0 seems kind of wasteful.</p>
<p>First of all, since every command (except for <a class="reference internal" href="cmds/set.html"><span class="doc">set</span></a>) changes the status, you need to store it for later use as the first thing in your prompt. Use a <a class="reference internal" href="language.html#variables-scope"><span class="std std-ref">local variable</span></a> so it will be confined to your prompt function:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">set</span><span class="w"> </span><span class="no">-l</span><span class="w"> </span><span class="no">last_status</span><span class="w"> </span><span class="o">$status</span>
</pre></div>
</div>
<p>And after that, you can set a string if it is not zero:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="c"># Prompt status only if it's not 0</span>
<span class="nf">set</span><span class="w"> </span><span class="no">-l</span><span class="w"> </span><span class="no">stat</span>
<span class="nf">if</span><span class="w"> </span><span class="nf">test</span><span class="w"> </span><span class="o">$last_status</span><span class="w"> </span><span class="no">-ne</span><span class="w"> </span><span class="no">0</span>
<span class="w"> </span><span class="nf">set</span><span class="w"> </span><span class="no">stat</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">red</span><span class="o">)</span><span class="s2">"[</span><span class="o">$last_status</span><span class="s2">]"</span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">normal</span><span class="o">)</span>
<span class="nf">end</span>
</pre></div>
</div>
<p>And to print it, we add it to our <code class="docutils literal notranslate"><span class="pre">string</span> <span class="pre">join</span></code>:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">string</span><span class="w"> </span><span class="no">join</span><span class="w"> </span><span class="s1">''</span><span class="w"> </span><span class="no">--</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">green</span><span class="o">)</span><span class="w"> </span><span class="o">(</span><span class="nf">prompt_pwd</span><span class="o">)</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">normal</span><span class="o">)</span><span class="w"> </span><span class="o">$stat</span><span class="w"> </span><span class="s1">'>'</span>
</pre></div>
</div>
<p>If <code class="docutils literal notranslate"><span class="pre">$last_status</span></code> was 0, <code class="docutils literal notranslate"><span class="pre">$stat</span></code> is empty, and so it will simply disappear.</p>
<p>So our entire prompt is now:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">function</span><span class="w"> </span><span class="no">fish_prompt</span>
<span class="w"> </span><span class="nf">set</span><span class="w"> </span><span class="no">-l</span><span class="w"> </span><span class="no">last_status</span><span class="w"> </span><span class="o">$status</span>
<span class="w"> </span><span class="c"># Prompt status only if it's not 0</span>
<span class="w"> </span><span class="nf">set</span><span class="w"> </span><span class="no">-l</span><span class="w"> </span><span class="no">stat</span>
<span class="w"> </span><span class="nf">if</span><span class="w"> </span><span class="nf">test</span><span class="w"> </span><span class="o">$last_status</span><span class="w"> </span><span class="no">-ne</span><span class="w"> </span><span class="no">0</span>
<span class="w"> </span><span class="nf">set</span><span class="w"> </span><span class="no">stat</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">red</span><span class="o">)</span><span class="s2">"[</span><span class="o">$last_status</span><span class="s2">]"</span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">normal</span><span class="o">)</span>
<span class="w"> </span><span class="nf">end</span>
<span class="w"> </span><span class="nf">string</span><span class="w"> </span><span class="no">join</span><span class="w"> </span><span class="s1">''</span><span class="w"> </span><span class="no">--</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">green</span><span class="o">)</span><span class="w"> </span><span class="o">(</span><span class="nf">prompt_pwd</span><span class="o">)</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">normal</span><span class="o">)</span><span class="w"> </span><span class="o">$stat</span><span class="w"> </span><span class="s1">'>'</span>
<span class="nf">end</span>
</pre></div>
</div>
<p>And it looks like:</p>
<pre class="highlight literal-block"><span class="green">~/M/L/Oneknowing</span>>false
<span class="green">~/M/L/Oneknowing</span><span class="red">[1]</span>>_</pre>
<p>after we run <code class="docutils literal notranslate"><span class="pre">false</span></code> (which returns 1).</p>
</section>
<section id="transient-prompt">
<span id="id1"></span><h2>Transient prompt<a class="headerlink" href="#transient-prompt" title="Link to this heading">¶</a></h2>
<p>To enable transient prompt functionality, set the <span class="target" id="index-2"></span><a class="reference internal" href="language.html#envvar-fish_transient_prompt"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">fish_transient_prompt</span></code></a> variable to 1:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">set</span><span class="w"> </span><span class="no">-g</span><span class="w"> </span><span class="no">fish_transient_prompt</span><span class="w"> </span><span class="no">1</span>
</pre></div>
</div>
<p>With this set, fish re-runs prompt functions with a <code class="docutils literal notranslate"><span class="pre">--final-rendering</span></code> argument before running a commandline.
So you can use it to declutter your old prompts. For example if you want to see only the current directory name when you scroll up:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">function</span><span class="w"> </span><span class="no">fish_prompt</span>
<span class="w"> </span><span class="nf">set</span><span class="w"> </span><span class="no">-l</span><span class="w"> </span><span class="no">last_status</span><span class="w"> </span><span class="o">$status</span>
<span class="w"> </span><span class="nf">set</span><span class="w"> </span><span class="no">-l</span><span class="w"> </span><span class="no">stat</span>
<span class="w"> </span><span class="nf">set</span><span class="w"> </span><span class="no">-l</span><span class="w"> </span><span class="no">pwd</span>
<span class="w"> </span><span class="c"># Check if it's a transient or final prompt</span>
<span class="w"> </span><span class="nf">if</span><span class="w"> </span><span class="nf">contains</span><span class="w"> </span><span class="no">--</span><span class="w"> </span><span class="no">--final-rendering</span><span class="w"> </span><span class="o">$argv</span>
<span class="w"> </span><span class="nf">set</span><span class="w"> </span><span class="no">pwd</span><span class="w"> </span><span class="o">(</span><span class="nf">path</span><span class="w"> </span><span class="no">basename</span><span class="w"> </span><span class="o">$PWD)</span>
<span class="w"> </span><span class="nf">else</span>
<span class="w"> </span><span class="nf">set</span><span class="w"> </span><span class="no">pwd</span><span class="w"> </span><span class="o">(</span><span class="nf">prompt_pwd</span><span class="o">)</span>
<span class="w"> </span><span class="c"># Prompt status only if it's not 0</span>
<span class="w"> </span><span class="nf">if</span><span class="w"> </span><span class="nf">test</span><span class="w"> </span><span class="o">$last_status</span><span class="w"> </span><span class="no">-ne</span><span class="w"> </span><span class="no">0</span>
<span class="w"> </span><span class="nf">set</span><span class="w"> </span><span class="no">stat</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">red</span><span class="o">)</span><span class="s2">"[</span><span class="o">$last_status</span><span class="s2">]"</span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">normal</span><span class="o">)</span>
<span class="w"> </span><span class="nf">end</span>
<span class="w"> </span><span class="nf">end</span>
<span class="w"> </span><span class="nf">string</span><span class="w"> </span><span class="no">join</span><span class="w"> </span><span class="s1">''</span><span class="w"> </span><span class="no">--</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">green</span><span class="o">)</span><span class="w"> </span><span class="o">$pwd</span><span class="w"> </span><span class="o">(</span><span class="nf">set_color</span><span class="w"> </span><span class="no">normal</span><span class="o">)</span><span class="w"> </span><span class="o">$stat</span><span class="w"> </span><span class="s1">'>'</span>
<span class="nf">end</span>
</pre></div>
</div>
<p>Now running two commands in the same directory could result in this screen:</p>
<pre class="highlight literal-block"><span class="green">Oneknowing</span>>false
<span class="green">~/M/L/Oneknowing</span><span class="red">[1]</span>>_</pre>
</section>
<section id="save-the-prompt">
<h2>Save the prompt<a class="headerlink" href="#save-the-prompt" title="Link to this heading">¶</a></h2>
<p>Once you are happy with your prompt, you can save it with <code class="docutils literal notranslate"><span class="pre">funcsave</span> <span class="pre">fish_prompt</span></code> (see <a class="reference internal" href="cmds/funcsave.html"><span class="doc">funcsave - save the definition of a function to the user’s autoload directory</span></a>) or write it to ~/.config/fish/functions/fish_prompt.fish yourself.</p>
<p>If you want to edit it again, open that file or use <code class="docutils literal notranslate"><span class="pre">funced</span> <span class="pre">fish_prompt</span></code> (see <a class="reference internal" href="cmds/funced.html"><span class="doc">funced - edit a function interactively</span></a>).</p>
</section>
<section id="where-to-go-from-here">
<h2>Where to go from here?<a class="headerlink" href="#where-to-go-from-here" title="Link to this heading">¶</a></h2>
<p>We have now built a simple but working and usable prompt, but of course more can be done.</p>
<ul class="simple">
<li><dl class="simple">
<dt>Fish offers more helper functions:</dt><dd><ul>
<li><p><code class="docutils literal notranslate"><span class="pre">prompt_login</span></code> to describe the user/hostname/container or <code class="docutils literal notranslate"><span class="pre">prompt_hostname</span></code> to describe just the host</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">fish_is_root_user</span></code> to help with changing the symbol for root.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">fish_vcs_prompt</span></code> to show version control information (or <code class="docutils literal notranslate"><span class="pre">fish_git_prompt</span></code> / <code class="docutils literal notranslate"><span class="pre">fish_hg_prompt</span></code> / <code class="docutils literal notranslate"><span class="pre">fish_svn_prompt</span></code> to limit it to specific systems)</p></li>
</ul>
</dd>
</dl>
</li>
<li><p>You can add a right prompt by changing <a class="reference internal" href="cmds/fish_right_prompt.html"><span class="doc">fish_right_prompt</span></a> or a vi mode prompt by changing <a class="reference internal" href="cmds/fish_mode_prompt.html"><span class="doc">fish_mode_prompt</span></a>.</p></li>
<li><dl class="simple">
<dt>Some prompts have interesting or advanced features</dt><dd><ul>
<li><p>Add the time when the prompt was printed</p></li>
<li><p>Show various integrations like python’s venv</p></li>
<li><p>Color the parts differently.</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
<p>You can look at fish’s sample prompts for inspiration. Open up <a class="reference internal" href="cmds/fish_config.html"><span class="doc">fish_config</span></a>, find one you like and pick it. For example:</p>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="nf">fish_config</span><span class="w"> </span><span class="no">prompt</span><span class="w"> </span><span class="no">show</span><span class="w"> </span><span class="c"># <- shows all the sample prompts</span>
<span class="nf">fish_config</span><span class="w"> </span><span class="no">prompt</span><span class="w"> </span><span class="no">choose</span><span class="w"> </span><span class="no">disco</span><span class="w"> </span><span class="c"># <- this picks the "disco" prompt for this session</span>
<span class="nf">funced</span><span class="w"> </span><span class="no">fish_prompt</span><span class="w"> </span><span class="c"># <- opens fish_prompt in your editor, and reloads it once the editor exits</span>
</pre></div>
</div>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li><img src="_static/fish.png" alt=""
style="width: 80px; height: 80px; vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://fishshell.com/">fish-shell</a> »</li>
<a href="index.html">fish-shell 4.2.1 documentation</a> »
<li class="nav-item nav-item-this"><a href="">Writing your own prompt</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="search.html" method="get">
<input placeholder="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</li>
<div id="old-docs-notice" style="display: none">
This documents an old version of fish.
<a href="../current/">See the latest release.</a>
</div>
</ul>
</div>
<div class="footer">
© Copyright fish-shell developers.
<br />
<a href="https://github.com/fish-shell/fish-shell/issues">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</div>
<script type="text/javascript">
FISH_DOCS_VERSION = "4.2";
function copy_to_clipboard(it) {
// Find the pre tag we're interested in.
var pre = it.target;
while (pre.tagName != "PRE") pre = pre.parentNode;
var txt = "";
// Cheesy: If we have a prompt,
// we only copy prompted lines,
// by splitting and matching and stuff
if (pre.querySelector('span.gp')) {
var texts= [];
for (var line of pre.innerText.split('\n')) {
if (line.match(/^>_?.*/)) {
texts.push(line.replace(/^>_?/, ""));
}
}
txt = texts.join("\n");
} else {
// Even cheesier: If we don't have a prompt, we remove the button text from the end.
var txt = pre.innerText.substring(0, pre.innerText.length - it.target.innerText.length).trim();
}
navigator.clipboard.writeText(txt).then(function() {
// Success - set the text to indicate it,
// then set it back after 2 seconds.
var span = pre.querySelector("button span");
if (span) {
var oldText = span.innerText;
span.innerText = "COPIED!";
setTimeout(function() {
span.innerText = oldText;
}, 2000);
}
}, function() {
});
}
(function () {
// Add copy buttons to all the codeblocks.
var codeblocks = document.querySelectorAll('div > pre');
var button = document.createElement('button');
var span = document.createElement('span');
span.innerText = "COPY";
button.appendChild(span);
for (var i of codeblocks) {
var newButton = button.cloneNode(true);
newButton.addEventListener('click', copy_to_clipboard);
i.appendChild(newButton);
}
})();
</script>
</body>
</html>
|
