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
|
<!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>fish_add_path - add to the path — 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="fish_breakpoint_prompt - define the prompt when stopped at a breakpoint" href="fish_breakpoint_prompt.html" />
<link rel="prev" title="fish - the friendly interactive shell" href="fish.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-1"><a href="../commands.html" accesskey="U">Commands</a> »</li>
<li class="nav-item nav-item-this"><a href="">fish_add_path - add to the path</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 current"><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"><a class="reference internal" href="../prompt.html">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="#">fish_add_path - add to the path</a><ul>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#options">Options</a></li>
<li><a class="reference internal" href="#example">Example</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="fish-add-path-add-to-the-path">
<h1>fish_add_path - add to the path<a class="headerlink" href="#fish-add-path-add-to-the-path" title="Link to this heading">¶</a></h1>
<section id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Link to this heading">¶</a></h2>
<div class="highlight-fish-synopsis notranslate"><div class="highlight"><pre><span></span><span class="nf">fish_add_path</span><span class="w"> </span><span class="no">path</span><span class="w"> </span><span class="g g-Other">...</span>
<span class="nf">fish_add_path</span><span class="w"> </span><span class="g g-Other">[(</span><span class="no">-g</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--global</span><span class="g g-Other">)</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="g g-Other">(</span><span class="no">-U</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--universal</span><span class="g g-Other">)</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="g g-Other">(</span><span class="no">-P</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--path</span><span class="g g-Other">)]</span><span class="w"> </span><span class="g g-Other">[(</span><span class="no">-m</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--move</span><span class="g g-Other">)]</span><span class="w"> </span><span class="g g-Other">[(</span><span class="no">-a</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--append</span><span class="g g-Other">)</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="g g-Other">(</span><span class="no">-p</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--prepend</span><span class="g g-Other">)]</span><span class="w"> </span><span class="g g-Other">[(</span><span class="no">-v</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--verbose</span><span class="g g-Other">)</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="g g-Other">(</span><span class="no">-n</span><span class="w"> </span><span class="g g-Other">|</span><span class="w"> </span><span class="no">--dry-run</span><span class="g g-Other">)]</span><span class="w"> </span><span class="no">PATHS</span><span class="w"> </span><span class="g g-Other">...</span>
</pre></div>
</div>
</section>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Link to this heading">¶</a></h2>
<p><strong class="program">fish_add_path</strong> is a simple way to add more directories to fish’s <span class="target" id="index-0"></span><a class="reference internal" href="../language.html#envvar-PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PATH</span></code></a>. It does this by adding the directories either to <span class="target" id="index-1"></span><a class="reference internal" href="../language.html#envvar-fish_user_paths"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">fish_user_paths</span></code></a> or directly to <span class="target" id="index-2"></span><a class="reference internal" href="../language.html#envvar-PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PATH</span></code></a> (if the <code class="docutils literal notranslate"><span class="pre">--path</span></code> switch is given).</p>
<p>It is (by default) safe to use <strong class="program">fish_add_path</strong> in config.fish, or it can be used once, interactively, and the paths will stay in future because of <a class="reference internal" href="../language.html#variables-universal"><span class="std std-ref">universal variables</span></a>. This is a “do what I mean” style command - it tries to do the right thing by default, and follow your lead on what you have already set up (e.g. by using a global <span class="target" id="index-3"></span><a class="reference internal" href="../language.html#envvar-fish_user_paths"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">fish_user_paths</span></code></a> if you have that already). If you need more control, consider modifying the variable yourself.</p>
<p>Directories are normalized with <a class="reference internal" href="realpath.html"><span class="doc">realpath</span></a>. Trailing slashes are ignored and relative paths are made absolute (but symlinks are not resolved). If a directory is already included, it is not added again and stays in the same place unless the <code class="docutils literal notranslate"><span class="pre">--move</span></code> switch is given.</p>
<p>Directories are added in the order they are given, and they are prepended to the path unless <code class="docutils literal notranslate"><span class="pre">--append</span></code> is given. If $fish_user_paths is used, that means they are last in $fish_user_paths, which is itself prepended to <span class="target" id="index-4"></span><a class="reference internal" href="../language.html#envvar-PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PATH</span></code></a>, so they still stay ahead of the system paths. If the <code class="docutils literal notranslate"><span class="pre">--path</span></code> option is used, the paths are appended/prepended to <span class="target" id="index-5"></span><a class="reference internal" href="../language.html#envvar-PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PATH</span></code></a> directly, so this doesn’t happen.</p>
<p>With <code class="docutils literal notranslate"><span class="pre">--path</span></code>, because <span class="target" id="index-6"></span><a class="reference internal" href="../language.html#envvar-PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PATH</span></code></a> must be a global variable instead of a universal one, the changes won’t persist, so those calls need to be stored in <a class="reference internal" href="../language.html#configuration"><span class="std std-ref">config.fish</span></a>. This also applies to <span class="target" id="index-7"></span><a class="reference internal" href="../language.html#envvar-fish_user_paths"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">fish_user_paths</span></code></a> if you make it global (for instance by passing <code class="docutils literal notranslate"><span class="pre">--global</span></code>).</p>
<p>If no directory is new, the variable (<span class="target" id="index-8"></span><a class="reference internal" href="../language.html#envvar-fish_user_paths"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">fish_user_paths</span></code></a> or <span class="target" id="index-9"></span><a class="reference internal" href="../language.html#envvar-PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PATH</span></code></a>) is not set again or otherwise modified, so variable handlers are not triggered.</p>
<p>If an argument is not an existing directory, <code class="docutils literal notranslate"><span class="pre">fish_add_path</span></code> ignores it.</p>
</section>
<section id="options">
<h2>Options<a class="headerlink" href="#options" title="Link to this heading">¶</a></h2>
<dl class="simple">
<dt><strong>-a</strong> or <strong>--append</strong></dt><dd><p>Add directories to the <em>end</em> of the variable.</p>
</dd>
<dt><strong>-p</strong> or <strong>--prepend</strong></dt><dd><p>Add directories to the <em>front</em> of the variable (this is the default).</p>
</dd>
<dt><strong>-g</strong> or <strong>--global</strong></dt><dd><p>Use a global <span class="target" id="index-10"></span><a class="reference internal" href="../language.html#envvar-fish_user_paths"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">fish_user_paths</span></code></a>.</p>
</dd>
<dt><strong>-U</strong> or <strong>--universal</strong></dt><dd><p>Use a universal <span class="target" id="index-11"></span><a class="reference internal" href="../language.html#envvar-fish_user_paths"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">fish_user_paths</span></code></a> - this is the default if it doesn’t already exist.</p>
</dd>
<dt><strong>-P</strong> or <strong>--path</strong></dt><dd><p>Manipulate <span class="target" id="index-12"></span><a class="reference internal" href="../language.html#envvar-PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PATH</span></code></a> directly.</p>
</dd>
<dt><strong>-m</strong> or <strong>--move</strong></dt><dd><p>Move already-included directories to the place they would be added - by default they would be left in place and not added again.</p>
</dd>
<dt><strong>-v</strong> or <strong>--verbose</strong></dt><dd><p>Print the <a class="reference internal" href="set.html"><span class="doc">set</span></a> command used, and some more warnings, like when a path is skipped because it doesn’t exist or is not a directory.
Verbose mode is automatically enabled when fish_add_path is used interactively and the output goes to the terminal.</p>
</dd>
<dt><strong>-n</strong> or <strong>--dry-run</strong></dt><dd><p>Print the <code class="docutils literal notranslate"><span class="pre">set</span></code> command that would be used without executing it.</p>
</dd>
<dt><strong>-h</strong> or <strong>--help</strong></dt><dd><p>Displays help about using this command.</p>
</dd>
</dl>
<p>If <code class="docutils literal notranslate"><span class="pre">--move</span></code> is used, it may of course lead to the path swapping order, so you should be careful doing that in config.fish.</p>
</section>
<section id="example">
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
<div class="highlight-fish-docs-samples notranslate"><div class="highlight"><pre><span></span><span class="go"># I just installed mycoolthing and need to add it to the path to use it.</span>
<span class="go"># It is at /opt/mycoolthing/bin/mycoolthing,</span>
<span class="go"># so let's add the directory: /opt/mycoolthing/bin.</span>
<span class="gp">> </span><span class="nf">fish_add_path</span><span class="w"> </span><span class="no">/opt/mycoolthing/bin</span>
<span class="go"># I want my ~/.local/bin to be checked first,</span>
<span class="go"># even if it was already added.</span>
<span class="gp">> </span><span class="nf">fish_add_path</span><span class="w"> </span><span class="no">-m</span><span class="w"> </span><span class="o">~</span><span class="no">/.local/bin</span>
<span class="go"># I prefer using a global fish_user_paths</span>
<span class="go"># This isn't saved automatically, I need to add this to config.fish</span>
<span class="go"># if I want it to stay.</span>
<span class="gp">> </span><span class="nf">fish_add_path</span><span class="w"> </span><span class="no">-g</span><span class="w"> </span><span class="o">~</span><span class="no">/.local/bin</span><span class="w"> </span><span class="o">~</span><span class="no">/.otherbin</span><span class="w"> </span><span class="no">/usr/local/sbin</span>
<span class="go"># I want to append to the entire $PATH because this directory contains fallbacks</span>
<span class="go"># This needs --path/-P because otherwise it appends to $fish_user_paths,</span>
<span class="go"># which is added to the front of $PATH.</span>
<span class="gp">> </span><span class="nf">fish_add_path</span><span class="w"> </span><span class="no">--append</span><span class="w"> </span><span class="no">--path</span><span class="w"> </span><span class="no">/opt/fallback/bin</span>
<span class="go"># I want to add the bin/ directory of my current $PWD (say /home/nemo/)</span>
<span class="go"># -v/--verbose shows what fish_add_path did.</span>
<span class="gp">> </span><span class="nf">fish_add_path</span><span class="w"> </span><span class="no">-v</span><span class="w"> </span><span class="no">bin/</span>
<span class="go">set fish_user_paths /home/nemo/bin /usr/bin /home/nemo/.local/bin</span>
<span class="go"># I have installed ruby via homebrew</span>
<span class="gp">> </span><span class="nf">fish_add_path</span><span class="w"> </span><span class="no">/usr/local/opt/ruby/bin</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-1"><a href="../commands.html" >Commands</a> »</li>
<li class="nav-item nav-item-this"><a href="">fish_add_path - add to the path</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>
|
