-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathaliases.html
More file actions
1251 lines (1183 loc) · 109 KB
/
Copy pathaliases.html
File metadata and controls
1251 lines (1183 loc) · 109 KB
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
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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="History" href="history.html"><link rel="prev" title="Environment Variables" href="envvars.html">
<link rel="canonical" href="https://xon.sh/aliases.html">
<link rel="prefetch" href="_static/xonsh_terminal_icon_256.png" as="image">
<link rel="shortcut icon" href="_static/magic_conch.ico"><!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
<title>Built-in Aliases - Xonsh 0.24.2 Documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=7bdb33bb" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=d27b64cb" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
<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>
<script type="application/ld+json">{
"@context": "https://schema.org",
"@graph": [
{
"@type": "TechArticle",
"@id": "https://xon.sh/aliases.html#techarticle",
"headline": "Built-in Aliases",
"url": "https://xon.sh/aliases.html",
"isPartOf": {"@id": "https://xon.sh/#website"},
"about": {"@id": "https://xon.sh/#software"},
"inLanguage": "en",
"author": {"@id": "https://xon.sh/#org"},
"publisher": {"@id": "https://xon.sh/#org"}
},
{
"@type": "BreadcrumbList",
"itemListElement": [
{"@type": "ListItem", "position": 1, "name": "Home", "item": "https://xon.sh/"},{"@type": "ListItem", "position": 2, "name": "Contents", "item": "https://xon.sh/contents.html"}
,{"@type": "ListItem", "position": 3, "name": "Built-in Aliases", "item": "https://xon.sh/aliases.html"}
]
}
]
}</script>
</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" 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" 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-with-moon" viewBox="0 0 24 24">
<title>Auto light/dark, in light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
<circle cx="14.5" cy="9.55" r="3.6"/>
</svg>
</symbol>
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
<title>Auto light/dark, in dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
</svg>
</symbol>
<symbol id="svg-pencil" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
<path d="M13.5 6.5l4 4" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
<symbol id="svg-eye" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
<path
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
<label class="overlay sidebar-overlay" for="__navigation"></label>
<label class="overlay toc-overlay" for="__toc"></label>
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
</label>
</div>
<div class="header-center">
<a href="contents.html"><div class="brand">Xonsh 0.24.2 Documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></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">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</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/xonsh_terminal_icon_256.png" alt="Logo"/>
</div>
<span class="sidebar-brand-text">Xonsh 0.24.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="install.html">Xonsh Installation Guide</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">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="strings.html">Subprocess Strings</a></li>
<li class="toctree-l1"><a class="reference internal" href="subprocess.html">Subprocess</a></li>
<li class="toctree-l1"><a class="reference internal" href="python.html">Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="error_handling.html">Subprocess Error Handling</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/topics/xontrib">Extensions on Github</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/xonsh/xonsh/discussions">Ask question</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="xonshrc.html">Run Control File</a></li>
<li class="toctree-l1"><a class="reference internal" href="envvars.html">Environment Variables</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Built-in Aliases</a></li>
<li class="toctree-l1"><a class="reference internal" href="history.html">History</a></li>
<li class="toctree-l1"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts</a></li>
<li class="toctree-l1"><a class="reference internal" href="prompt.html">Prompt</a></li>
<li class="toctree-l1"><a class="reference internal" href="events.html">Built-in Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="globbing.html">Globbing</a></li>
<li class="toctree-l1"><a class="reference internal" href="macros.html">Macros</a></li>
<li class="toctree-l1"><a class="reference internal" href="xonsh_session.html">Xonsh Session</a></li>
<li class="toctree-l1"><a class="reference internal" href="launch.html">Launch Options</a></li>
<li class="toctree-l1"><a class="reference internal" href="platforms.html">Cross-platform</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/xonsh/xonsh">Open technical issue</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="editors.html">Editor and IDE</a></li>
<li class="toctree-l1"><a class="reference internal" href="python_virtual_environments.html">Virtual Environments</a></li>
<li class="toctree-l1"><a class="reference internal" href="xonsh_projects.html">Xonsh Projects</a></li>
<li class="toctree-l1"><a class="reference internal" href="callable_aliases.html">Callable Aliases</a></li>
<li class="toctree-l1"><a class="reference internal" href="events_tutorial.html">Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="env.html">Environment</a></li>
<li class="toctree-l1"><a class="reference internal" href="completers.html">Tab-Completion</a></li>
<li class="toctree-l1"><a class="reference internal" href="xontrib.html">Extensions</a></li>
<li class="toctree-l1"><a class="reference internal" href="embedding.html">Embedding Xonsh</a></li>
<li class="toctree-l1"><a class="reference internal" href="debug.html">Debug</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">Xonsh API</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/xonsh/xontrib-template">Create an extension</a></li>
</ul>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="developer.html">Developer’s Guide</a><input aria-label="Toggle navigation of Developer’s Guide" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html">Xonsh Change Log</a></li>
<li class="toctree-l2"><a class="reference internal" href="talks_and_articles.html">Talks & Articles</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#see-also">See also</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="lib/index.html">Xonsh Library</a><input aria-label="Toggle navigation of Xonsh Library" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/lang/xonsh.parsers.lexer.html">xonsh.parsers.lexer</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/lang/xonsh.parser.html">xonsh.parser</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/lang/xonsh.parsers.ast.html">xonsh.parsers.ast</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/lang/xonsh.execer.html">xonsh.execer</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/lang/xonsh.imphooks.html">xonsh.imphooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/lang/xonsh.shell.html">xonsh.shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.built_ins.html">xonsh.built_ins</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.environ.html">xonsh.environ</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.aliases.html">xonsh.aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.dirstack.html">xonsh.dirstack</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.html">xonsh.procs</a><input aria-label="Toggle navigation of xonsh.procs" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.executables.html">xonsh.procs.executables</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.jobs.html">xonsh.procs.jobs</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.pipelines.html">xonsh.procs.pipelines</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.pipes.html">xonsh.procs.pipes</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.posix.html">xonsh.procs.posix</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.proxies.html">xonsh.procs.proxies</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.readers.html">xonsh.procs.readers</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.procs.specs.html">xonsh.procs.specs</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.lib.inspectors.html">xonsh.lib.inspectors</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.html">xonsh.history</a><input aria-label="Toggle navigation of xonsh.history" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.base.html">xonsh.history.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.diff_history.html">xonsh.history.diff_history</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.dummy.html">xonsh.history.dummy</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.json.html">xonsh.history.json</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.main.html">xonsh.history.main</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.sqlite.html">xonsh.history.sqlite</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completer.html">xonsh.completer</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.html">xonsh.completers</a><input aria-label="Toggle navigation of xonsh.completers" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.base.html">xonsh.completers.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.bash.html">xonsh.completers.bash</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.bash_completion.html">xonsh.completers.bash_completion</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.click.html">xonsh.completers.click</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.commands.html">xonsh.completers.commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.completer.html">xonsh.completers.completer</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.dirs.html">xonsh.completers.dirs</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.emoji.html">xonsh.completers.emoji</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.environment.html">xonsh.completers.environment</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.imports.html">xonsh.completers.imports</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.init.html">xonsh.completers.init</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.man.html">xonsh.completers.man</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.path.html">xonsh.completers.path</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.python.html">xonsh.completers.python</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.completers.tools.html">xonsh.completers.tools</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.html">xonsh.prompt</a><input aria-label="Toggle navigation of xonsh.prompt" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.base.html">xonsh.prompt.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.cwd.html">xonsh.prompt.cwd</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.env.html">xonsh.prompt.env</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.gitstatus.html">xonsh.prompt.gitstatus</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.job.html">xonsh.prompt.job</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.times.html">xonsh.prompt.times</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.prompt.vc.html">xonsh.prompt.vc</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.html">xonsh.shells</a><input aria-label="Toggle navigation of xonsh.shells" class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.base_shell.html">xonsh.shells.base_shell</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.dumb_shell.html">xonsh.shells.dumb_shell</a></li>
<li class="toctree-l3 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.html">xonsh.shells.ptk_shell</a><input aria-label="Toggle navigation of xonsh.shells.ptk_shell" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l4"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.completer.html">xonsh.shells.ptk_shell.completer</a></li>
<li class="toctree-l4"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.formatter.html">xonsh.shells.ptk_shell.formatter</a></li>
<li class="toctree-l4"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.history.html">xonsh.shells.ptk_shell.history</a></li>
<li class="toctree-l4"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.input_hook.html">xonsh.shells.ptk_shell.input_hook</a></li>
<li class="toctree-l4"><a class="reference internal" href="lib/_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="lib/_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="lib/_autosummary/cmd/xonsh.shells.readline_shell.html">xonsh.shells.readline_shell</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.base_shell.html">xonsh.shells.base_shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.readline_shell.html">xonsh.shells.readline_shell</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.html">xonsh.shells.ptk_shell</a><input aria-label="Toggle navigation of xonsh.shells.ptk_shell" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.completer.html">xonsh.shells.ptk_shell.completer</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.formatter.html">xonsh.shells.ptk_shell.formatter</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.history.html">xonsh.shells.ptk_shell.history</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.input_hook.html">xonsh.shells.ptk_shell.input_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.key_bindings.html">xonsh.shells.ptk_shell.key_bindings</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.shells.ptk_shell.updator.html">xonsh.shells.ptk_shell.updator</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.lib.pretty.html">xonsh.lib.pretty</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.history.diff_history.html">xonsh.history.diff_history</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.html">xonsh.xoreutils</a><input aria-label="Toggle navigation of xonsh.xoreutils" class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.cat.html">xonsh.xoreutils.cat</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.echo.html">xonsh.xoreutils.echo</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.pwd.html">xonsh.xoreutils.pwd</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.tee.html">xonsh.xoreutils.tee</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.tty.html">xonsh.xoreutils.tty</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.ulimit.html">xonsh.xoreutils.ulimit</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.umask.html">xonsh.xoreutils.umask</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.uname.html">xonsh.xoreutils.uname</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.uptime.html">xonsh.xoreutils.uptime</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.util.html">xonsh.xoreutils.util</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.which.html">xonsh.xoreutils.which</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.xcontext.html">xonsh.xoreutils.xcontext</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/cmd/xonsh.xoreutils.yes.html">xonsh.xoreutils.yes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.events.html">xonsh.events</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.html">xonsh.lib</a><input aria-label="Toggle navigation of xonsh.lib" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.collections.html">xonsh.lib.collections</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.completion_quoting.html">xonsh.lib.completion_quoting</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.inspectors.html">xonsh.lib.inspectors</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.itertools.html">xonsh.lib.itertools</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.jsonutils.html">xonsh.lib.jsonutils</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.lazyasd.html">xonsh.lib.lazyasd</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.lazyimps.html">xonsh.lib.lazyimps</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.lazyjson.html">xonsh.lib.lazyjson</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.modules.html">xonsh.lib.modules</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.openpy.html">xonsh.lib.openpy</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.os.html">xonsh.lib.os</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.pretty.html">xonsh.lib.pretty</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.string.html">xonsh.lib.string</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.subprocess.html">xonsh.lib.subprocess</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.tools.html">xonsh.tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.platform.html">xonsh.platform</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.lazyjson.html">xonsh.lib.lazyjson</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.lazyasd.html">xonsh.lib.lazyasd</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.lib.openpy.html">xonsh.lib.openpy</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.foreign_shells.html">xonsh.foreign_shells</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.commands_cache.html">xonsh.commands_cache</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.tracer.html">xonsh.tracer</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.main.html">xonsh.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.color_tools.html">xonsh.color_tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.pyghooks.html">xonsh.pyghooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.shells.dumb_shell.html">xonsh.shells.dumb_shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.wizard.html">xonsh.wizard</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.xonfig.html">xonsh.xonfig</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.xontribs.html">xonsh.xontribs</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.codecache.html">xonsh.codecache</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.contexts.html">xonsh.contexts</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.ansi_colors.html">xonsh.ansi_colors</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.style_tools.html">xonsh.style_tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.cli_utils.html">xonsh.cli_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.timings.html">xonsh.timings</a></li>
<li class="toctree-l2"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.pygments_cache.html">xonsh.pygments_cache</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.platforms.html">xonsh.platforms</a><input aria-label="Toggle navigation of xonsh.platforms" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.platforms.macutils.html">xonsh.platforms.macutils</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.platforms.win_colors.html">xonsh.platforms.win_colors</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.platforms.winutils.html">xonsh.platforms.winutils</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.webconfig.html">xonsh.webconfig</a><input aria-label="Toggle navigation of xonsh.webconfig" class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.webconfig.file_writes.html">xonsh.webconfig.file_writes</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.webconfig.main.html">xonsh.webconfig.main</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.webconfig.routes.html">xonsh.webconfig.routes</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.webconfig.tags.html">xonsh.webconfig.tags</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/helpers/xonsh.webconfig.xonsh_data.html">xonsh.webconfig.xonsh_data</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.html">xompletions</a><input aria-label="Toggle navigation of xompletions" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" role="switch" type="checkbox"/><label for="toctree-checkbox-14"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.cd.html">xompletions.cd</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.gh.html">xompletions.gh</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.git.html">xompletions.git</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.pip.html">xompletions.pip</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.python.html">xompletions.python</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.rmdir.html">xompletions.rmdir</a></li>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xompletions/xompletions.sudo.html">xompletions.sudo</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lib/_autosummary/xontribs/xontrib.html">xontrib</a><input aria-label="Toggle navigation of xontrib" class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" role="switch" type="checkbox"/><label for="toctree-checkbox-15"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="lib/_autosummary/xontribs/xontrib.coreutils.html">xontrib.coreutils</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="history_backend.html">History Backend</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="view-this-page">
<a class="muted-link" href="https://github.com/xonsh/xonsh/blob/main/docs/aliases.rst?plain=true" title="View this page">
<svg><use href="#svg-eye"></use></svg>
<span class="visually-hidden">View this page</span>
</a>
</div><div class="edit-this-page">
<a class="muted-link" href="https://github.com/xonsh/xonsh/edit/main/docs/aliases.rst" rel="edit" title="Edit this page">
<svg><use href="#svg-pencil"></use></svg>
<span class="visually-hidden">Edit this page</span>
</a>
</div><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></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">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="built-in-aliases">
<span id="aliases"></span><h1>Built-in Aliases<a class="headerlink" href="#built-in-aliases" title="Link to this heading">¶</a></h1>
<p>This page describes the xonsh built-in commands and aliases.</p>
<section id="well-known-commands">
<h2>Well-known commands<a class="headerlink" href="#well-known-commands" title="Link to this heading">¶</a></h2>
<section id="cd">
<h3><code class="docutils literal notranslate"><span class="pre">cd</span></code><a class="headerlink" href="#cd" title="Link to this heading">¶</a></h3>
<p>Changes the directory. If no directory is specified (i.e. if there are no arguments)
then this changes to the current user’s home directory.</p>
</section>
<section id="ls">
<h3><code class="docutils literal notranslate"><span class="pre">ls</span></code><a class="headerlink" href="#ls" title="Link to this heading">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">ls</span></code> command is aliased to <code class="docutils literal notranslate"><span class="pre">['ls',</span> <span class="pre">'--color=auto',</span> <span class="pre">'-v']</span></code> on Linux. On macOS,
FreeBSD, and DragonFlyBSD it is instead aliased to <code class="docutils literal notranslate"><span class="pre">['ls',</span> <span class="pre">'-G']</span></code>.
On NetBSD and OpenBSD no <code class="docutils literal notranslate"><span class="pre">ls</span></code> alias is defined.</p>
</section>
<section id="grep">
<h3><code class="docutils literal notranslate"><span class="pre">grep</span></code><a class="headerlink" href="#grep" title="Link to this heading">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">grep</span></code> command is aliased to <code class="docutils literal notranslate"><span class="pre">['grep',</span> <span class="pre">'--color=auto']</span></code>.</p>
</section>
<section id="timeit">
<h3><code class="docutils literal notranslate"><span class="pre">timeit</span></code><a class="headerlink" href="#timeit" title="Link to this heading">¶</a></h3>
<p>Runs timing study on arguments. Similar to IPython’s <code class="docutils literal notranslate"><span class="pre">%timeit</span></code> magic.</p>
</section>
<section id="exit-quit-eof">
<h3><code class="docutils literal notranslate"><span class="pre">exit</span></code>, <code class="docutils literal notranslate"><span class="pre">quit</span></code>, <code class="docutils literal notranslate"><span class="pre">EOF</span></code><a class="headerlink" href="#exit-quit-eof" title="Link to this heading">¶</a></h3>
<p>The commands <code class="docutils literal notranslate"><span class="pre">exit</span></code>, <code class="docutils literal notranslate"><span class="pre">EOF</span></code> and <code class="docutils literal notranslate"><span class="pre">quit</span></code> all alias the same action, which is to
leave xonsh in a safe manner. Typing <code class="docutils literal notranslate"><span class="pre">Ctrl-d</span></code> is the same as typing <code class="docutils literal notranslate"><span class="pre">EOF</span></code> and
pressing enter.</p>
<p><code class="docutils literal notranslate"><span class="pre">exit</span> <span class="pre">N</span></code> sets the shell’s exit code to <code class="docutils literal notranslate"><span class="pre">N</span></code> and stops the rest of the
current script:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="exit, quit, EOF example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">xonsh</span> <span class="o">-</span><span class="n">c</span> <span class="s1">'echo 1; exit 42; echo 3'</span>
<span class="go">1</span>
<span class="gp">@ </span><span class="o">@.</span><span class="n">lastcmd</span><span class="o">.</span><span class="n">rtn</span>
<span class="go">42</span>
</code></pre></div>
</div>
</section>
</section>
<section id="xonsh-specific-aliases">
<h2>Xonsh-specific Aliases<a class="headerlink" href="#xonsh-specific-aliases" title="Link to this heading">¶</a></h2>
<section id="history">
<h3><code class="docutils literal notranslate"><span class="pre">history</span></code><a class="headerlink" href="#history" title="Link to this heading">¶</a></h3>
<p>Tools for dealing with xonsh history. See <a class="reference external" href="history.html">the history tutorial</a>
for more information all the history command and all of its sub-commands.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-none notranslate"><meta itemprop="programmingLanguage" content="none"><meta itemprop="name" content="history example"><div class="highlight"><pre><code itemprop="text"><span></span>usage: history [-h]
{show,id,file,info,pull,flush,off,on,clear,delete,erasedups,gc,transfer} ...
Try 'history <command> --help' for more info
options:
-h, --help show this help message and exit
commands:
{show,id,file,info,pull,flush,off,on,clear,delete,erasedups,gc,transfer}
show Display history of a session, default command
id Display the current session id
file Display the current history filename
info Display information about the current history
pull Pull history from other parallel sessions.
flush Flush the current history to disk
off History will not be saved for this session
on History will be saved for the rest of the session (default)
clear One-time wipe of session history
delete Delete all commands matching a pattern
erasedups Remove duplicate commands, keeping only the latest occurrence of each
gc Launches a new history garbage collector
transfer Transfer entries between history backends.
</code></pre></div>
</div>
</section>
<section id="showcmd">
<h3><code class="docutils literal notranslate"><span class="pre">showcmd</span></code><a class="headerlink" href="#showcmd" title="Link to this heading">¶</a></h3>
<p>Displays how commands and arguments are evaluated. Use <code class="docutils literal notranslate"><span class="pre">-e</span></code> to expand aliases.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="showcmd example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">showcmd</span> <span class="n">echo</span> <span class="n">The</span> <span class="k">@</span><span class="p">(</span><span class="s1">'args'</span><span class="p">)</span> <span class="k">@</span><span class="p">([</span><span class="s1">'list'</span><span class="p">,</span> <span class="s1">'is'</span><span class="p">])</span> <span class="k">$</span><span class="p">(</span><span class="nb">echo</span> here<span class="p">)</span> <span class="s2">"and"</span> <span class="o">--</span><span class="n">say</span><span class="o">=</span><span class="s2">"hello"</span> <span class="n">to</span> <span class="k">@</span><span class="p">([])</span> <span class="n">you</span>
<span class="go">['echo', 'The', 'args', 'list', 'is', 'here', 'and', '--say="hello"', 'to', 'you']</span>
<span class="gp">@ </span><span class="n">showcmd</span> <span class="n">ls</span>
<span class="go">ls</span>
<span class="gp">@ </span><span class="n">showcmd</span> <span class="o">-</span><span class="n">e</span> <span class="n">ls</span>
<span class="go">['ls', '--group-directories-first', '-A', '--color']</span>
</code></pre></div>
</div>
</section>
<section id="xonfig">
<h3><code class="docutils literal notranslate"><span class="pre">xonfig</span></code><a class="headerlink" href="#xonfig" title="Link to this heading">¶</a></h3>
<p>Manages xonsh configuration information.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-none notranslate"><meta itemprop="programmingLanguage" content="none"><meta itemprop="name" content="xonfig example"><div class="highlight"><pre><code itemprop="text"><span></span>usage: xonfig [-h] {info,web,wizard,styles,colors,tutorial} ...
Manage xonsh configuration.
options:
-h, --help show this help message and exit
commands:
{info,web,wizard,styles,colors,tutorial}
info Displays configuration information
web Launch configurator in browser.
wizard Launch configurator in terminal
styles Prints available xonsh color styles
colors Preview color style
tutorial Launch tutorial in browser.
</code></pre></div>
</div>
</section>
<section id="xontrib">
<h3><code class="docutils literal notranslate"><span class="pre">xontrib</span></code><a class="headerlink" href="#xontrib" title="Link to this heading">¶</a></h3>
<p>Manages xonsh extensions. More information is available at <a class="reference internal" href="xontrib.html"><span class="doc">Extensions</span></a></p>
</section>
<section id="xcontext">
<span id="aliases-xcontext"></span><h3><code class="docutils literal notranslate"><span class="pre">xcontext</span></code><a class="headerlink" href="#xcontext" title="Link to this heading">¶</a></h3>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="xcontext example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">xcontext</span>
<span class="go">[Current xonsh session]</span>
<span class="go">xxonsh: /home/snail/.local/xonsh-env/bin/xonsh</span>
<span class="go">xpython: /home/snail/.local/xonsh-env/bin/python # Python 3.12.10</span>
<span class="go">xpip: /home/snail/.local/xonsh-env/bin/python -m pip</span>
<span class="go">[Current commands environment]</span>
<span class="go">xonsh: /home/snail/.local/xonsh-env/bin/xonsh</span>
<span class="go">python: /usr/bin/python # Python 3.11.6</span>
<span class="go">pip: /usr/bin/pip</span>
<span class="go">CONDA_DEFAULT_ENV: my-env</span>
</code></pre></div>
</div>
<p>Report information about the current xonsh environment, including paths to the Python interpreter, pip, xonsh itself, and relevant environment variables.</p>
<p>By default, symlinks in the displayed paths are resolved to their real targets; pass <code class="docutils literal notranslate"><span class="pre">--no-resolve</span></code> (<code class="docutils literal notranslate"><span class="pre">-n</span></code>) to show the raw paths instead.</p>
</section>
<section id="xpip">
<span id="aliases-xpip"></span><h3><code class="docutils literal notranslate"><span class="pre">xpip</span></code><a class="headerlink" href="#xpip" title="Link to this heading">¶</a></h3>
<p>Runs the <code class="docutils literal notranslate"><span class="pre">pip</span></code> package manager for xonsh itself. Useful for installations where xonsh is in an
isolated environment (e.g. conda, mamba, homebrew).</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="xpip example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">which</span> <span class="n">pip</span>
<span class="go">/usr/bin/pip # system pip</span>
<span class="gp">@ </span><span class="n">which</span> <span class="n">xpip</span>
<span class="go">/home/snail/.local/xonsh-env/bin/python -m pip # current xonsh session pip</span>
<span class="gp">@ </span><span class="n">xpip</span> <span class="n">install</span> <span class="n">fire</span>
<span class="gp">@ </span><span class="kn">import</span><span class="w"> </span><span class="err">fire</span>
<span class="gp">@ </span><span class="n">fire</span>
<span class="go"><module 'fire' from '/home/snail/.local/xonsh-env/lib/python3.11/site-packages/fire/__init__.py'></span>
</code></pre></div>
</div>
</section>
<section id="xpython">
<h3><code class="docutils literal notranslate"><span class="pre">xpython</span></code><a class="headerlink" href="#xpython" title="Link to this heading">¶</a></h3>
<p>Alias to the Python interpreter that is currently running xonsh (<code class="docutils literal notranslate"><span class="pre">sys.executable</span></code>). This is useful for running Python modules or scripts in the same environment as the shell itself, especially in complex setups like AppImage.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="xpython example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">python</span> <span class="o">-</span><span class="n">V</span>
<span class="go">Python 3.12.10</span>
<span class="gp">@ </span><span class="n">xpython</span> <span class="o">-</span><span class="n">V</span>
<span class="go">Python 3.11.9</span>
<span class="gp">@ </span><span class="n">which</span> <span class="n">python</span>
<span class="go">/opt/homebrew/bin/python</span>
<span class="gp">@ </span><span class="n">which</span> <span class="n">xpython</span>
<span class="go">/home/snail/.local/xonsh-env/bin/python</span>
</code></pre></div>
</div>
</section>
<section id="xxonsh">
<span id="aliases-xxonsh"></span><h3><code class="docutils literal notranslate"><span class="pre">xxonsh</span></code><a class="headerlink" href="#xxonsh" title="Link to this heading">¶</a></h3>
<p>Launches exactly the same <code class="docutils literal notranslate"><span class="pre">xonsh</span></code> that was used to start the current session.</p>
<p>See <a class="reference internal" href="launch.html#launch-xxonsh"><span class="std std-ref">Launching the Same Xonsh (xxonsh)</span></a> for a worked example of using it as a building block to
launch <code class="docutils literal notranslate"><span class="pre">tmux</span></code> with this exact xonsh (the <code class="docutils literal notranslate"><span class="pre">xtmux</span></code> recipe).</p>
<p>Mnemonic: think of the initial ‘x’ as ‘c’—xxonsh stands for (c)urrent xonsh.</p>
</section>
<section id="xreset">
<h3><code class="docutils literal notranslate"><span class="pre">xreset</span></code><a class="headerlink" href="#xreset" title="Link to this heading">¶</a></h3>
<p>Clean the xonsh context. All user variables will be deleted.</p>
</section>
<section id="trace">
<h3><code class="docutils literal notranslate"><span class="pre">trace</span></code><a class="headerlink" href="#trace" title="Link to this heading">¶</a></h3>
<p>Provides an interface to printing lines of source code prior to their execution.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-none notranslate"><meta itemprop="programmingLanguage" content="none"><meta itemprop="name" content="trace example"><div class="highlight"><pre><code itemprop="text"><span></span>usage: trace [-h] {on,start,add,off,stop,del,rm,color,ls} ...
Tool for tracing xonsh code as it runs.
options:
-h, --help show this help message and exit
commands:
{on,start,add,off,stop,del,rm,color,ls}
on (start, add) begins tracing selected files.
off (stop, del, rm)
removes selected files fom tracing.
color (ls) output color management for tracer
</code></pre></div>
</div>
</section>
<section id="exec-and-xexec">
<h3><code class="docutils literal notranslate"><span class="pre">exec</span></code> and <code class="docutils literal notranslate"><span class="pre">xexec</span></code><a class="headerlink" href="#exec-and-xexec" title="Link to this heading">¶</a></h3>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-none notranslate"><meta itemprop="programmingLanguage" content="none"><meta itemprop="name" content="exec and xexec example"><div class="highlight"><pre><code itemprop="text"><span></span>usage: xexec [-h] [-l] [-c] [-a NAME] ...
exec (also aliased as xexec) uses the os.execvpe() function to
replace the xonsh process with the specified program.
This provides the functionality of the bash 'exec' builtin::
>>> exec bash -l -i
bash $
positional arguments:
command program to launch along its arguments
options:
-h, --help show this help message and exit
-l, --login the shell places a dash at the
beginning of the zeroth argument passed to command to simulate login
shell.
-c, --clean causes command to be executed with an empty environment.
-a, --name NAME the shell passes name as the zeroth argument
to the executed command.
Notes
-----
This command **is not** the same as the Python builtin function
exec(). That function is for running Python code. This command,
which shares the same name as the sh-lang statement, is for launching
a command directly in the same process. In the event of a name conflict,
please use the xexec command directly or dive into subprocess mode
explicitly with ![exec command]. For more details, please see
http://xon.sh/faq.html#exec.
</code></pre></div>
</div>
</section>
</section>
<section id="command-decorators">
<span id="id1"></span><h2>Command Decorators<a class="headerlink" href="#command-decorators" title="Link to this heading">¶</a></h2>
<section id="error-raise-and-error-ignore">
<h3><code class="docutils literal notranslate"><span class="pre">@error_raise</span></code> and <code class="docutils literal notranslate"><span class="pre">@error_ignore</span></code><a class="headerlink" href="#error-raise-and-error-ignore" title="Link to this heading">¶</a></h3>
<p>Use <code class="docutils literal notranslate"><span class="pre">@error_raise</span></code> to raise an exception if the command returns a non-zero exit code —
similar to <code class="docutils literal notranslate"><span class="pre">$XONSH_SUBPROC_CMD_RAISE_ERROR</span></code> but scoped to a single command, and it
raises unconditionally (even inside <code class="docutils literal notranslate"><span class="pre">&&</span></code>/<code class="docutils literal notranslate"><span class="pre">||</span></code> chains and even when
<code class="docutils literal notranslate"><span class="pre">$XONSH_SUBPROC_RAISE_ERROR</span></code> is disabled). Use <code class="docutils literal notranslate"><span class="pre">@error_ignore</span></code> to explicitly suppress
the raise — it also wins over the chain-result check performed by
<code class="docutils literal notranslate"><span class="pre">$XONSH_SUBPROC_RAISE_ERROR</span></code>.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@error_raise and @error_ignore example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">r</span> <span class="o">=</span> <span class="k">!</span><span class="p">(</span><span class="nb">@error_raise</span> ls nonono<span class="p">)</span>
<span class="go">subprocess.CalledProcessError: Command '['@error_raise', 'ls', 'nonono']' returned non-zero exit status 1.</span>
<span class="gp">@ </span><span class="n">r</span> <span class="o">=</span> <span class="k">!</span><span class="p">(</span><span class="nb">@error_ignore</span> ls nonono<span class="p">)</span>
</code></pre></div>
</div>
</section>
<section id="thread-and-unthread">
<h3><code class="docutils literal notranslate"><span class="pre">@thread</span></code> and <code class="docutils literal notranslate"><span class="pre">@unthread</span></code><a class="headerlink" href="#thread-and-unthread" title="Link to this heading">¶</a></h3>
<p>Use <code class="docutils literal notranslate"><span class="pre">@thread</span></code> and <code class="docutils literal notranslate"><span class="pre">@unthread</span></code> to run command as threadable or unthreadable e.g to have a result of SSH command:</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@thread and @unthread example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="k">!</span><span class="p">(</span><span class="nb">@thread</span> ssh host -T <span class="s2">"echo 1"</span><span class="p">)</span>
</code></pre></div>
</div>
</section>
<section id="path-and-paths">
<h3><code class="docutils literal notranslate"><span class="pre">@path</span></code> and <code class="docutils literal notranslate"><span class="pre">@paths</span></code><a class="headerlink" href="#path-and-paths" title="Link to this heading">¶</a></h3>
<p>Use <code class="docutils literal notranslate"><span class="pre">@path</span></code> and <code class="docutils literal notranslate"><span class="pre">@paths</span></code> to get Path object(s) from the command output.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@path and @paths example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="nb">dir</span> <span class="o">=</span> <span class="k">$</span><span class="p">(</span><span class="nb">@path</span> echo <span class="s1">'/bin'</span><span class="p">)</span>
<span class="gp"> </span><span class="nb">dir</span><span class="o">.</span><span class="n">exists</span><span class="p">()</span>
<span class="gp">@ </span><span class="n">dirs</span> <span class="o">=</span> <span class="k">$</span><span class="p">(</span><span class="nb">@paths</span> echo <span class="s1">'/bin\n/etc'</span><span class="p">)</span>
<span class="gp"> </span><span class="p">[</span><span class="n">p</span><span class="o">.</span><span class="n">exists</span><span class="p">()</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">dirs</span><span class="p">]</span>
</code></pre></div>
</div>
</section>
<section id="lines">
<h3><code class="docutils literal notranslate"><span class="pre">@lines</span></code><a class="headerlink" href="#lines" title="Link to this heading">¶</a></h3>
<p>Return output as list of lines.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@lines example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">lines</span> <span class="o">=</span> <span class="k">$</span><span class="p">(</span><span class="nb">@lines</span> cat file<span class="p">)</span>
</code></pre></div>
</div>
</section>
<section id="stream">
<h3><code class="docutils literal notranslate"><span class="pre">@stream</span></code><a class="headerlink" href="#stream" title="Link to this heading">¶</a></h3>
<p>Return output as stream of lines. This is useful when <code class="docutils literal notranslate"><span class="pre">$XONSH_SUBPROC_OUTPUT_FORMAT</span></code> is set to <code class="docutils literal notranslate"><span class="pre">list_lines</span></code>.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@stream example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="nb">str</span> <span class="o">=</span> <span class="k">$</span><span class="p">(</span><span class="nb">@stream</span> cat file<span class="p">)</span>
</code></pre></div>
</div>
</section>
<section id="json">
<h3><code class="docutils literal notranslate"><span class="pre">@json</span></code><a class="headerlink" href="#json" title="Link to this heading">¶</a></h3>
<p>Parses JSON and returns a JSON object.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@json example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">data</span> <span class="o">=</span> <span class="k">$</span><span class="p">(</span><span class="nb">@json</span> curl https://example.com/data.json<span class="p">)</span>
</code></pre></div>
</div>
</section>
<section id="jsonl">
<h3><code class="docutils literal notranslate"><span class="pre">@jsonl</span></code><a class="headerlink" href="#jsonl" title="Link to this heading">¶</a></h3>
<p>Parses JSON lines and returns a list of JSON objects.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@jsonl example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">items</span> <span class="o">=</span> <span class="k">$</span><span class="p">(</span><span class="nb">@jsonl</span> cat data.jsonl<span class="p">)</span>
</code></pre></div>
</div>
</section>
<section id="yaml">
<h3><code class="docutils literal notranslate"><span class="pre">@yaml</span></code><a class="headerlink" href="#yaml" title="Link to this heading">¶</a></h3>
<p>Parses YAML and returns a dict.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@yaml example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">config</span> <span class="o">=</span> <span class="k">$</span><span class="p">(</span><span class="nb">@yaml</span> cat config.yaml<span class="p">)</span>
</code></pre></div>
</div>
</section>
<section id="toml">
<h3><code class="docutils literal notranslate"><span class="pre">@toml</span></code><a class="headerlink" href="#toml" title="Link to this heading">¶</a></h3>
<p>Parses TOML and returns a dict.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@toml example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">config</span> <span class="o">=</span> <span class="k">$</span><span class="p">(</span><span class="nb">@toml</span> cat pyproject.toml<span class="p">)</span>
</code></pre></div>
</div>
</section>
<section id="xml">
<h3><code class="docutils literal notranslate"><span class="pre">@xml</span></code><a class="headerlink" href="#xml" title="Link to this heading">¶</a></h3>
<p>Parses XML and returns an <code class="xref py py-class docutils literal notranslate"><span class="pre">xml.etree.ElementTree.Element</span></code>. Navigate it
with <code class="docutils literal notranslate"><span class="pre">.tag</span></code>, <code class="docutils literal notranslate"><span class="pre">.attrib</span></code>, <code class="docutils literal notranslate"><span class="pre">.text</span></code>, <code class="docutils literal notranslate"><span class="pre">.find()</span></code>, <code class="docutils literal notranslate"><span class="pre">.findall()</span></code>, etc.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@xml example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">feed</span> <span class="o">=</span> <span class="k">$</span><span class="p">(</span><span class="nb">@xml</span> curl -s https://github.com/xonsh/xonsh/releases.atom<span class="p">)</span>
<span class="gp"> </span><span class="n">ns</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'a'</span><span class="p">:</span> <span class="s1">'http://www.w3.org/2005/Atom'</span><span class="p">}</span>
<span class="gp"> </span><span class="p">[</span><span class="n">e</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">'a:title'</span><span class="p">,</span> <span class="n">ns</span><span class="p">)</span><span class="o">.</span><span class="n">text</span> <span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="n">feed</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="s1">'a:entry'</span><span class="p">,</span> <span class="n">ns</span><span class="p">)[:</span><span class="mi">5</span><span class="p">]]</span>
<span class="go">['v0.23.6', 'v0.23.5', 'v0.23.4', 'v0.23.3', 'v0.23.2']</span>
</code></pre></div>
</div>
</section>
<section id="lxml">
<h3><code class="docutils literal notranslate"><span class="pre">@lxml</span></code><a class="headerlink" href="#lxml" title="Link to this heading">¶</a></h3>
<p>Parses XML with <a class="reference external" href="https://lxml.de/">lxml</a> and returns an <code class="docutils literal notranslate"><span class="pre">lxml.etree._Element</span></code>.
Adds full XPath, richer error messages, and faster parsing on top of the
stdlib <code class="docutils literal notranslate"><span class="pre">@xml</span></code>. Registered only when <code class="docutils literal notranslate"><span class="pre">lxml</span></code> is installed
(<code class="docutils literal notranslate"><span class="pre">xpip</span> <span class="pre">install</span> <span class="pre">lxml</span></code>).</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-xonshcon notranslate"><meta itemprop="programmingLanguage" content="xonsh"><meta itemprop="name" content="@lxml example"><div class="highlight"><pre><code itemprop="text"><span></span><span class="gp">@ </span><span class="n">feed</span> <span class="o">=</span> <span class="k">$</span><span class="p">(</span><span class="nb">@lxml</span> curl -s https://github.com/xonsh/xonsh/releases.atom<span class="p">)</span>
<span class="gp"> </span><span class="n">ns</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'a'</span><span class="p">:</span> <span class="s1">'http://www.w3.org/2005/Atom'</span><span class="p">}</span>
<span class="gp"> </span><span class="n">feed</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">'//a:entry/a:title/text()'</span><span class="p">,</span> <span class="n">namespaces</span><span class="o">=</span><span class="n">ns</span><span class="p">)[:</span><span class="mi">5</span><span class="p">]</span>
<span class="go">['v0.23.6', 'v0.23.5', 'v0.23.4', 'v0.23.3', 'v0.23.2']</span>
</code></pre></div>
</div>
</section>
</section>
<section id="directory-stack">
<h2>Directory Stack<a class="headerlink" href="#directory-stack" title="Link to this heading">¶</a></h2>
<section id="pushd">
<h3><code class="docutils literal notranslate"><span class="pre">pushd</span></code><a class="headerlink" href="#pushd" title="Link to this heading">¶</a></h3>
<p>Adds a directory to the top of the directory stack, or rotates the stack,
making the new top of the stack the current working directory.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-none notranslate"><meta itemprop="programmingLanguage" content="none"><meta itemprop="name" content="pushd example"><div class="highlight"><pre><code itemprop="text"><span></span>usage: pushd [-h] [-n] [-q] [+N|-N|dir]
Adds a directory to the top of the directory stack, or rotates the stack,
making the new top of the stack the current working directory.
On Windows, if the path is a UNC path (begins with `\\<server>\<share>`) and if the `DisableUNCCheck` registry
value is not enabled, creates a temporary mapped drive letter and sets the working directory there, emulating
behavior of `PUSHD` in `CMD.EXE`
positional arguments:
+N|-N|dir * dir :
Makes dir be the top of the stack,
making it the new current directory as if it had been supplied as an argument to the cd builtin.
* +N :
Brings the Nth directory (counting from the left of the list printed by dirs, starting with zero)
to the top of the list by rotating the stack.
* -N :
Brings the Nth directory (counting from the right of the list printed by dirs, starting with zero)
to the top of the list by rotating the stack.
options:
-h, --help show this help message and exit
-n, --cd Suppresses the normal change of directory when adding directories to the stack,
so that only the stack is manipulated.
-q, --quiet Do not call dirs, regardless of $PUSHD_SILENT
</code></pre></div>
</div>
</section>
<section id="popd">
<h3><code class="docutils literal notranslate"><span class="pre">popd</span></code><a class="headerlink" href="#popd" title="Link to this heading">¶</a></h3>
<p>Removes entries from the directory stack.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-none notranslate"><meta itemprop="programmingLanguage" content="none"><meta itemprop="name" content="popd example"><div class="highlight"><pre><code itemprop="text"><span></span>usage: popd [-h] [-n] [-q] [+N|-N]
When no arguments are given, popd removes the top directory from the stack
and performs a cd to the new top directory.
The elements are numbered from 0 starting at the first directory listed with ``dirs``;
that is, popd is equivalent to popd +0.
positional arguments:
+N|-N Removes the Nth directory (counting from the left/right of the list printed by dirs w.r.t. -/+ prefix),
starting with zero.
options:
-h, --help show this help message and exit
-n, --cd Suppresses the normal change of directory when removing directories from the stack,
so that only the stack is manipulated.
-q, --quiet Do not call dirs, regardless of $PUSHD_SILENT
</code></pre></div>
</div>
</section>
<section id="dirs">
<h3><code class="docutils literal notranslate"><span class="pre">dirs</span></code><a class="headerlink" href="#dirs" title="Link to this heading">¶</a></h3>
<p>Displays the list of currently remembered directories. Can also be used to clear the
directory stack.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-none notranslate"><meta itemprop="programmingLanguage" content="none"><meta itemprop="name" content="dirs example"><div class="highlight"><pre><code itemprop="text"><span></span>usage: dirs [-h] [-c] [-p] [-v] [-l] [N]
Manage the list of currently remembered directories.
positional arguments:
N Displays the Nth directory (counting from the left/right according to +/x prefix respectively),
starting with zero
options:
-h, --help show this help message and exit
-c Clears the directory stack by deleting all of the entries.
-p Print the directory stack with one entry per line.
-v Print the directory stack with one entry per line,
prefixing each entry with its index in the stack.
-l Produces a longer listing; the default listing format
uses a tilde to denote the home directory.
</code></pre></div>
</div>
</section>
</section>
<section id="jobs">
<h2>Jobs<a class="headerlink" href="#jobs" title="Link to this heading">¶</a></h2>
<section id="id3">
<h3><code class="docutils literal notranslate"><span class="pre">jobs</span></code><a class="headerlink" href="#id3" title="Link to this heading">¶</a></h3>
<p>Display a list of all current jobs.</p>
</section>
<section id="fg">
<h3><code class="docutils literal notranslate"><span class="pre">fg</span></code><a class="headerlink" href="#fg" title="Link to this heading">¶</a></h3>
<p>Bring the currently active job to the foreground, or, if a single number is
given as an argument, bring that job to the foreground.</p>
</section>
<section id="bg">
<h3><code class="docutils literal notranslate"><span class="pre">bg</span></code><a class="headerlink" href="#bg" title="Link to this heading">¶</a></h3>
<p>Resume execution of the currently active job in the background, or, if a
single number is given as an argument, resume that job in the background.</p>
</section>
<section id="disown">
<h3><code class="docutils literal notranslate"><span class="pre">disown</span></code><a class="headerlink" href="#disown" title="Link to this heading">¶</a></h3>
<p>The behavior of this command matches the behavior of zsh’s disown
command which is as follows:</p>
<p>Remove the specified jobs from the job table; the shell will no longer
report their status, and will not complain if you try to exit an
interactive shell with them running or stopped. If no job is specified,
disown the current job.
If the jobs are currently stopped and the $AUTO_CONTINUE option is set
($AUTO_CONTINUE = True), a warning is printed containing information about
how to make them running after they have been disowned. If one of the
latter two forms is used, the jobs will automatically be made running,
independent of the setting of the $AUTO_CONTINUE option.</p>
</section>
</section>
<section id="source-aliases">
<h2>Source Aliases<a class="headerlink" href="#source-aliases" title="Link to this heading">¶</a></h2>
<section id="source">
<h3><code class="docutils literal notranslate"><span class="pre">source</span></code><a class="headerlink" href="#source" title="Link to this heading">¶</a></h3>
<p>Executes the contents of the provided files in the current context. This, of course,
only works on xonsh and Python files (<code class="docutils literal notranslate"><span class="pre">*.xsh</span></code>, <code class="docutils literal notranslate"><span class="pre">*.py</span></code>). Use <code class="docutils literal notranslate"><span class="pre">-e</span></code> to ignore
extension.</p>
</section>
<section id="source-foreign">
<h3><code class="docutils literal notranslate"><span class="pre">source-foreign</span></code><a class="headerlink" href="#source-foreign" title="Link to this heading">¶</a></h3>
<p>Like the <code class="docutils literal notranslate"><span class="pre">source</span></code> command but for files in foreign (non-xonsh) languages.
It will pick up the environment and any aliases.</p>
<p>Supported shells: <code class="docutils literal notranslate"><span class="pre">bash</span></code>, <code class="docutils literal notranslate"><span class="pre">zsh</span></code>, <code class="docutils literal notranslate"><span class="pre">sh</span></code> (also <code class="docutils literal notranslate"><span class="pre">dash</span></code>, <code class="docutils literal notranslate"><span class="pre">ash</span></code>,
<code class="docutils literal notranslate"><span class="pre">ksh</span></code>, <code class="docutils literal notranslate"><span class="pre">mksh</span></code>, <code class="docutils literal notranslate"><span class="pre">pdksh</span></code>), and <code class="docutils literal notranslate"><span class="pre">cmd</span></code> on Windows. Absolute paths
like <code class="docutils literal notranslate"><span class="pre">/bin/bash</span></code> or <code class="docutils literal notranslate"><span class="pre">/bin/sh</span></code> are canonicalised to the same
defaults.</p>
<p>The convenience wrappers below pre-set the <code class="docutils literal notranslate"><span class="pre">shell</span></code> and <code class="docutils literal notranslate"><span class="pre">--sourcer</span></code>
arguments for the most common cases — every flag accepted by
<code class="docutils literal notranslate"><span class="pre">source-foreign</span></code> is available on them as well.</p>
<div itemscope itemtype="https://schema.org/SoftwareSourceCode" class="highlight-none notranslate"><meta itemprop="programmingLanguage" content="none"><meta itemprop="name" content="source-foreign example"><div class="highlight"><pre><code itemprop="text"><span></span>usage: source-foreign [-h] [-i] [-l] [--envcmd ENVCMD] [--aliascmd ALIASCMD]
[--extra-args EXTRA_ARGS] [-u] [-p PREVCMD]
[--postcmd POSTCMD] [--funcscmd FUNCSCMD]
[--sourcer SOURCER] [--use-tmpfile]
[--seterrprevcmd SETERRPREVCMD]
[--seterrpostcmd SETERRPOSTCMD] [--overwrite-aliases]
[--suppress-skip-message] [--show] [--show-output] [-d]
[-n]
shell files_or_code [files_or_code ...]
Sources a file written in a foreign shell language.
positional arguments:
shell Name or path to the foreign shell
files_or_code file paths to source or code in the target language.
options:
-h, --help show this help message and exit
-i, --interactive whether the sourced shell should be interactive
-l, --login whether the sourced shell should be login
--envcmd ENVCMD command to print environment
--aliascmd ALIASCMD command to print aliases
--extra-args EXTRA_ARGS
extra arguments needed to run the shell
-u, --unsafe whether the source shell should be run safely, and not raise any errors, even if they occur.
-p, --prevcmd PREVCMD
command(s) to run before any other commands, replaces traditional source.
--postcmd POSTCMD command(s) to run after all other commands
--funcscmd FUNCSCMD code to find locations of all native functions in the shell language.
--sourcer SOURCER the source command in the target shell language.
If this is not set, a default value will attempt to be
looked up based on the shell name.
--use-tmpfile whether the commands for source shell should be written to a temporary file.
--seterrprevcmd SETERRPREVCMD
command(s) to set exit-on-error before any other commands.
--seterrpostcmd SETERRPOSTCMD
command(s) to set exit-on-error after all other commands.
--overwrite-aliases flag for whether or not sourced aliases should replace the current xonsh aliases.
--suppress-skip-message
flag for whether or not skip messages should be suppressed.
--show show the generated shell command that will be sent to the foreign
shell (does not show what the sourced script prints — see
``--show-output`` for that).
--show-output forward stdout and stderr produced by the sourced script to the
xonsh terminal. By default they are silently discarded.
-d, --dry-run Will not actually source the file.
-n, --non-interactive
Deprecated: The default mode runs in non-interactive mode.
</code></pre></div>
</div>
<section id="source-sh">
<h4><code class="docutils literal notranslate"><span class="pre">source-sh</span></code><a class="headerlink" href="#source-sh" title="Link to this heading">¶</a></h4>
<p>Thin wrapper around <code class="docutils literal notranslate"><span class="pre">source-foreign</span> <span class="pre">sh</span></code> with <code class="docutils literal notranslate"><span class="pre">--sourcer</span> <span class="pre">.</span></code> (the POSIX