-
Notifications
You must be signed in to change notification settings - Fork 8
/
xonshrc.html
722 lines (654 loc) · 54.7 KB
/
xonshrc.html
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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Updating and customizing xonsh" href="customization.html" /><link rel="prev" title="Keyboard Shortcuts" href="keyboard_shortcuts.html" />
<link rel="shortcut icon" href="_static/magic_conch.ico"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.01.29 -->
<title>Run Control File - xonsh 0.18.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=c8b63bf6" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
<style>
body {
--color-code-background: #eeffcc;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="contents.html"><div class="brand">xonsh 0.18.2 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="contents.html">
<div class="sidebar-logo-container">
<img class="sidebar-logo" src="_static/ascii_conch_part_transparent_tight.png" alt="Logo"/>
</div>
<span class="sidebar-brand-text">xonsh 0.18.2 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="packages.html">Package Manager</a></li>
<li class="toctree-l1"><a class="reference internal" href="appimage.html">AppImage</a></li>
<li class="toctree-l1"><a class="reference internal" href="containers.html">Docker container</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_hist.html">Tutorial: History</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_macros.html">Tutorial: Macros</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_xontrib.html">Tutorial: Extensions (Xontribs)</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_xonsh_projects.html">Tutorial: Xonsh Projects</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_events.html">Tutorial: Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_completers.html">Tutorial: Programmable Tab-Completion</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_history_backend.html">Tutorial: Write Your Own History Backend</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_subproc_strings.html">Tutorial: Subprocess Strings</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_ptk.html">Tutorial: <code class="docutils literal notranslate"><span class="pre">prompt_toolkit</span></code> custom keybindings</a></li>
<li class="toctree-l1"><a class="reference internal" href="bash_to_xsh.html">Bash to Xonsh Translation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="editors.html">Editor and IDE Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="subproc_types.html">Subprocess Types Table</a></li>
<li class="toctree-l1"><a class="reference internal" href="python_virtual_environments.html">Python Virtual Environments</a></li>
<li class="toctree-l1"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Run Control File</a></li>
<li class="toctree-l1"><a class="reference internal" href="customization.html">Updating and customizing xonsh</a></li>
<li class="toctree-l1"><a class="reference internal" href="envvars.html">Environment Variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="aliases.html">Built-in Aliases</a></li>
<li class="toctree-l1"><a class="reference internal" href="events.html">Core Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="platform-issues.html">Platform-specific tips and tricks</a></li>
</ul>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="api/index.html">Xonsh API</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Xonsh API</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.parser.html">xonsh.parser</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.execer.html">xonsh.execer</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/lang/xonsh.imphooks.html">xonsh.imphooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.built_ins.html">xonsh.built_ins</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.environ.html">xonsh.environ</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.aliases.html">xonsh.aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.dirstack.html">xonsh.dirstack</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.html">xonsh.procs</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of xonsh.procs</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.executables.html">xonsh.procs.executables</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.jobs.html">xonsh.procs.jobs</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.pipelines.html">xonsh.procs.pipelines</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.posix.html">xonsh.procs.posix</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.proxies.html">xonsh.procs.proxies</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.readers.html">xonsh.procs.readers</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.procs.specs.html">xonsh.procs.specs</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.html">xonsh.history</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of xonsh.history</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.base.html">xonsh.history.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.diff_history.html">xonsh.history.diff_history</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.dummy.html">xonsh.history.dummy</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.json.html">xonsh.history.json</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.main.html">xonsh.history.main</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.history.sqlite.html">xonsh.history.sqlite</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completer.html">xonsh.completer</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.html">xonsh.completers</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of xonsh.completers</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.base.html">xonsh.completers.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.bash.html">xonsh.completers.bash</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.bash_completion.html">xonsh.completers.bash_completion</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.commands.html">xonsh.completers.commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.completer.html">xonsh.completers.completer</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.dirs.html">xonsh.completers.dirs</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.environment.html">xonsh.completers.environment</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.imports.html">xonsh.completers.imports</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.init.html">xonsh.completers.init</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.man.html">xonsh.completers.man</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.path.html">xonsh.completers.path</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.python.html">xonsh.completers.python</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.completers.tools.html">xonsh.completers.tools</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.html">xonsh.prompt</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of xonsh.prompt</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.base.html">xonsh.prompt.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.cwd.html">xonsh.prompt.cwd</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.env.html">xonsh.prompt.env</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.gitstatus.html">xonsh.prompt.gitstatus</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.job.html">xonsh.prompt.job</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.times.html">xonsh.prompt.times</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.prompt.vc.html">xonsh.prompt.vc</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.shells.html">xonsh.shells</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of xonsh.shells</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.shells.base_shell.html">xonsh.shells.base_shell</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.shells.dumb_shell.html">xonsh.shells.dumb_shell</a></li>
<li class="toctree-l3 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.shells.ptk_shell.html">xonsh.shells.ptk_shell</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of xonsh.shells.ptk_shell</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="api/_autosummary/cmd/xonsh.shells.ptk_shell.completer.html">xonsh.shells.ptk_shell.completer</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/_autosummary/cmd/xonsh.shells.ptk_shell.formatter.html">xonsh.shells.ptk_shell.formatter</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/_autosummary/cmd/xonsh.shells.ptk_shell.history.html">xonsh.shells.ptk_shell.history</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/_autosummary/cmd/xonsh.shells.ptk_shell.key_bindings.html">xonsh.shells.ptk_shell.key_bindings</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/_autosummary/cmd/xonsh.shells.ptk_shell.updator.html">xonsh.shells.ptk_shell.updator</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.shells.readline_shell.html">xonsh.shells.readline_shell</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/cmd/xonsh.ptk_shell.html">xonsh.ptk_shell</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.html">xonsh.xoreutils</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of xonsh.xoreutils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.cat.html">xonsh.xoreutils.cat</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.echo.html">xonsh.xoreutils.echo</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.pwd.html">xonsh.xoreutils.pwd</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.tee.html">xonsh.xoreutils.tee</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.tty.html">xonsh.xoreutils.tty</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.ulimit.html">xonsh.xoreutils.ulimit</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.umask.html">xonsh.xoreutils.umask</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.uname.html">xonsh.xoreutils.uname</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.uptime.html">xonsh.xoreutils.uptime</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.util.html">xonsh.xoreutils.util</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.which.html">xonsh.xoreutils.which</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/cmd/xonsh.xoreutils.yes.html">xonsh.xoreutils.yes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.events.html">xonsh.events</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.html">xonsh.lib</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle navigation of xonsh.lib</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.collections.html">xonsh.lib.collections</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.inspectors.html">xonsh.lib.inspectors</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.itertools.html">xonsh.lib.itertools</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.jsonutils.html">xonsh.lib.jsonutils</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.lazyasd.html">xonsh.lib.lazyasd</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.lazyimps.html">xonsh.lib.lazyimps</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.lazyjson.html">xonsh.lib.lazyjson</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.modules.html">xonsh.lib.modules</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.openpy.html">xonsh.lib.openpy</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.os.html">xonsh.lib.os</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.pretty.html">xonsh.lib.pretty</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lib.subprocess.html">xonsh.lib.subprocess</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.tools.html">xonsh.tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.platform.html">xonsh.platform</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lazyjson.html">xonsh.lazyjson</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.lazyasd.html">xonsh.lazyasd</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.foreign_shells.html">xonsh.foreign_shells</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.commands_cache.html">xonsh.commands_cache</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.tracer.html">xonsh.tracer</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.main.html">xonsh.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.color_tools.html">xonsh.color_tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.pyghooks.html">xonsh.pyghooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.wizard.html">xonsh.wizard</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.xonfig.html">xonsh.xonfig</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.xontribs.html">xonsh.xontribs</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.codecache.html">xonsh.codecache</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/_autosummary/helpers/xonsh.contexts.html">xonsh.contexts</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="api/_autosummary/xontribs/xontrib.html">xontrib</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle navigation of xontrib</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="api/_autosummary/xontribs/xontrib.coreutils.html">xontrib.coreutils</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advanced_events.html">Advanced Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="devguide.html">Developer’s Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Xonsh Change Log</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="todo.html">Wishlist & To-Dos</a></li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="edit-this-page">
<a class="muted-link" href="https://github.com/xonsh/xonsh/edit/main/docs/xonshrc.rst" title="Edit this page">
<svg aria-hidden="true" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<path d="M4 20h4l10.5 -10.5a1.5 1.5 0 0 0 -4 -4l-10.5 10.5v4" />
<line x1="13.5" y1="6.5" x2="17.5" y2="10.5" />
</svg>
<span class="visually-hidden">Edit this page</span>
</a>
</div><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<section id="run-control-file">
<h1>Run Control File<a class="headerlink" href="#run-control-file" title="Link to this heading">¶</a></h1>
<p>Xonsh allows you to customize your shell behavior with run control files, called “xonshrc” files.
These files are written either in the Xonsh language (a superset of Python) or in Python and are executed
exactly once at startup.</p>
<p>The control file usually contains:</p>
<ul class="simple">
<li><p>Assignment statements setting <a class="reference external" href="envvars.html">environment variables</a>. This includes standard OS environment variables that affect other programs and many that Xonsh uses for itself.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">xontrib</span></code> commands to load selected add-ins (<a class="reference external" href="tutorial_xontrib.html#loading-xontribs">xontribs</a>).</p></li>
<li><p>Xonsh function definitions.</p></li>
<li><p><a class="reference external" href="aliases.html">Alias definitions</a>, many of which invoke the above functions with specified arguments.</p></li>
</ul>
<p>First of all, you need to know about the home directory <code class="docutils literal notranslate"><span class="pre">~/.xonshrc</span></code> control file. This file is commonly used to put configurations for the user interactive prompt and it is executed automatically only for interactive Xonsh sessions.</p>
<p>There are also a few places where Xonsh looks for run control files. These files will be executed automatically in both interactive and non-interactive modes, and you need to use the <a class="reference external" href="envvars.html#xonsh-interactive">$XONSH_INTERACTIVE</a> and <a class="reference external" href="envvars.html#xonsh-login">$XONSH_LOGIN</a> environment variables to determine what code you want to execute in each mode. Here is the list of run control files and directories:</p>
<ul class="simple">
<li><p>Cross-desktop group (XDG) compliant <code class="docutils literal notranslate"><span class="pre">~/.config/xonsh/rc.xsh</span></code> control file.</p></li>
<li><p>The system-wide control file <code class="docutils literal notranslate"><span class="pre">/etc/xonsh/xonshrc</span></code> for Linux and OSX and in <code class="docutils literal notranslate"><span class="pre">%ALLUSERSPROFILE%\xonsh\xonshrc</span></code> on Windows. It controls options that are applied to all users of Xonsh on a given system.</p></li>
<li><p>The home-based directory <code class="docutils literal notranslate"><span class="pre">~/.config/xonsh/rc.d/</span></code> and system <code class="docutils literal notranslate"><span class="pre">/etc/xonsh/rc.d/</span></code> can contain <code class="docutils literal notranslate"><span class="pre">.xsh</span></code> or <code class="docutils literal notranslate"><span class="pre">.py</span></code> files. They will be executed at startup in order. This allows for drop-in configuration where your configuration can be split across scripts and common and local configurations more easily separated.</p></li>
</ul>
<p>In addition:</p>
<ul class="simple">
<li><p>Use <code class="docutils literal notranslate"><span class="pre">xonsh</span> <span class="pre">--no-rc</span></code> to prevent using control files.</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">xonsh</span> <span class="pre">--rc</span> <span class="pre">snail.xsh</span></code> to run only a certain control file.</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">xonsh</span> <span class="pre">-i</span> <span class="pre">script.xsh</span></code> to run xonsh in interactive mode with loading all possible control files.</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">xonsh</span> <span class="pre">--rc</span> <span class="pre">rc1.xsh</span> <span class="pre">rc2.xsh</span> <span class="pre">--</span> <span class="pre">script.xsh</span></code> to run scripts with multiple control files.</p></li>
<li><p>You can create autoloadable <a class="reference external" href="tutorial_xontrib.html#loading-xontribs">xontrib</a> as alternative to run control file and reuse it as python package.</p></li>
</ul>
<p>The options set per user override settings in the system-wide control file.</p>
<p>Xonsh provides 2 wizards to create your own “xonshrc”. <code class="docutils literal notranslate"><span class="pre">xonfig</span> <span class="pre">web</span></code> provides basic settings, and <code class="docutils literal notranslate"><span class="pre">xonfig</span> <span class="pre">wizard</span></code>
steps you through all the available options.</p>
<section id="xonfig-web">
<h2>xonfig web<a class="headerlink" href="#xonfig-web" title="Link to this heading">¶</a></h2>
<p>This helps you choose a color theme, customized prompt and add-in packages (“xontribs”). It
initializes your personal run control file (usually at <code class="docutils literal notranslate"><span class="pre">~/.xonshrc</span></code>). To invoke it (from a xonsh prompt):</p>
<div class="highlight-xonshcon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">xonfig</span> <span class="n">web</span>
<span class="go">Web config started at 'http://localhost:8421'. Hit Crtl+C to stop.</span>
<span class="go">127.0.0.1 - - [23/Aug/2020 15:04:39] "GET / HTTP/1.1" 200 -</span>
</pre></div>
</div>
<p>This will open your default browser on a page served from a local server. You can exit the server by typing <code class="docutils literal notranslate"><span class="pre">Ctrl+c</span></code> at any time.</p>
<p>The page has:</p>
<dl class="field-list simple">
<dt class="field-odd">Colors<span class="colon">:</span></dt>
<dd class="field-odd"><p>shows the color themes built into Xonsh.
Simply click on a sample to select it. Although color names are standardized across various terminal applications,
their actual appearance is not and do vary widely. Seeing is believing!</p>
</dd>
<dt class="field-even">Prompts<span class="colon">:</span></dt>
<dd class="field-even"><p>shows various sample prompts. It is recommended to select one but to then edit
the <code class="docutils literal notranslate"><span class="pre">xonshrc</span></code> file to further refine your prompt.</p>
</dd>
<dt class="field-odd">Xontribs<span class="colon">:</span></dt>
<dd class="field-odd"><p>are community-contributed add-ins often used to enhance command completion and line editing,
but can affect any aspect of Xonsh behavior.
Choose one or more to suit your needs but note that they will require installation of additional
packages. You can extend Xonsh by <a class="reference external" href="tutorial_xontrib.html">writing your own xontrib</a>, and are invited/urged to do so!</p>
</dd>
<dt class="field-even">Save<span class="colon">:</span></dt>
<dd class="field-even"><p>Click to write the configuration choices to your <code class="docutils literal notranslate"><span class="pre">~/.xonshrc</span></code>. This will add a few tagged lines to your run control file, but will not
overwrite it completely, so you can run <cite>xonfig web</cite> at any time.</p>
</dd>
</dl>
</section>
<section id="xonfig-wizard">
<h2>xonfig wizard<a class="headerlink" href="#xonfig-wizard" title="Link to this heading">¶</a></h2>
<p>This imports settings and tools you have defined in your existing (ordinary) shell such as <code class="docutils literal notranslate"><span class="pre">bash</span></code>.
It also walks you through setting all known environment variables and xontribs
in a question-and-answer format:</p>
<div class="highlight-xonshcon notranslate"><div class="highlight"><pre><span></span><span class="o">@</span> <span class="n">xonfig</span> <span class="n">wizard</span>
<span class="go"> Welcome to the xonsh configuration wizard!</span>
<span class="go"> ------------------------------------------</span>
<span class="go">This will present a guided tour through setting up the xonsh static</span>
<span class="go">config file. Xonsh will automatically ask you if you want to run this</span>
<span class="go">wizard if the configuration file does not exist. However, you can</span>
<span class="go">always rerun this wizard with the xonfig command:</span>
<span class="go"> @ xonfig wizard</span>
<span class="go">This wizard will load an existing configuration, if it is available.</span>
<span class="go">Also never fear when this wizard saves its results! It will create</span>
<span class="go">a backup of any existing configuration automatically.</span>
<span class="go">This wizard has two main phases: foreign shell setup and environment</span>
<span class="go">variable setup. Each phase may be skipped in its entirety.</span>
<span class="go">For the configuration to take effect, you will need to restart xonsh.</span>
<span class="go">'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'``-.,_,.-*'</span>
<span class="go">To exit the wizard at any time, press Ctrl-C.</span>
<span class="go">'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'</span>
<span class="go"> Foreign Shell Setup</span>
<span class="go"> -------------------</span>
<span class="go">The xonsh shell has the ability to interface with foreign shells such</span>
<span class="go">as Bash, or zsh (fish not yet implemented).</span>
<span class="go">For configuration, this means that xonsh can load the environment,</span>
<span class="go">aliases, and functions specified in the config files of these shells.</span>
<span class="go">Naturally, these shells must be available on the system to work.</span>
<span class="go">Being able to share configuration (and source) from foreign shells</span>
<span class="go">makes it easier to transition to and from xonsh.</span>
<span class="go">Add a new foreign shell, yes or no [default: no]? yes</span>
<span class="go">shell name (e.g. bash): bash</span>
<span class="go">interactive shell [bool, default=True]:</span>
<span class="go">login shell [bool, default=False]:</span>
<span class="go">env command [str, default='env']:</span>
<span class="go">alias command [str, default='alias']:</span>
<span class="go">extra command line arguments [list of str, default=[]]:</span>
<span class="go">safely handle exceptions [bool, default=True]:</span>
<span class="go">pre-command [str, default='']:</span>
<span class="go">post-command [str, default='']:</span>
<span class="go">foreign function command [str, default=None]:</span>
<span class="go">source command [str, default=None]: source</span>
<span class="go">Foreign shell added.</span>
<span class="go">Add a new foreign shell, yes or no [default: no]? no</span>
<span class="go">'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'`-.,_,.-*'``-.,_,.-*'</span>
<span class="go"> Environment Variable Setup</span>
<span class="go"> --------------------------</span>
<span class="go">The xonsh shell also allows you to setup environment variables from</span>
<span class="go">the static configuration file. Any variables set in this way are</span>
<span class="go">superseded by the definitions in the xonshrc or on the command line.</span>
<span class="go">Still, setting environment variables in this way can help define</span>
<span class="go">options that are global to the system or user.</span>
<span class="go">The following lists the environment variable name, its documentation,</span>
<span class="go">the default value, and the current value. The default and current</span>
<span class="go">values are presented as pretty repr strings of their Python types.</span>
<span class="go">Note: Simply hitting enter for any environment variable</span>
<span class="go">will accept the default value for that entry.</span>
<span class="go">Would you like to set env vars now, yes or no [default: no]? yes</span>
<span class="go">$ALLUSERSPROFILE</span>
<span class="go">default value:</span>
<span class="go">current value: 'C:\\ProgramData'</span>
<span class="gp">>>></span>
<span class="go">$APPDATA</span>
<span class="go">default value:</span>
<span class="go">current value: 'C:\\Users\\bobhy\\AppData\\Roaming'</span>
<span class="gp">>>></span>
<span class="go">$AUTO_CD</span>
<span class="go">Flag to enable changing to a directory by entering the dirname or</span>
<span class="go">full path only (without the cd command).</span>
<span class="go">default value: False</span>
<span class="go">current value: False</span>
<span class="gp">>>></span>
<span class="go">. . .</span>
</pre></div>
</div>
</section>
<section id="real-world-sample-xonshrc">
<h2>Real world sample xonshrc<a class="headerlink" href="#real-world-sample-xonshrc" title="Link to this heading">¶</a></h2>
<p>The following is a real-world example of such a file.</p>
<p><a class="reference download internal" download="" href="_downloads/a98a1b93431566c5bf1729edbf03501f/xonshrc.xsh"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">xonshrc</span></code></a></p>
<div class="code xonsh highlight-default notranslate"><div class="highlight"><pre><span></span># adjust some paths
$PATH.append('/home/scopatz/sandbox/bin')
$LD_LIBRARY_PATH = ['/home/scopatz/.local/lib', '/home/scopatz/miniconda3/lib', '']
# alias to quit AwesomeWM from the terminal
def _quit_awesome(args, stdin=None):
lines = $(ps ux | grep "gnome-session --session=awesome").splitlines()
pids = [l.split()[1] for l in lines]
for pid in pids:
kill @(pid)
aliases['qa'] = _quit_awesome
# some customization options, see https://xon.sh/envvars.html for details
$MULTILINE_PROMPT = '`·.,¸,.·*¯`·.,¸,.·*¯'
$XONSH_SHOW_TRACEBACK = True
$XONSH_STORE_STDOUT = True
$XONSH_HISTORY_MATCH_ANYWHERE = True
$COMPLETIONS_CONFIRM = True
$XONSH_AUTOPAIR = True
</pre></div>
</div>
<p>See also <a class="reference external" href="https://github.com/anki-code/xontrib-rc-awesome">xontrib-rc-awesome</a>.</p>
</section>
<section id="real-world-sample-rc-py">
<h2>Real world sample rc.py<a class="headerlink" href="#real-world-sample-rc-py" title="Link to this heading">¶</a></h2>
<p>The following is a real-world example of such a file.
This can be set by <code class="docutils literal notranslate"><span class="pre">env</span> <span class="pre">XONSHRC=rc.py</span> <span class="pre">xonsh</span></code> or <code class="docutils literal notranslate"><span class="pre">xonsh</span> <span class="pre">--rc=rc.py</span></code></p>
<p><a class="reference download internal" download="" href="_downloads/d7567ce3516ad34d4c0d759b1ba3b556/xonshrc.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">rc.py</span></code></a></p>
<div class="code xonsh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">xonsh.built_ins</span> <span class="kn">import</span> <span class="n">XSH</span>
<span class="n">env</span> <span class="o">=</span> <span class="n">XSH</span><span class="o">.</span><span class="n">env</span>
<span class="c1"># adjust some paths</span>
<span class="n">env</span><span class="p">[</span><span class="s2">"PATH"</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"/home/scopatz/sandbox/bin"</span><span class="p">)</span>
<span class="n">env</span><span class="p">[</span><span class="s2">"LD_LIBRARY_PATH"</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"/home/scopatz/.local/lib"</span><span class="p">,</span> <span class="s2">"/home/scopatz/miniconda3/lib"</span><span class="p">]</span>
<span class="c1"># alias to quit AwesomeWM from the terminal</span>
<span class="k">def</span> <span class="nf">_quit_awesome</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">stdin</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"awesome python code"</span><span class="p">)</span>
<span class="n">XSH</span><span class="o">.</span><span class="n">aliases</span><span class="p">[</span><span class="s2">"qa"</span><span class="p">]</span> <span class="o">=</span> <span class="n">_quit_awesome</span>
<span class="c1"># setting aliases as list are faster since they don't involve parser.</span>
<span class="n">XSH</span><span class="o">.</span><span class="n">aliases</span><span class="p">[</span><span class="s2">"gc"</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"git"</span><span class="p">,</span> <span class="s2">"commit"</span><span class="p">]</span>
<span class="c1"># some customization options, see https://xon.sh/envvars.html for details</span>
<span class="n">env</span><span class="p">[</span><span class="s2">"MULTILINE_PROMPT"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"`·.,¸,.·*¯`·.,¸,.·*¯"</span>
<span class="n">env</span><span class="p">[</span><span class="s2">"XONSH_SHOW_TRACEBACK"</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">env</span><span class="p">[</span><span class="s2">"XONSH_STORE_STDOUT"</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">env</span><span class="p">[</span><span class="s2">"XONSH_HISTORY_MATCH_ANYWHERE"</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">env</span><span class="p">[</span><span class="s2">"COMPLETIONS_CONFIRM"</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">env</span><span class="p">[</span><span class="s2">"XONSH_AUTOPAIR"</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
</pre></div>
</div>
</section>
<section id="snippets-for-xonshrc">
<h2>Snippets for xonshrc<a class="headerlink" href="#snippets-for-xonshrc" title="Link to this heading">¶</a></h2>
<p>The following are useful snippets and code that tweaks and adjust xonsh in various ways.
If you have any useful tricks, feel free to share them.</p>
<section id="adjust-how-git-branch-label-behaves">
<h3>Adjust how git branch label behaves<a class="headerlink" href="#adjust-how-git-branch-label-behaves" title="Link to this heading">¶</a></h3>
<p>Xonsh adds a colored branch name to the prompt when working with git or hg repositories.
This behavior can be controlled with the <code class="docutils literal notranslate"><span class="pre">$PROMPT</span></code> environment variable. See how to <a class="reference external" href="tutorial.html#customizing-the-prompt">customize the prompt</a> .
The branch name changes color if the work dir is dirty or not. This is controlled by the <code class="docutils literal notranslate"><span class="pre">{branch_color}</span></code> formatter string.</p>
<p>The following snippet reimplements the formatter also to include untracked files when considering if a git directory is dirty.</p>
<div class="highlight-xonshcon notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">xonsh.prompt.vc</span> <span class="kn">import</span> <span class="n">git_dirty_working_directory</span>
<span class="go">$PROMPT_FIELDS['branch_color'] = lambda: ('{BOLD_INTENSE_RED}'</span>
<span class="go"> if git_dirty_working_directory(include_untracked=True)</span>
<span class="go"> else '{BOLD_INTENSE_GREEN}')</span>
</pre></div>
</div>
</section>
<section id="get-better-colors-from-the-ls-command">
<h3>Get better colors from the <code class="docutils literal notranslate"><span class="pre">ls</span></code> command<a class="headerlink" href="#get-better-colors-from-the-ls-command" title="Link to this heading">¶</a></h3>
<p>The colors of the <code class="docutils literal notranslate"><span class="pre">ls</span></code> command may be hard to read in a dark terminal. If so, this is an excellent addition to the xonshrc file.</p>
<div class="highlight-xonshcon notranslate"><div class="highlight"><pre><span></span><span class="nv">$LS_COLORS</span><span class="o">=</span><span class="s1">'rs=0:di=01;36:ln=01;36:mh=00:pi=40;33:so=01;35:do=01;35:bd=40;33;01:cd=40;33;01:or=40;31;01:su=37;41:sg=30;43:ca=30;41:tw=30;42:ow=34;42:st=37;44:ex=01;32:'</span>
</pre></div>
</div>
</section>
<section id="make-json-data-directly-pastable">
<h3>Make JSON data directly pastable<a class="headerlink" href="#make-json-data-directly-pastable" title="Link to this heading">¶</a></h3>
<p>With the following snippet, xonsh will understand JSON data such as <code class="docutils literal notranslate"><span class="pre">{</span> <span class="pre">"name":</span> <span class="pre">"Tyler",</span> <span class="pre">"active":</span> <span class="pre">false,</span> <span class="pre">"age":</span> <span class="pre">null</span> <span class="pre">}</span></code>.
Note that, though practical, this is rather hacky and might break other functionality. Use at your own risk.</p>
<div class="highlight-xonshcon notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">builtins</span>
<span class="go">builtins.true = True</span>
<span class="go">builtins.false = False</span>
<span class="go">builtins.null = None</span>
</pre></div>
</div>
</section>
<section id="display-different-date-information-every-10th-time">
<h3>Display different date information every 10th time<a class="headerlink" href="#display-different-date-information-every-10th-time" title="Link to this heading">¶</a></h3>
<p>For a compact shell prompts, some people prefer a very condensed time format. But when you have a lengthy shell session you might want the date to show up in your logs every now and then…</p>
<div class="highlight-xonshcon notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">time</span>
<span class="go">def get_shelldate():</span>
<span class="go"> get_shelldate.fulldate %= 10</span>
<span class="go"> get_shelldate.fulldate += 1</span>
<span class="go"> if get_shelldate.fulldate == 1:</span>
<span class="go"> return time.strftime('%d%m%Y')</span>
<span class="go"> return time.strftime('%H:%M')</span>
<span class="go">get_shelldate.fulldate = 0</span>
<span class="go">$PROMPT_FIELDS['shelldate'] = get_shelldate</span>
</pre></div>
</div>
</section>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="customization.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Updating and customizing xonsh</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="keyboard_shortcuts.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Keyboard Shortcuts</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © 2015, Anthony Scopatz
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Run Control File</a><ul>
<li><a class="reference internal" href="#xonfig-web">xonfig web</a></li>
<li><a class="reference internal" href="#xonfig-wizard">xonfig wizard</a></li>
<li><a class="reference internal" href="#real-world-sample-xonshrc">Real world sample xonshrc</a></li>
<li><a class="reference internal" href="#real-world-sample-rc-py">Real world sample rc.py</a></li>
<li><a class="reference internal" href="#snippets-for-xonshrc">Snippets for xonshrc</a><ul>
<li><a class="reference internal" href="#adjust-how-git-branch-label-behaves">Adjust how git branch label behaves</a></li>
<li><a class="reference internal" href="#get-better-colors-from-the-ls-command">Get better colors from the <code class="docutils literal notranslate"><span class="pre">ls</span></code> command</a></li>
<li><a class="reference internal" href="#make-json-data-directly-pastable">Make JSON data directly pastable</a></li>
<li><a class="reference internal" href="#display-different-date-information-every-10th-time">Display different date information every 10th time</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="_static/documentation_options.js?v=29ae757a"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=32e29ea5"></script>
<script src="_static/runthis-client.min.js?v=ad2a40d9"></script>
</body>
</html>