-
Notifications
You must be signed in to change notification settings - Fork 17
/
rtx.sh
1045 lines (966 loc) · 45.8 KB
/
rtx.sh
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
#!/usr/bin/env bash
# Automatic generated, DON'T MODIFY IT.
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @flag -V --version Print version
# {{ rtx activate
# @cmd Initializes mise in the current shell session
# @option -C --cd <DIR> Change directory before running command
# @flag --shims Use shims instead of modifying PATH Effectively the same as:
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg shell_type[bash|fish|nu|xonsh|zsh] Shell type to generate the script for
activate() {
:;
}
# }} rtx activate
# {{ rtx alias
# @cmd Manage aliases [aliases: a]
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @option -p --plugin filter aliases by plugin
# @flag --no-header Don't show table header
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help
alias() {
:;
}
# {{{ rtx alias get
# @cmd Show an alias for a plugin
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg plugin![`_choice_plugin`] The plugin to show the alias for
# @arg alias![`_choice_alias`] The alias to show
alias::get() {
:;
}
# }}} rtx alias get
# {{{ rtx alias ls
# @cmd List aliases Shows the aliases that can be specified.
# @option -C --cd <DIR> Change directory before running command
# @flag --no-header Don't show table header
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg plugin[`_choice_plugin`] Show aliases for <PLUGIN>
alias::ls() {
:;
}
# }}} rtx alias ls
# {{{ rtx alias set
# @cmd Add/update an alias for a plugin [aliases: add, create]
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg plugin![`_choice_plugin`] The plugin to set the alias for
# @arg alias![`_choice_alias`] The alias to set
# @arg value! The value to set the alias to
alias::set() {
:;
}
# }}} rtx alias set
# {{{ rtx alias unset
# @cmd Clears an alias for a plugin [aliases: rm, remove, delete, del]
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg plugin![`_choice_plugin`] The plugin to remove the alias from
# @arg alias![`_choice_alias`] The alias to remove
alias::unset() {
:;
}
# }}} rtx alias unset
# }} rtx alias
# {{ rtx backends
# @cmd Manage backends [aliases: b]
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help
backends() {
:;
}
# {{{ rtx backends ls
# @cmd List built-in backends [aliases: list]
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
backends::ls() {
:;
}
# }}} rtx backends ls
# }} rtx backends
# {{ rtx bin-paths
# @cmd List all the active runtime bin paths
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help
bin-paths() {
:;
}
# }} rtx bin-paths
# {{ rtx cache
# @cmd Manage the mise cache
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
cache() {
:;
}
# {{{ rtx cache clear
# @cmd Deletes all cache files in mise [aliases: c]
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help
# @arg plugin*[`_choice_plugin`] Plugin(s) to clear cache for e.g.: node, python
cache::clear() {
:;
}
# }}} rtx cache clear
# }} rtx cache
# {{ rtx completion
# @cmd Generate shell completions
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg shell[bash|fish|zsh] Shell type to generate completions for
completion() {
:;
}
# }} rtx completion
# {{ rtx config
# @cmd [experimental] Manage config files [aliases: cfg]
# @option -C --cd <DIR> Change directory before running command
# @flag --no-header Do not print table header
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help
config() {
:;
}
# {{{ rtx config ls
# @cmd [experimental] List config files currently in use
# @option -C --cd <DIR> Change directory before running command
# @flag --no-header Do not print table header
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
config::ls() {
:;
}
# }}} rtx config ls
# {{{ rtx config generate
# @cmd [experimental] Generate an .mise.toml file [aliases: g]
# @option -C --cd <DIR> Change directory before running command
# @option -o --output Output to file instead of stdout
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
config::generate() {
:;
}
# }}} rtx config generate
# }} rtx config
# {{ rtx current
# @cmd Shows current active and installed runtime versions
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg plugin[`_choice_plugin`] Plugin to show versions of e.g.: ruby, node, cargo:eza, npm:prettier, etc
current() {
:;
}
# }} rtx current
# {{ rtx deactivate
# @cmd Disable mise for current shell session
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
deactivate() {
:;
}
# }} rtx deactivate
# {{ rtx direnv
# @cmd Output direnv function to use mise inside direnv
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
direnv() {
:;
}
# {{{ rtx direnv activate
# @cmd Output direnv function to use mise inside direnv
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
direnv::activate() {
:;
}
# }}} rtx direnv activate
# }} rtx direnv
# {{ rtx doctor
# @cmd Check mise installation for possible problems [aliases: dr]
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
doctor() {
:;
}
# }} rtx doctor
# {{ rtx env
# @cmd Exports env vars to activate mise a single time [aliases: e]
# @option -C --cd <DIR> Change directory before running command
# @flag -J --json Output in JSON format
# @option -s --shell[bash|fish|nu|xonsh|zsh] Shell type to generate environment variables for
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg tool-version*[`_choice_tool_version`] <TOOL@VERSION> Tool(s) to use
env() {
:;
}
# }} rtx env
# {{ rtx exec
# @cmd Execute a command with tool(s) set [aliases: x]
# @option -c --command <C> Command string to execute
# @option -C --cd <DIR> Change directory before running command
# @option -j --jobs Number of jobs to run in parallel [default: 4]
# @flag --raw Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg tool-version*[`_choice_tool_version`] <TOOL@VERSION> Tool(s) to start e.g.: node@20 python@3.10
# @arg command* Command string to execute (same as --command)
exec() {
:;
}
# }} rtx exec
# {{ rtx generate
# @cmd [experimental] Generate files for various tools/services [aliases: gen]
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help
generate() {
:;
}
# {{{ rtx generate git-pre-commit
# @cmd [experimental] Generate a git pre-commit hook [aliases: pre-commit]
# @option -C --cd <DIR> Change directory before running command
# @option --hook Which hook to generate (saves to .git/hooks/$hook)
# @option -t --task The task to run when the pre-commit hook is triggered
# @flag -w --write write to .git/hooks/pre-commit and make it executable
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
generate::git-pre-commit() {
:;
}
# }}} rtx generate git-pre-commit
# {{{ rtx generate github-action
# @cmd [experimental] Generate a GitHub Action workflow file
# @option -C --cd <DIR> Change directory before running command
# @option -n --name the name of the workflow to generate
# @option -t --task The task to run when the workflow is triggered
# @flag -w --write write to .github/workflows/$name.yml
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
generate::github-action() {
:;
}
# }}} rtx generate github-action
# }} rtx generate
# {{ rtx implode
# @cmd Removes mise CLI and all related data
# @option -C --cd <DIR> Change directory before running command
# @flag --config Also remove config directory
# @flag -n --dry-run List directories that would be removed without actually removing them
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
implode() {
:;
}
# }} rtx implode
# {{ rtx install
# @cmd Install a tool version [aliases: i]
# @option -C --cd <DIR> Change directory before running command
# @flag -f --force Force reinstall even if already installed
# @option -j --jobs Number of jobs to run in parallel [default: 4]
# @flag --raw Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show installation output
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg tool-version*[`_choice_all_tools`] <TOOL@VERSION> Tool(s) to install e.g.: node@20
install() {
:;
}
# }} rtx install
# {{ rtx latest
# @cmd Gets the latest available version for a plugin
# @option -C --cd <DIR> Change directory before running command
# @flag -i --installed Show latest installed instead of available version
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg tool-version![`_choice_tool_version`] <TOOL@VERSION> Tool to get the latest version of
latest() {
:;
}
# }} rtx latest
# {{ rtx link
# @cmd Symlinks a tool version into mise [aliases: ln]
# @option -C --cd <DIR> Change directory before running command
# @flag -f --force Overwrite an existing tool version if it exists
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg tool-version![`_choice_tool_version`] <TOOL@VERSION> Tool name and version to create a symlink for
# @arg path! The local path to the tool version e.g.: ~/.nvm/versions/node/v20.0.0
link() {
:;
}
# }} rtx link
# {{ rtx ls
# @cmd List installed and active tool versions [aliases: list]
# @option -C --cd <DIR> Change directory before running command
# @flag -c --current Only show tool versions currently specified in a .tool-versions/.mise.toml
# @flag -g --global Only show tool versions currently specified in a the global .tool-versions/.mise.toml
# @flag -i --installed Only show tool versions that are installed (Hides tools defined in .tool-versions/.mise.toml but not installed)
# @flag -q --quiet Suppress non-error messages
# @flag -J --json Output in JSON format
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -m --missing Display missing tool versions
# @flag -y --yes Answer yes to all confirmation prompts
# @option --prefix Display versions matching this prefix
# @flag --no-header Don't display headers
# @flag -h --help Print help (see a summary with '-h')
# @arg plugin*[`_choice_plugin`] Only show tool versions from [PLUGIN]
ls() {
:;
}
# }} rtx ls
# {{ rtx ls-remote
# @cmd List runtime versions available for install
# @flag --all Show all installed plugins and versions
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg tool-version[`_choice_tool_version`] <TOOL@VERSION> Plugin to get versions for
# @arg prefix[`_choice_plugin`] The version prefix to use when querying the latest version same as the first argument after the "@"
ls-remote() {
:;
}
# }} rtx ls-remote
# {{ rtx outdated
# @cmd Shows outdated tool versions
# @option -C --cd <DIR> Change directory before running command
# @flag -J --json Output in JSON format
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg tool-version*[`_choice_tool_version`] <TOOL@VERSION> Tool(s) to show outdated versions for e.g.: node@20 python@3.10 If not specified, all tools in global and local configs will be shown
outdated() {
:;
}
# }} rtx outdated
# {{ rtx plugins
# @cmd Manage plugins [aliases: p]
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -c --core The built-in plugins only Normally these are not shown
# @flag --user List installed plugins
# @flag -u --urls Show the git url for each plugin e.g.: https://github.com/asdf-vm/asdf-nodejs.git
# @flag -h --help Print help (see a summary with '-h')
plugins() {
:;
}
# {{{ rtx plugins install
# @cmd Install a plugin [aliases: i, a, add]
# @option -C --cd <DIR> Change directory before running command
# @flag -f --force Reinstall even if plugin exists
# @flag -a --all Install all missing plugins This will only install plugins that have matching shorthands.
# @flag -v --verbose* Show installation output
# @flag -q --quiet Suppress non-error messages
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg new_plugin The name of the plugin to install e.g.: node, ruby Can specify multiple plugins: `mise plugins install node ruby python`
# @arg git_url The git url of the plugin
plugins::install() {
:;
}
# }}} rtx plugins install
# {{{ rtx plugins link
# @cmd Symlinks a plugin into mise [aliases: ln]
# @option -C --cd <DIR> Change directory before running command
# @flag -f --force Overwrite existing plugin
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg name![node|ruby] The name of the plugin e.g.: node, ruby
# @arg path The local path to the plugin e.g.: ./mise-node
plugins::link() {
:;
}
# }}} rtx plugins link
# {{{ rtx plugins ls
# @cmd List installed plugins [aliases: list]
# @option -C --cd <DIR> Change directory before running command
# @flag -c --core The built-in plugins only Normally these are not shown
# @flag --user List installed plugins
# @flag -q --quiet Suppress non-error messages
# @flag -u --urls Show the git url for each plugin e.g.: https://github.com/asdf-vm/asdf-nodejs.git
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
plugins::ls() {
:;
}
# }}} rtx plugins ls
# {{{ rtx plugins ls-remote
# @cmd List all available remote plugins [aliases: list-remote, list-all]
# @option -C --cd <DIR> Change directory before running command
# @flag -u --urls Show the git url for each plugin e.g.: https://github.com/mise-plugins/rtx-nodejs.git
# @flag --only-names Only show the name of each plugin by default it will show a "*" next to installed plugins
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
plugins::ls-remote() {
:;
}
# }}} rtx plugins ls-remote
# {{{ rtx plugins uninstall
# @cmd Removes a plugin [aliases: remove, rm]
# @option -C --cd <DIR> Change directory before running command
# @flag -p --purge Also remove the plugin's installs, downloads, and cache
# @flag -a --all Remove all plugins
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg plugin*[`_choice_plugin`] Plugin(s) to remove
plugins::uninstall() {
:;
}
# }}} rtx plugins uninstall
# {{{ rtx plugins update
# @cmd Updates a plugin to the latest version [aliases: up, upgrade]
# @option -C --cd <DIR> Change directory before running command
# @option -j --jobs Number of jobs to run in parallel Default: 4
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg plugin*[`_choice_plugin`] Plugin(s) to update
plugins::update() {
:;
}
# }}} rtx plugins update
# }} rtx plugins
# {{ rtx prune
# @cmd Delete unused versions of tools
# @option -C --cd <DIR> Change directory before running command
# @flag -n --dry-run Do not actually delete anything
# @flag --configs Prune only tracked and trusted configuration links that point to non-existent configurations
# @flag --tools Prune only unused versions of tools
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg plugin*[`_choice_plugin`] Prune only versions from this plugin(s)
prune() {
:;
}
# }} rtx prune
# {{ rtx registry
# @cmd [experimental] List available tools
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
registry() {
:;
}
# }} rtx registry
# {{ rtx reshim
# @cmd rebuilds the shim farm
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
reshim() {
:;
}
# }} rtx reshim
# {{ rtx run
# @cmd [experimental] Run a tasks [aliases: r]
# @option -C --cd Change to this directory before executing the command
# @flag -n --dry-run Don't actually run the tasks(s), just print them in order of execution
# @flag -f --force Force the tasks to run even if outputs are up to date
# @flag -p --prefix Print stdout/stderr by line, prefixed with the tasks's label Defaults to true if --jobs > 1 Configure with `task_output` config or `MISE_TASK_OUTPUT` env var
# @flag -q --quiet Suppress non-error messages
# @flag -i --interleave Print directly to stdout/stderr instead of by line Defaults to true if --jobs == 1 Configure with `task_output` config or `MISE_TASK_OUTPUT` env var
# @option -t --tool <TOOL@VERSION> Tool(s) to also add e.g.: node@20 python@3.10
# @flag -v --verbose* Show extra output (use -vv for even more)
# @option -j --jobs Number of tasks to run in parallel [default: 4] Configure with `jobs` config or `MISE_JOBS` env var
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -r --raw Read/write directly to stdin/stdout/stderr instead of by line Configure with `raw` config or `MISE_RAW` env var
# @flag --timings Shows elapsed time after each tasks
# @flag -h --help Print help (see a summary with '-h')
# @arg task[`_choice_task`] Tasks to run Can specify multiple tasks by separating with `:::` e.g.: mise run task1 arg1 arg2 ::: task2 arg1 arg2
# @arg args* Arguments to pass to the tasks.
run() {
:;
}
# }} rtx run
# {{ rtx self-update
# @cmd Updates mise itself
# @option -C --cd <DIR> Change directory before running command
# @flag -f --force Update even if already up to date
# @flag --no-plugins Disable auto-updating plugins
# @flag -y --yes Skip confirmation prompt
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -h --help Print help (see a summary with '-h')
# @arg version Update to a specific version
self-update() {
:;
}
# }} rtx self-update
# {{ rtx set
# @cmd Manage environment variables
# @option -C --cd <DIR> Change directory before running command
# @option --file The TOML file to update
# @flag -g --global Set the environment variable in the global config file
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg env_vars* Environment variable(s) to set e.g.: NODE_ENV=production
set() {
:;
}
# }} rtx set
# {{ rtx settings
# @cmd Manage settings
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag --keys Only display key names for each setting
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help
settings() {
:;
}
# {{{ rtx settings get
# @cmd Show a current setting
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg setting![`_choice_setting`] The setting to show
settings::get() {
:;
}
# }}} rtx settings get
# {{{ rtx settings ls
# @cmd Show current settings [aliases: list]
# @option -C --cd <DIR> Change directory before running command
# @flag --keys Only display key names for each setting
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
settings::ls() {
:;
}
# }}} rtx settings ls
# {{{ rtx settings set
# @cmd Add/update a setting [aliases: add, create]
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg setting![`_choice_setting`] The setting to set
# @arg value! The value to set
settings::set() {
:;
}
# }}} rtx settings set
# {{{ rtx settings unset
# @cmd Clears a setting [aliases: rm, remove, delete, del]
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg setting![`_choice_setting`] The setting to remove
settings::unset() {
:;
}
# }}} rtx settings unset
# }} rtx settings
# {{ rtx shell
# @cmd Sets a tool version for the current session [aliases: sh]
# @option -C --cd <DIR> Change directory before running command
# @option -j --jobs Number of jobs to run in parallel [default: 4]
# @flag --raw Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1
# @flag -u --unset Removes a previously set version
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg tool-version*[`_choice_tool_version`] <TOOL@VERSION> Tool(s) to use
shell() {
:;
}
# }} rtx shell
# {{ rtx sync
# @cmd Add tool versions from external tools to mise
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help
sync() {
:;
}
# {{{ rtx sync node
# @cmd Symlinks all tool versions from an external tool into mise
# @flag --brew Get tool versions from Homebrew
# @option -C --cd <DIR> Change directory before running command
# @flag --nvm Get tool versions from nvm
# @flag --nodenv Get tool versions from nodenv
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
sync::node() {
:;
}
# }}} rtx sync node
# {{{ rtx sync python
# @cmd Symlinks all tool versions from an external tool into mise
# @option -C --cd <DIR> Change directory before running command
# @flag --pyenv Get tool versions from pyenv
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
sync::python() {
:;
}
# }}} rtx sync python
# }} rtx sync
# {{ rtx tasks
# @cmd [experimental] Manage tasks [aliases: t]
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag --no-header Do not print table header
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -x --extended Show all columns
# @flag --hidden Show hidden tasks
# @flag -y --yes Answer yes to all confirmation prompts
# @option --sort[name|alias|description|source] <COLUMN> Sort by column.
# @option --sort-order[asc|desc] <SORT_ORDER> Sort order.
# @flag -J --json Output in JSON format
# @flag -h --help Print help (see a summary with '-h')
tasks() {
:;
}
# {{{ rtx tasks deps
# @cmd [experimental] Display a tree visualization of a dependency graph
# @option -C --cd <DIR> Change directory before running command
# @flag --hidden Show hidden tasks
# @flag --dot Display dependencies in DOT format
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg tasks* Tasks to show dependencies for Can specify multiple tasks by separating with spaces e.g.: mise tasks deps lint test check
tasks::deps() {
:;
}
# }}} rtx tasks deps
# {{{ rtx tasks edit
# @cmd [experimental] Edit a tasks with $EDITOR
# @option -C --cd <DIR> Change directory before running command
# @flag -p --path Display the path to the tasks instead of editing it
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg task![`_choice_task`] Tasks to edit
tasks::edit() {
:;
}
# }}} rtx tasks edit
# {{{ rtx tasks ls
# @cmd [experimental] List available tasks to execute These may be included from the config file or from the project's .mise/tasks directory mise will merge all tasks from all parent directories into this list.
# @option -C --cd <DIR> Change directory before running command
# @flag --no-header Do not print table header
# @flag -x --extended Show all columns
# @flag --hidden Show hidden tasks
# @flag -q --quiet Suppress non-error messages
# @option --sort[name|alias|description|source] <COLUMN> Sort by column.
# @option --sort-order[asc|desc] <SORT_ORDER> Sort order.
# @flag -J --json Output in JSON format
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
tasks::ls() {
:;
}
# }}} rtx tasks ls
# {{{ rtx tasks run
# @cmd [experimental] Run a tasks [aliases: r]
# @option -C --cd Change to this directory before executing the command
# @flag -n --dry-run Don't actually run the tasks(s), just print them in order of execution
# @flag -f --force Force the tasks to run even if outputs are up to date
# @flag -p --prefix Print stdout/stderr by line, prefixed with the tasks's label Defaults to true if --jobs > 1 Configure with `task_output` config or `MISE_TASK_OUTPUT` env var
# @flag -q --quiet Suppress non-error messages
# @flag -i --interleave Print directly to stdout/stderr instead of by line Defaults to true if --jobs == 1 Configure with `task_output` config or `MISE_TASK_OUTPUT` env var
# @option -t --tool <TOOL@VERSION> Tool(s) to also add e.g.: node@20 python@3.10
# @flag -v --verbose* Show extra output (use -vv for even more)
# @option -j --jobs Number of tasks to run in parallel [default: 4] Configure with `jobs` config or `MISE_JOBS` env var
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -r --raw Read/write directly to stdin/stdout/stderr instead of by line Configure with `raw` config or `MISE_RAW` env var
# @flag --timings Shows elapsed time after each tasks
# @flag -h --help Print help (see a summary with '-h')
# @arg task[`_choice_task`] Tasks to run Can specify multiple tasks by separating with `:::` e.g.: mise run task1 arg1 arg2 ::: task2 arg1 arg2
# @arg args* Arguments to pass to the tasks.
tasks::run() {
:;
}
# }}} rtx tasks run
# }} rtx tasks
# {{ rtx trust
# @cmd Marks a config file as trusted
# @flag -a --all Trust all config files in the current directory and its parents
# @option -C --cd <DIR> Change directory before running command
# @flag --untrust No longer trust this config
# @flag --show Show the trusted status of config files from the current directory and its parents.
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg config_file The config file to trust
trust() {
:;
}
# }} rtx trust
# {{ rtx uninstall
# @cmd Removes runtime versions [aliases: remove, rm]
# @flag -a --all Delete all installed versions
# @option -C --cd <DIR> Change directory before running command
# @flag -n --dry-run Do not actually delete anything
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg tool-version[`_choice_installed_tool_version`]
uninstall() {
:;
}
# }} rtx uninstall
# {{ rtx unset
# @cmd Remove environment variable(s) from the config file
# @option -C --cd <DIR> Change directory before running command
# @option -f --file Specify a file to use instead of ".mise.toml"
# @flag -g --global Use the global config file
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg keys* Environment variable(s) to remove e.g.: NODE_ENV
unset() {
:;
}
# }} rtx unset
# {{ rtx upgrade
# @cmd Upgrades outdated tool versions [aliases: up]
# @option -C --cd <DIR> Change directory before running command
# @flag -n --dry-run Just print what would be done, don't actually do it
# @option -j --jobs Number of jobs to run in parallel [default: 4] [env: MISE_JOBS=]
# @flag -i --interactive Display multiselect menu to choose which tools to upgrade
# @flag -q --quiet Suppress non-error messages
# @flag --raw Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help
# @arg tool-version*[`_choice_tool_version`] <TOOL@VERSION> Tool(s) to upgrade e.g.: node@20 python@3.10 If not specified, all current tools will be upgraded
upgrade() {
:;
}
# }} rtx upgrade
# {{ rtx usage
# @cmd Generate a usage CLI spec
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
usage() {
:;
}
# }} rtx usage
# {{ rtx use
# @cmd Install tool version and add it to config [aliases: u]
# @option -C --cd <DIR> Change directory before running command
# @flag -f --force Force reinstall even if already installed
# @flag --fuzzy Save fuzzy version to config file e.g.: `mise use --fuzzy node@20` will save 20 as the version this is the default behavior unless MISE_ASDF_COMPAT=1
# @flag -g --global Use the global config file (~/.config/mise/config.toml) instead of the local one
# @option -e --env Modify an environment-specific config file like .mise.<env>.toml
# @flag -q --quiet Suppress non-error messages
# @option -j --jobs Number of jobs to run in parallel [default: 4]
# @flag --raw Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1
# @flag -v --verbose* Show extra output (use -vv for even more)
# @option --remove <PLUGIN> Remove the plugin(s) from config file
# @flag -y --yes Answer yes to all confirmation prompts
# @option -p --path Specify a path to a config file or directory If a directory is specified, it will look for .mise.toml (default) or .tool-versions
# @flag --pin Save exact version to config file e.g.: `mise use --pin node@20` will save 20.0.0 as the version Set MISE_ASDF_COMPAT=1 to make this the default behavior
# @flag -h --help Print help (see a summary with '-h')
# @arg tool-version*[`_choice_tool_version`] <TOOL@VERSION> Tool(s) to add to config file e.g.: node@20, cargo:ripgrep@latest npm:prettier@3 If no version is specified, it will default to @latest
use() {
:;
}
# }} rtx use
# {{ rtx version
# @cmd Show mise version
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help
version() {
:;
}
# }} rtx version
# {{ rtx watch
# @cmd [experimental] Run a tasks watching for changes [aliases: w]
# @option -C --cd <DIR> Change directory before running command
# @option -t --task Tasks to run
# @option -g --glob Files to watch Defaults to sources from the tasks(s)
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg args* Extra arguments
watch() {
:;
}
# }} rtx watch
# {{ rtx where
# @cmd Display the installation path for a runtime
# @option -C --cd <DIR> Change directory before running command
# @flag -q --quiet Suppress non-error messages
# @flag -v --verbose* Show extra output (use -vv for even more)
# @flag -y --yes Answer yes to all confirmation prompts
# @flag -h --help Print help (see a summary with '-h')
# @arg tool-version![`_choice_tool_version`] <TOOL@VERSION> Tool(s) to look up e.g.: ruby@3 if "@<PREFIX>" is specified, it will show the latest installed version that matches the prefix otherwise, it will show the current, active installed version
where() {
:;
}
# }} rtx where
# {{ rtx which
# @cmd Shows the path that a bin name points to
# @option -C --cd <DIR> Change directory before running command
# @flag --plugin Show the plugin name instead of the path
# @flag --version Show the version instead of the path
# @option -t --tool <TOOL@VERSION> Use a specific tool@version e.g.: `mise which npm --tool=node@20`
# @flag -q --quiet Suppress non-error messages