forked from jdx/mise
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmise.usage.kdl
More file actions
1473 lines (1466 loc) · 145 KB
/
mise.usage.kdl
File metadata and controls
1473 lines (1466 loc) · 145 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
min_usage_version "2.11"
name mise
bin mise
about "The front-end to your dev env"
long_about "mise manages dev tools, env vars, and runs tasks. https://github.com/jdx/mise"
default_subcommand run
usage "Usage: mise [OPTIONS] [TASK] [COMMAND]"
flag "-c --continue-on-error" help="Continue running tasks even if one fails" hide=#true
flag "-C --cd" help="Change directory before running command" global=#true {
arg <DIR>
}
flag "-E --env" help="Set the environment for loading `mise.<ENV>.toml`" var=#true global=#true {
arg <ENV>
}
flag "-f --force" help="Force the operation" hide=#true
flag "-i --interleave" help="Set the log output verbosity" hide=#true
flag "-j --jobs" help="How many jobs to run in parallel [default: 8]" global=#true {
arg <JOBS>
}
flag "-n --dry-run" help="Dry run, don't actually do anything" hide=#true
flag "-p --prefix" hide=#true
flag "-P --profile" help="Set the profile (environment)" var=#true hide=#true global=#true {
arg <PROFILE>
}
flag "-q --quiet" help="Suppress non-error messages" global=#true
flag "-s --shell" hide=#true {
arg <SHELL>
}
flag "-t --tool" help="Tool(s) to run in addition to what is in mise.toml files e.g.: node@20 python@3.10" var=#true hide=#true {
arg <TOOL@VERSION>
}
flag "-v --verbose" help="Show extra output (use -vv for even more)" var=#true global=#true count=#true
flag "-V --version" hide=#true
flag "-y --yes" help="Answer yes to all confirmation prompts" global=#true
flag --debug help="Sets log level to debug" hide=#true global=#true
flag --log-level hide=#true global=#true {
arg <LEVEL> {
choices trace debug info warning error
}
}
flag --no-config help="Do not load any config files" {
long_help "Do not load any config files\n\nCan also use `MISE_NO_CONFIG=1`"
}
flag --no-env help="Do not load environment variables from config files" {
long_help "Do not load environment variables from config files\n\nCan also use `MISE_NO_ENV=1`"
}
flag --no-hooks help="Do not execute hooks from config files" {
long_help "Do not execute hooks from config files\n\nCan also use `MISE_NO_HOOKS=1`"
}
flag --no-timings help="Hides elapsed time after each task completes" hide=#true {
long_help "Hides elapsed time after each task completes\n\nDefault to always hide with `MISE_TASK_TIMINGS=0`"
}
flag --output {
arg <OUTPUT>
}
flag --raw help="Read/write directly to stdin/stdout/stderr instead of by line" global=#true
flag --locked help="Require lockfile URLs to be present during installation" global=#true {
long_help "Require lockfile URLs to be present during installation\n\nFails if tools don't have pre-resolved URLs in the lockfile for the current platform.\nThis prevents API calls to GitHub, aqua registry, etc.\nCan also be enabled via MISE_LOCKED=1 or settings.locked=true"
}
flag --silent help="Suppress all task output and mise non-error messages" global=#true
flag --timings help="Shows elapsed time after each task completes" hide=#true {
long_help "Shows elapsed time after each task completes\n\nDefault to always show with `MISE_TASK_TIMINGS=1`"
}
flag --trace help="Sets log level to trace" hide=#true global=#true
arg "[TASK]" help="Task to run" help_long="Task to run.\n\nShorthand for `mise tasks run <TASK>`." required=#false
arg "[TASK_ARGS]…" help="Task arguments" required=#false var=#true hide=#true
arg "[-- TASK_ARGS_LAST]…" required=#false var=#true hide=#true
cmd activate help="Initializes mise in the current shell session" {
long_help "Initializes mise in the current shell session\n\nThis should go into your shell's rc file or login shell.\nOtherwise, it will only take effect in the current session.\n(e.g. ~/.zshrc, ~/.zprofile, ~/.zshenv, ~/.bashrc, ~/.bash_profile, ~/.profile, ~/.config/fish/config.fish, or $PROFILE for powershell)\n\nTypically, this can be added with something like the following:\n\n echo 'eval \"$(mise activate zsh)\"' >> ~/.zshrc\n\nHowever, this requires that \"mise\" is in your PATH. If it is not, you need to\nspecify the full path like this:\n\n echo 'eval \"$(/path/to/mise activate zsh)\"' >> ~/.zshrc\n\nCustomize status output with `status` settings."
after_long_help "Examples:\n\n $ eval \"$(mise activate bash)\"\n $ eval \"$(mise activate zsh)\"\n $ mise activate fish | source\n $ execx($(mise activate xonsh))\n $ (&mise activate pwsh) | Out-String | Invoke-Expression\n"
flag "-q --quiet" help="Suppress non-error messages"
flag "-s --shell" help="Shell type to generate the script for" hide=#true {
arg <SHELL> {
choices bash elvish fish nu xonsh zsh pwsh
}
}
flag --no-hook-env help="Do not automatically call hook-env" {
long_help "Do not automatically call hook-env\n\nThis can be helpful for debugging mise. If you run `eval \"$(mise activate --no-hook-env)\"`, then you can call `mise hook-env` manually which will output the env vars to stdout without actually modifying the environment. That way you can do things like `mise hook-env --trace` to get more information or just see the values that hook-env is outputting."
}
flag --shims help="Use shims instead of modifying PATH\nEffectively the same as:" {
long_help "Use shims instead of modifying PATH\nEffectively the same as:\n\n PATH=\"$HOME/.local/share/mise/shims:$PATH\"\n\n`mise activate --shims` does not support all the features of `mise activate`.\nSee https://mise.jdx.dev/dev-tools/shims.html#shims-vs-path for more information"
}
flag --status help="Show \"mise: <PLUGIN>@<VERSION>\" message when changing directories" hide=#true
arg "[SHELL_TYPE]" help="Shell type to generate the script for" required=#false {
choices bash elvish fish nu xonsh zsh pwsh
}
}
cmd tool-alias help="Manage tool version aliases." {
alias alias aliases hide=#true
flag "-p --plugin" help="filter aliases by plugin" {
arg <PLUGIN>
}
flag --no-header help="Don't show table header"
cmd get help="Show an alias for a plugin" {
long_help "Show an alias for a plugin\n\nThis is the contents of a tool_alias.<PLUGIN> entry in ~/.config/mise/config.toml"
after_long_help "Examples:\n\n $ mise tool-alias get node lts-hydrogen\n 20.0.0\n"
arg <PLUGIN> help="The plugin to show the alias for"
arg <ALIAS> help="The alias to show"
}
cmd ls help="List tool version aliases\nShows the aliases that can be specified.\nThese can come from user config or from plugins in `bin/list-aliases`." {
alias list
long_help "List tool version aliases\nShows the aliases that can be specified.\nThese can come from user config or from plugins in `bin/list-aliases`.\n\nFor user config, aliases are defined like the following in `~/.config/mise/config.toml`:\n\n [tool_alias.node.versions]\n lts = \"22.0.0\""
after_long_help "Examples:\n\n $ mise tool-alias ls\n node lts-jod 22\n"
flag --no-header help="Don't show table header"
arg "[TOOL]" help="Show aliases for <TOOL>" required=#false
}
cmd set help="Add/update an alias for a backend/plugin" {
alias add create
long_help "Add/update an alias for a backend/plugin\n\nThis modifies the contents of ~/.config/mise/config.toml"
after_long_help "Examples:\n\n $ mise tool-alias set maven asdf:mise-plugins/mise-maven\n $ mise tool-alias set node lts-jod 22.0.0\n"
arg <PLUGIN> help="The backend/plugin to set the alias for"
arg <ALIAS> help="The alias to set"
arg "[VALUE]" help="The value to set the alias to" required=#false
}
cmd unset help="Clears an alias for a backend/plugin" {
alias rm remove delete del
long_help "Clears an alias for a backend/plugin\n\nThis modifies the contents of ~/.config/mise/config.toml"
after_long_help "Examples:\n\n $ mise tool-alias unset maven\n $ mise tool-alias unset node lts-jod\n"
arg <PLUGIN> help="The backend/plugin to remove the alias from"
arg "[ALIAS]" help="The alias to remove" required=#false
}
}
cmd asdf hide=#true help="[internal] simulates asdf for plugins that call \"asdf\" internally" {
arg "[ARGS]…" help="all arguments" required=#false double_dash=automatic var=#true
}
cmd backends help="Manage backends" {
alias b
alias backend backend-list hide=#true
cmd ls help="List built-in backends" {
alias list
after_long_help "Examples:\n\n $ mise backends ls\n aqua\n asdf\n cargo\n core\n dotnet\n gem\n go\n npm\n pipx\n spm\n ubi\n vfox\n"
}
}
cmd bin-paths help="List all the active runtime bin paths" {
arg "[TOOL@VERSION]…" help="Tool(s) to look up\ne.g.: ruby@3" required=#false var=#true
}
cmd cache help="Manage the mise cache" {
long_help "Manage the mise cache\n\nRun `mise cache` with no args to view the current cache directory."
cmd clear help="Deletes all cache files in mise" {
alias c
alias clean hide=#true
flag --outdate help="Mark all cache files as old" hide=#true
arg "[PLUGIN]…" help="Plugin(s) to clear cache for e.g.: node, python" required=#false var=#true
}
cmd path help="Show the cache directory path" {
alias dir
}
cmd prune help="Removes stale mise cache files" {
alias p
long_help "Removes stale mise cache files\n\nBy default, this command will remove files that have not been accessed in 30 days.\nChange this with the MISE_CACHE_PRUNE_AGE environment variable."
flag "-v --verbose" help="Show pruned files" var=#true count=#true
flag --dry-run help="Just show what would be pruned"
arg "[PLUGIN]…" help="Plugin(s) to clear cache for e.g.: node, python" required=#false var=#true
}
}
cmd completion help="Generate shell completions" {
alias complete completions hide=#true
after_long_help "Examples:\n\n $ mise completion bash --include-bash-completion-lib > ~/.local/share/bash-completion/completions/mise\n $ mise completion zsh > /usr/local/share/zsh/site-functions/_mise\n $ mise completion fish > ~/.config/fish/completions/mise.fish\n $ mise completion powershell >> $PROFILE\n"
flag "-s --shell" help="Shell type to generate completions for" hide=#true {
arg <SHELL_TYPE> {
choices bash fish powershell zsh
}
}
flag --include-bash-completion-lib help="Include the bash completion library in the bash completion script" {
long_help "Include the bash completion library in the bash completion script\n\nThis is required for completions to work in bash, but it is not included by default\nyou may source it separately or enable this flag to enable it in the script."
}
flag --usage help="Always use usage for completions.\nCurrently, usage is the default for fish and bash but not zsh since it has a few quirks\nto work out first." hide=#true {
long_help "Always use usage for completions.\nCurrently, usage is the default for fish and bash but not zsh since it has a few quirks\nto work out first.\n\nThis requires the `usage` CLI to be installed.\nhttps://usage.jdx.dev"
}
arg "[SHELL]" help="Shell type to generate completions for" required=#false {
choices bash fish powershell zsh
}
}
cmd config help="Manage config files" {
alias cfg
alias toml hide=#true
after_long_help "Examples:\n\n $ mise config ls\n Path Tools\n ~/.config/mise/config.toml pitchfork\n ~/src/mise/mise.toml actionlint, bun, cargo-binstall, cargo:cargo-edit, cargo:cargo-insta\n"
flag "-J --json" help="Output in JSON format"
flag --no-header help="Do not print table header"
flag --tracked-configs help="List all tracked config files"
cmd get help="Display the value of a setting in a mise.toml file" {
after_long_help "Examples:\n\n $ mise toml get tools.python\n 3.12\n"
flag "-f --file" help="The path to the mise.toml file to edit" {
long_help "The path to the mise.toml file to edit\n\nIf not provided, the nearest mise.toml file will be used"
arg <FILE>
}
arg "[KEY]" help="The path of the config to display" required=#false
}
cmd ls help="List config files currently in use" {
alias list
after_long_help "Examples:\n\n $ mise config ls\n Path Tools\n ~/.config/mise/config.toml pitchfork\n ~/src/mise/mise.toml actionlint, bun, cargo-binstall, cargo:cargo-edit, cargo:cargo-insta\n"
flag "-J --json" help="Output in JSON format"
flag --no-header help="Do not print table header"
flag --tracked-configs help="List all tracked config files"
}
cmd set help="Set the value of a setting in a mise.toml file" {
after_long_help "Examples:\n\n $ mise config set tools.python 3.12\n $ mise config set settings.always_keep_download true\n $ mise config set env.TEST_ENV_VAR ABC\n $ mise config set settings.disable_tools --type list node,rust\n\n # Type for `settings` is inferred\n $ mise config set settings.jobs 4\n"
flag "-f --file" help="The path to the mise.toml file to edit" {
long_help "The path to the mise.toml file to edit\n\nIf not provided, the nearest mise.toml file will be used"
arg <FILE>
}
flag "-t --type" default=infer {
arg <TYPE> {
choices infer string integer float bool list set
}
}
arg <KEY> help="The path of the config to display"
arg "[VALUE]" help="The value to set the key to (optional if provided as KEY=VALUE)" required=#false
}
}
cmd current hide=#true help="Shows current active and installed runtime versions" {
long_help "Shows current active and installed runtime versions\n\nThis is similar to `mise ls --current`, but this only shows the runtime\nand/or version. It's designed to fit into scripts more easily."
after_long_help "Examples:\n\n # outputs `.tool-versions` compatible format\n $ mise current\n python 3.11.0 3.10.0\n shfmt 3.6.0\n shellcheck 0.9.0\n node 20.0.0\n\n $ mise current node\n 20.0.0\n\n # can output multiple versions\n $ mise current python\n 3.11.0 3.10.0\n"
arg "[PLUGIN]" help="Plugin to show versions of e.g.: ruby, node, cargo:eza, npm:prettier, etc" required=#false
}
cmd deactivate help="Disable mise for current shell session" {
long_help "Disable mise for current shell session\n\nThis can be used to temporarily disable mise in a shell session."
after_long_help "Examples:\n\n $ mise deactivate\n"
}
cmd direnv hide=#true help="Output direnv function to use mise inside direnv" {
long_help "Output direnv function to use mise inside direnv\n\nSee https://mise.jdx.dev/direnv.html for more information\n\nBecause this generates the idiomatic files based on currently installed plugins,\nyou should run this command after installing new plugins. Otherwise\ndirenv may not know to update environment variables when idiomatic file versions change."
cmd activate hide=#true help="Output direnv function to use mise inside direnv" {
long_help "Output direnv function to use mise inside direnv\n\nSee https://mise.jdx.dev/direnv.html for more information\n\nBecause this generates the idiomatic files based on currently installed plugins,\nyou should run this command after installing new plugins. Otherwise\ndirenv may not know to update environment variables when idiomatic file versions change."
after_long_help "Examples:\n\n $ mise direnv activate > ~/.config/direnv/lib/use_mise.sh\n $ echo 'use mise' > .envrc\n $ direnv allow\n"
}
cmd envrc hide=#true help="[internal] This is an internal command that writes an envrc file\nfor direnv to consume."
cmd exec hide=#true help="[internal] This is an internal command that writes an envrc file\nfor direnv to consume."
}
cmd doctor help="Check mise installation for possible problems" {
alias dr
after_long_help "Examples:\n\n $ mise doctor\n [WARN] plugin node is not installed\n"
flag "-J --json"
cmd path help="Print the current PATH entries mise is providing" {
alias paths hide=#true
after_long_help "Examples:\n\n Get the current PATH entries mise is providing\n $ mise doctor path\n /home/user/.local/share/mise/installs/node/24.0.0/bin\n /home/user/.local/share/mise/installs/rust/1.90.0/bin\n /home/user/.local/share/mise/installs/python/3.10.0/bin\n"
flag "-f --full" help="Print all entries including those not provided by mise"
}
}
cmd en help="Starts a new shell with the mise environment built from the current configuration" {
long_help "Starts a new shell with the mise environment built from the current configuration\n\nThis is an alternative to `mise activate` that allows you to explicitly start a mise session.\nIt will have the tools and environment variables in the configs loaded.\nNote that changing directories will not update the mise environment."
after_long_help "Examples:\n\n $ mise en .\n $ node -v\n v20.0.0\n\n Skip loading bashrc:\n $ mise en -s \"bash --norc\"\n\n Skip loading zshrc:\n $ mise en -s \"zsh -f\"\n"
flag "-s --shell" help="Shell to start" {
long_help "Shell to start\n\nDefaults to $SHELL"
arg <SHELL>
}
arg "[DIR]" help="Directory to start the shell in" required=#false default=.
}
cmd env help="Exports env vars to activate mise a single time" {
alias e
long_help "Exports env vars to activate mise a single time\n\nUse this if you don't want to permanently install mise. It's not necessary to\nuse this if you have `mise activate` in your shell rc file."
after_long_help "Examples:\n\n $ eval \"$(mise env -s bash)\"\n $ eval \"$(mise env -s zsh)\"\n $ mise env -s fish | source\n $ execx($(mise env -s xonsh))\n"
flag "-D --dotenv" help="Output in dotenv format"
flag "-J --json" help="Output in JSON format"
flag "-s --shell" help="Shell type to generate environment variables for" {
arg <SHELL> {
choices bash elvish fish nu xonsh zsh pwsh
}
}
flag --json-extended help="Output in JSON format with additional information (source, tool)"
flag --redacted help="Only show redacted environment variables"
flag --values help="Only show values of environment variables"
arg "[TOOL@VERSION]…" help="Tool(s) to use" required=#false var=#true
}
cmd exec help="Execute a command with tool(s) set" {
alias x
long_help "Execute a command with tool(s) set\n\nuse this to avoid modifying the shell session or running ad-hoc commands with mise tools set.\n\nTools will be loaded from mise.toml, though they can be overridden with <RUNTIME> args\nNote that only the plugin specified will be overridden, so if a `mise.toml` file\nincludes \"node 20\" but you run `mise exec python@3.11`; it will still load node@20.\n\nThe \"--\" separates runtimes from the commands to pass along to the subprocess."
after_long_help "Examples:\n\n $ mise exec node@20 -- node ./app.js # launch app.js using node-20.x\n $ mise x node@20 -- node ./app.js # shorter alias\n\n # Specify command as a string:\n $ mise exec node@20 python@3.11 --command \"node -v && python -V\"\n\n # Run a command in a different directory:\n $ mise x -C /path/to/project node@20 -- node ./app.js\n"
flag "-c --command" help="Command string to execute" {
arg <C>
}
flag "-j --jobs" help="Number of jobs to run in parallel\n[default: 4]" {
arg <JOBS>
}
flag --fresh-env help="Bypass the environment cache and recompute the environment"
flag --no-prepare help="Skip automatic dependency preparation"
flag --raw help="Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1"
arg "[TOOL@VERSION]…" help="Tool(s) to start e.g.: node@20 python@3.10" required=#false var=#true
arg "[-- COMMAND]…" help="Command string to execute (same as --command)" required=#false var=#true
}
cmd fmt help="Formats mise.toml" {
long_help "Formats mise.toml\n\nSorts keys and cleans up whitespace in mise.toml"
after_long_help "Examples:\n\n $ mise fmt\n"
flag "-a --all" help="Format all files from the current directory"
flag "-c --check" help="Check if the configs are formatted, no formatting is done"
flag "-s --stdin" help="Read config from stdin and write its formatted version into stdout"
}
cmd generate subcommand_required=#true help="Generate files for various tools/services" {
alias gen
alias g hide=#true
cmd bootstrap help="Generate a script to download+execute mise" {
long_help "Generate a script to download+execute mise\n\nThis is designed to be used in a project where contributors may not have mise installed."
after_long_help "Examples:\n\n $ mise generate bootstrap >./bin/mise\n $ chmod +x ./bin/mise\n $ ./bin/mise install – automatically downloads mise to .mise if not already installed\n"
flag "-l --localize" help="Sandboxes mise internal directories like MISE_DATA_DIR and MISE_CACHE_DIR into a `.mise` directory in the project" {
long_help "Sandboxes mise internal directories like MISE_DATA_DIR and MISE_CACHE_DIR into a `.mise` directory in the project\n\nThis is necessary if users may use a different version of mise outside the project."
}
flag "-V --version" help="Specify mise version to fetch" {
arg <VERSION>
}
flag "-w --write" help="instead of outputting the script to stdout, write to a file and make it executable" {
arg <WRITE>
}
flag --localized-dir help="Directory to put localized data into" default=.mise {
arg <LOCALIZED_DIR>
}
}
cmd config help="Generate a mise.toml file" {
after_long_help "Examples:\n\n $ mise edit # edit mise.toml interactively\n $ mise edit .mise.toml # edit a specific file\n $ mise edit -y # skip interactive editor\n $ mise edit -n # preview without writing\n"
flag "-n --dry-run" help="Show what would be generated without writing to file"
flag "-t --tool-versions" help="Path to a .tool-versions file to import tools from" {
arg <TOOL_VERSIONS>
}
arg "[PATH]" help="Path to the config file to create" required=#false
}
cmd devcontainer help="Generate a devcontainer to execute mise" {
after_long_help "Examples:\n\n $ mise generate devcontainer\n"
flag "-i --image" help="The image to use for the devcontainer" {
arg <IMAGE>
}
flag "-m --mount-mise-data" help="Bind the mise-data-volume to the devcontainer"
flag "-n --name" help="The name of the devcontainer" {
arg <NAME>
}
flag "-w --write" help="write to .devcontainer/devcontainer.json"
}
cmd git-pre-commit help="Generate a git pre-commit hook" {
alias pre-commit
long_help "Generate a git pre-commit hook\n\nThis command generates a git pre-commit hook that runs a mise task like `mise run pre-commit`\nwhen you commit changes to your repository.\n\nStaged files are passed to the task as `STAGED`.\n\nFor more advanced pre-commit functionality, see mise's sister project: https://hk.jdx.dev/"
after_long_help "Examples:\n\n $ mise generate git-pre-commit --write --task=pre-commit\n $ git commit -m \"feat: add new feature\" # runs `mise run pre-commit`\n"
flag "-t --task" help="The task to run when the pre-commit hook is triggered" default=pre-commit {
arg <TASK>
}
flag "-w --write" help="write to .git/hooks/pre-commit and make it executable"
flag --hook help="Which hook to generate (saves to .git/hooks/$hook)" default=pre-commit {
arg <HOOK>
}
}
cmd github-action help="Generate a GitHub Action workflow file" {
long_help "Generate a GitHub Action workflow file\n\nThis command generates a GitHub Action workflow file that runs a mise task like `mise run ci`\nwhen you push changes to your repository."
after_long_help "Examples:\n\n $ mise generate github-action --write --task=ci\n $ git commit -m \"feat: add new feature\"\n $ git push # runs `mise run ci` on GitHub\n"
flag "-t --task" help="The task to run when the workflow is triggered" default=ci {
arg <TASK>
}
flag "-w --write" help="write to .github/workflows/$name.yml"
flag --name help="the name of the workflow to generate" default=ci {
arg <NAME>
}
}
cmd task-docs help="Generate documentation for tasks in a project" {
after_long_help "Examples:\n\n $ mise generate task-docs\n"
flag "-i --inject" help="inserts the documentation into an existing file" {
long_help "inserts the documentation into an existing file\n\nThis will look for a special comment, `<!-- mise-tasks -->`, and replace it with the generated documentation.\nIt will replace everything between the comment and the next comment, `<!-- /mise-tasks -->` so it can be\nrun multiple times on the same file to update the documentation."
}
flag "-I --index" help="write only an index of tasks, intended for use with `--multi`"
flag "-m --multi" help="render each task as a separate document, requires `--output` to be a directory"
flag "-o --output" help="writes the generated docs to a file/directory" {
arg <OUTPUT>
}
flag "-r --root" help="root directory to search for tasks" {
arg <ROOT>
}
flag "-s --style" default=simple {
arg <STYLE> {
choices simple detailed
}
}
}
cmd task-stubs help="Generates shims to run mise tasks" {
long_help "Generates shims to run mise tasks\n\nBy default, this will build shims like ./bin/<task>. These can be paired with `mise generate bootstrap`\nso contributors to a project can execute mise tasks without installing mise into their system."
after_long_help "Examples:\n\n $ mise tasks add test -- echo 'running tests'\n $ mise generate task-stubs\n $ ./bin/test\n running tests\n"
flag "-d --dir" help="Directory to create task stubs inside of" default=bin {
arg <DIR>
}
flag "-m --mise-bin" help="Path to a mise bin to use when running the task stub." default=mise {
long_help "Path to a mise bin to use when running the task stub.\n\nUse `--mise-bin=./bin/mise` to use a mise bin generated from `mise generate bootstrap`"
arg <MISE_BIN>
}
}
cmd tool-stub help="Generate a tool stub for HTTP-based tools" {
long_help "Generate a tool stub for HTTP-based tools\n\nThis command generates tool stubs that can automatically download and execute\ntools from HTTP URLs. It can detect checksums, file sizes, and binary paths\nautomatically by downloading and analyzing the tool.\n\nWhen generating stubs with platform-specific URLs, the command will append new\nplatforms to existing stub files rather than overwriting them. This allows you\nto incrementally build cross-platform tool stubs."
after_long_help "Examples:\n\n Generate a tool stub for a single URL:\n $ mise generate tool-stub ./bin/gh --url \"https://github.com/cli/cli/releases/download/v2.336.0/gh_2.336.0_linux_amd64.tar.gz\"\n\n Generate a tool stub with platform-specific URLs:\n $ mise generate tool-stub ./bin/rg \\\n --platform-url linux-x64:https://github.com/BurntSushi/ripgrep/releases/download/14.0.3/ripgrep-14.0.3-x86_64-unknown-linux-musl.tar.gz \\\n --platform-url darwin-arm64:https://github.com/BurntSushi/ripgrep/releases/download/14.0.3/ripgrep-14.0.3-aarch64-apple-darwin.tar.gz\n\n Append additional platforms to an existing stub:\n $ mise generate tool-stub ./bin/rg \\\n --platform-url linux-x64:https://example.com/rg-linux.tar.gz\n $ mise generate tool-stub ./bin/rg \\\n --platform-url darwin-arm64:https://example.com/rg-darwin.tar.gz\n # The stub now contains both platforms\n\n Use auto-detection for platform from URL:\n $ mise generate tool-stub ./bin/node \\\n --platform-url https://nodejs.org/dist/v22.17.1/node-v22.17.1-darwin-arm64.tar.gz\n # Platform 'macos-arm64' will be auto-detected from the URL\n\n Generate with platform-specific binary paths:\n $ mise generate tool-stub ./bin/tool \\\n --platform-url linux-x64:https://example.com/tool-linux.tar.gz \\\n --platform-url windows-x64:https://example.com/tool-windows.zip \\\n --platform-bin windows-x64:tool.exe\n\n Generate without downloading (faster):\n $ mise generate tool-stub ./bin/tool --url \"https://example.com/tool.tar.gz\" --skip-download\n\n Fetch checksums for an existing stub:\n $ mise generate tool-stub ./bin/jq --fetch\n # This will read the existing stub and download files to fill in any missing checksums/sizes\n\n Generate a bootstrap stub that installs mise if needed:\n $ mise generate tool-stub ./bin/tool --url \"https://example.com/tool.tar.gz\" --bootstrap\n # The stub will check for mise and install it automatically before running the tool\n\n Generate a bootstrap stub with a pinned mise version:\n $ mise generate tool-stub ./bin/tool --url \"https://example.com/tool.tar.gz\" --bootstrap --bootstrap-version 2025.1.0\n\n Lock an existing tool stub with pinned version and platform URLs/checksums:\n $ mise generate tool-stub ./bin/node --lock\n\n Bump the version in a locked stub:\n $ mise generate tool-stub ./bin/node --lock --version 22\n # Resolves the latest node 22.x, pins it, and updates platform URLs/checksums\n"
flag "-b --bin" help="Binary path within the extracted archive" {
long_help "Binary path within the extracted archive\n\nIf not specified and the archive is downloaded, will auto-detect the most likely binary"
arg <BIN>
}
flag --bootstrap help="Wrap stub in a bootstrap script that installs mise if not already present" {
long_help "Wrap stub in a bootstrap script that installs mise if not already present\n\nWhen enabled, generates a bash script that:\n1. Checks if mise is installed at the expected path\n2. If not, downloads and installs mise using the embedded installer\n3. Executes the tool stub using mise"
}
flag --bootstrap-version help="Specify mise version for the bootstrap script" {
long_help "Specify mise version for the bootstrap script\n\nBy default, uses the latest version from the install script.\nUse this to pin to a specific version (e.g., \"2025.1.0\")."
arg <BOOTSTRAP_VERSION>
}
flag --fetch help="Fetch checksums and sizes for an existing tool stub file" {
long_help "Fetch checksums and sizes for an existing tool stub file\n\nThis reads an existing stub file and fills in any missing checksum/size fields by downloading the files. URLs must already be present in the stub."
}
flag --http help="HTTP backend type to use" default=http {
arg <HTTP>
}
flag --lock help="Resolve and embed lockfile data (exact version + platform URLs/checksums) into an existing stub file for reproducible installs without runtime API calls"
flag --platform-bin help="Platform-specific binary paths in the format platform:path" var=#true {
long_help "Platform-specific binary paths in the format platform:path\n\nExamples: --platform-bin windows-x64:tool.exe --platform-bin linux-x64:bin/tool"
arg <PLATFORM_BIN>
}
flag --platform-url help="Platform-specific URLs in the format platform:url or just url (auto-detect platform)" var=#true {
long_help "Platform-specific URLs in the format platform:url or just url (auto-detect platform)\n\nWhen the output file already exists, new platforms will be appended to the existing platforms table. Existing platform URLs will be updated if specified again.\n\nIf only a URL is provided (without platform:), the platform will be automatically detected from the URL filename.\n\nExamples: --platform-url linux-x64:https://... --platform-url https://nodejs.org/dist/v22.17.1/node-v22.17.1-darwin-arm64.tar.gz"
arg <PLATFORM_URL>
}
flag --skip-download help="Skip downloading for checksum and binary path detection (faster but less informative)"
flag "-u --url" help="URL for downloading the tool" {
long_help "URL for downloading the tool\n\nExample: https://github.com/owner/repo/releases/download/v2.0.0/tool-linux-x64.tar.gz"
arg <URL>
}
flag --version help="Version of the tool" default=latest {
arg <VERSION>
}
arg <OUTPUT> help="Output file path for the tool stub"
}
}
cmd global hide=#true help="Sets/gets the global tool version(s)" {
long_help "Sets/gets the global tool version(s)\n\nDisplays the contents of global config after writing.\nThe file is `$HOME/.config/mise/config.toml` by default. It can be changed with `$MISE_GLOBAL_CONFIG_FILE`.\nIf `$MISE_GLOBAL_CONFIG_FILE` is set to anything that ends in `.toml`, it will be parsed as `mise.toml`.\nOtherwise, it will be parsed as a `.tool-versions` file.\n\nUse MISE_ASDF_COMPAT=1 to default the global config to ~/.tool-versions\n\nUse `mise local` to set a tool version locally in the current directory."
after_long_help "Examples:\n # set the current version of node to 20.x\n # will use a fuzzy version (e.g.: 20) in .tool-versions file\n $ mise global --fuzzy node@20\n\n # set the current version of node to 20.x\n # will use a precise version (e.g.: 20.0.0) in .tool-versions file\n $ mise global --pin node@20\n\n # show the current version of node in ~/.tool-versions\n $ mise global node\n 20.0.0\n"
flag --fuzzy help="Save fuzzy version to `~/.tool-versions`\ne.g.: `mise global --fuzzy node@20` will save `node 20` to ~/.tool-versions\nthis is the default behavior unless MISE_ASDF_COMPAT=1"
flag --path help="Get the path of the global config file"
flag --pin help="Save exact version to `~/.tool-versions`\ne.g.: `mise global --pin node@20` will save `node 20.0.0` to ~/.tool-versions"
flag --remove help="Remove the plugin(s) from ~/.tool-versions" var=#true {
arg <PLUGIN>
}
arg "[TOOL@VERSION]…" help="Tool(s) to add to .tool-versions\ne.g.: node@20\nIf this is a single tool with no version, the current value of the global\n.tool-versions will be displayed" required=#false var=#true
}
cmd hook-env hide=#true help="[internal] called by activate hook to update env vars directory change" {
flag "-f --force" help="Skip early exit check"
flag "-q --quiet" help="Hide warnings such as when a tool is not installed"
flag "-s --shell" help="Shell type to generate script for" {
arg <SHELL> {
choices bash elvish fish nu xonsh zsh pwsh
}
}
flag --reason help="Reason for calling hook-env (e.g., \"precmd\", \"chpwd\")" hide=#true {
arg <REASON> {
choices precmd chpwd
}
}
flag --status help="Show \"mise: <PLUGIN>@<VERSION>\" message when changing directories" hide=#true
}
cmd hook-not-found hide=#true help="[internal] called by shell when a command is not found" {
flag "-s --shell" help="Shell type to generate script for" {
arg <SHELL> {
choices bash elvish fish nu xonsh zsh pwsh
}
}
arg <BIN> help="Attempted bin to run"
}
cmd implode help="Removes mise CLI and all related data" {
long_help "Removes mise CLI and all related data\n\nSkips config directory by default."
flag "-n --dry-run" help="List directories that would be removed without actually removing them"
flag --config help="Also remove config directory"
}
cmd edit help="Edit mise.toml interactively" {
after_long_help "Examples:\n\n $ mise edit # edit mise.toml interactively\n $ mise edit .mise.toml # edit a specific file\n $ mise edit -y # skip interactive editor\n $ mise edit -n # preview without writing\n"
flag "-n --dry-run" help="Show what would be generated without writing to file"
flag "-t --tool-versions" help="Path to a .tool-versions file to import tools from" {
arg <TOOL_VERSIONS>
}
arg "[PATH]" help="Path to the config file to create" required=#false
}
cmd install help="Install a tool version" {
alias i
long_help "Install a tool version\n\nInstalls a tool version to `~/.local/share/mise/installs/<PLUGIN>/<VERSION>`\nInstalling alone will not activate the tools so they won't be in PATH.\nTo install and/or activate in one command, use `mise use` which will create a `mise.toml` file\nin the current directory to activate this tool when inside the directory.\nAlternatively, run `mise exec <TOOL>@<VERSION> -- <COMMAND>` to execute a tool without creating config files.\n\nTools will be installed in parallel. To disable, set `--jobs=1` or `MISE_JOBS=1`"
after_long_help "Examples:\n\n $ mise install node@20.0.0 # install specific node version\n $ mise install node@20 # install fuzzy node version\n $ mise install node # install version specified in mise.toml\n $ mise install # installs everything specified in mise.toml\n"
flag "-f --force" help="Force reinstall even if already installed"
flag "-j --jobs" help="Number of jobs to run in parallel\n[default: 4]" {
arg <JOBS>
}
flag "-n --dry-run" help="Show what would be installed without actually installing"
flag "-v --verbose" help="Show installation output" var=#true count=#true {
long_help "Show installation output\n\nThis argument will print plugin output such as download, configuration, and compilation output."
}
flag --before help="Only install versions released before this date" {
long_help "Only install versions released before this date\n\nSupports absolute dates like \"2024-06-01\" and relative durations like \"90d\" or \"1y\"."
arg <BEFORE>
}
flag --dry-run-code help="Like --dry-run but exits with code 1 if there are tools to install" {
long_help "Like --dry-run but exits with code 1 if there are tools to install\n\nThis is useful for scripts to check if tools need to be installed."
}
flag --raw help="Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1"
arg "[TOOL@VERSION]…" help="Tool(s) to install e.g.: node@20" required=#false var=#true
}
cmd install-into help="Install a tool version to a specific path" {
long_help "Install a tool version to a specific path\n\nUsed for building a tool to a directory for use outside of mise"
after_long_help "Examples:\n\n # install node@20.0.0 into ./mynode\n $ mise install-into node@20.0.0 ./mynode && ./mynode/bin/node -v\n 20.0.0\n"
arg <TOOL@VERSION> help="Tool to install e.g.: node@20"
arg <PATH> help="Path to install the tool into"
}
cmd latest help="Gets the latest available version for a plugin" {
long_help "Gets the latest available version for a plugin\n\nSupports prefixes such as `node@20` to get the latest version of node 20."
after_long_help "Examples:\n\n $ mise latest node@20 # get the latest version of node 20\n 20.0.0\n\n $ mise latest node # get the latest stable version of node\n 20.0.0\n"
flag "-i --installed" help="Show latest installed instead of available version"
arg <TOOL@VERSION> help="Tool to get the latest version of"
arg "[ASDF_VERSION]" help="The version prefix to use when querying the latest version same as the first argument after the \"@\" used for asdf compatibility" required=#false hide=#true
}
cmd link help="Symlinks a tool version into mise" {
alias ln
long_help "Symlinks a tool version into mise\n\nUse this for adding installs either custom compiled outside mise or built with a different tool."
after_long_help "Examples:\n\n # build node-20.0.0 with node-build and link it into mise\n $ node-build 20.0.0 ~/.nodes/20.0.0\n $ mise link node@20.0.0 ~/.nodes/20.0.0\n\n # have mise use the node version provided by Homebrew\n $ brew install node\n $ mise link node@brew $(brew --prefix node)\n $ mise use node@brew\n"
flag "-f --force" help="Overwrite an existing tool version if it exists"
arg <TOOL@VERSION> help="Tool name and version to create a symlink for"
arg <PATH> help="The local path to the tool version\ne.g.: ~/.nvm/versions/node/v20.0.0"
}
cmd local hide=#true help="Sets/gets tool version in local .tool-versions or mise.toml" {
alias l hide=#true
long_help "Sets/gets tool version in local .tool-versions or mise.toml\n\nUse this to set a tool's version when within a directory\nUse `mise global` to set a tool version globally\nThis uses `.tool-version` by default unless there is a `mise.toml` file or if `MISE_USE_TOML`\nis set. A future v2 release of mise will default to using `mise.toml`."
after_long_help "Examples:\n # set the current version of node to 20.x for the current directory\n # will use a precise version (e.g.: 20.0.0) in .tool-versions file\n $ mise local node@20\n\n # set node to 20.x for the current project (recurses up to find .tool-versions)\n $ mise local -p node@20\n\n # set the current version of node to 20.x for the current directory\n # will use a fuzzy version (e.g.: 20) in .tool-versions file\n $ mise local --fuzzy node@20\n\n # removes node from .tool-versions\n $ mise local --remove=node\n\n # show the current version of node in .tool-versions\n $ mise local node\n 20.0.0\n"
flag "-p --parent" help="Recurse up to find a .tool-versions file rather than using the current directory only\nby default this command will only set the tool in the current directory (\"$PWD/.tool-versions\")"
flag --fuzzy help="Save fuzzy version to `.tool-versions` e.g.: `mise local --fuzzy node@20` will save `node 20` to .tool-versions This is the default behavior unless MISE_ASDF_COMPAT=1"
flag --path help="Get the path of the config file"
flag --pin help="Save exact version to `.tool-versions`\ne.g.: `mise local --pin node@20` will save `node 20.0.0` to .tool-versions"
flag --remove help="Remove the plugin(s) from .tool-versions" var=#true {
arg <PLUGIN>
}
arg "[TOOL@VERSION]…" help="Tool(s) to add to .tool-versions/mise.toml\ne.g.: node@20\nif this is a single tool with no version,\nthe current value of .tool-versions/mise.toml will be displayed" required=#false var=#true
}
cmd lock help="Update lockfile checksums and URLs for all specified platforms" {
long_help "Update lockfile checksums and URLs for all specified platforms\n\nUpdates checksums and download URLs for all platforms already specified in the lockfile.\nIf no lockfile exists, shows what would be created based on the current configuration.\nThis allows you to refresh lockfile data for platforms other than the one you're currently on.\nOperates on the lockfile in the current config root. Use TOOL arguments to target specific tools."
after_long_help "Examples:\n\n $ mise lock # update lockfile for all common platforms\n $ mise lock node python # update only node and python\n $ mise lock --platform linux-x64 # update only linux-x64 platform\n $ mise lock --dry-run # show what would be updated\n $ mise lock --local # update mise.local.lock for local configs\n"
flag "-j --jobs" help="Number of jobs to run in parallel" {
arg <JOBS>
}
flag "-n --dry-run" help="Show what would be updated without making changes"
flag "-p --platform" help="Comma-separated list of platforms to target\ne.g.: linux-x64,macos-arm64,windows-x64\nIf not specified, all platforms already in lockfile will be updated" var=#true {
arg <PLATFORM>
}
flag --local help="Update mise.local.lock instead of mise.lock\nUse for tools defined in .local.toml configs"
arg "[TOOL]…" help="Tool(s) to update in lockfile\ne.g.: node python\nIf not specified, all tools in lockfile will be updated" required=#false var=#true
}
cmd ls help="List installed and active tool versions" {
alias list
long_help "List installed and active tool versions\n\nThis command lists tools that mise \"knows about\".\nThese may be tools that are currently installed, or those\nthat are in a config file (active) but may or may not be installed.\n\nIt's a useful command to get the current state of your tools."
after_long_help "Examples:\n\n $ mise ls\n node 20.0.0 ~/src/myapp/.tool-versions latest\n python 3.11.0 ~/.tool-versions 3.10\n python 3.10.0\n\n $ mise ls --current\n node 20.0.0 ~/src/myapp/.tool-versions 20\n python 3.11.0 ~/.tool-versions 3.11.0\n\n $ mise ls --json\n {\n \"node\": [\n {\n \"version\": \"20.0.0\",\n \"install_path\": \"/Users/jdx/.mise/installs/node/20.0.0\",\n \"source\": {\n \"type\": \"mise.toml\",\n \"path\": \"/Users/jdx/mise.toml\"\n }\n }\n ],\n \"python\": [...]\n }\n\n $ mise ls --all-sources\n node 20.0.0 ~/src/myapp/mise.toml 20\n ~/.config/mise/config.toml latest\n"
flag "-c --current" help="Only show tool versions currently specified in a mise.toml"
flag "-g --global" help="Only show tool versions currently specified in the global mise.toml"
flag "-i --installed" help="Only show tool versions that are installed (Hides tools defined in mise.toml but not installed)"
flag "-J --json" help="Output in JSON format"
flag "-l --local" help="Only show tool versions currently specified in the local mise.toml"
flag "-m --missing" help="Display missing tool versions"
flag "-o --offline" help="Don't fetch information such as outdated versions" hide=#true
flag "-p --plugin" hide=#true {
arg <TOOL_FLAG>
}
flag --all-sources help="Display all tracked config sources for tools"
flag --no-header help="Don't display headers"
flag --outdated help="Display whether a version is outdated"
flag --prefix help="Display versions matching this prefix" {
arg <PREFIX>
}
flag --prunable help="List only tools that can be pruned with `mise prune`"
arg "[INSTALLED_TOOL]…" help="Only show tool versions from [TOOL]" required=#false var=#true
}
cmd ls-remote help="List runtime versions available for install." {
alias list-all list-remote hide=#true
long_help "List runtime versions available for install.\n\nNote that the results may be cached, run `mise cache clean` to clear the cache and get fresh results."
after_long_help "Examples:\n\n $ mise ls-remote node\n 18.0.0\n 20.0.0\n\n $ mise ls-remote node@20\n 20.0.0\n 20.1.0\n\n $ mise ls-remote node 20\n 20.0.0\n 20.1.0\n\n $ mise ls-remote github:cli/cli --json\n [{\"version\":\"2.62.0\",\"created_at\":\"2024-11-14T15:40:35Z\"},{\"version\":\"2.61.0\",\"created_at\":\"2024-10-23T19:22:15Z\"}]\n"
flag --all help="Show all installed plugins and versions"
flag "-J --json" help="Output in JSON format (includes version metadata like created_at timestamps when available)"
arg "[TOOL@VERSION]" help="Tool to get versions for" required=#false
arg "[PREFIX]" help="The version prefix to use when querying the latest version\nsame as the first argument after the \"@\"" required=#false
}
cmd mcp help="[experimental] Run Model Context Protocol (MCP) server" {
long_help "[experimental] Run Model Context Protocol (MCP) server\n\nThis command starts an MCP server that exposes mise functionality\nto AI assistants over stdin/stdout using JSON-RPC protocol.\n\nThe MCP server provides access to:\n- Installed and available tools\n- Task definitions and execution\n- Environment variables\n- Configuration information\n- Task execution via the run_task tool\n\nResources available:\n- mise://tools - List all tools (use ?include_inactive=true to include inactive tools)\n- mise://tasks - List all tasks with their configurations\n- mise://env - List all environment variables\n- mise://config - Show configuration files and project root\n\nTools available:\n- install_tool - Install a tool with an optional version (not yet implemented)\n- run_task - Execute a mise task with optional arguments\n\nNote: This is primarily intended for integration with AI assistants like Claude,\nCursor, or other tools that support the Model Context Protocol."
after_long_help "Examples:\n\n # Start the MCP server (typically used by AI assistant tools)\n $ mise mcp\n\n # Example integration with Claude Desktop (add to claude_desktop_config.json):\n {\n \"mcpServers\": {\n \"mise\": {\n \"command\": \"mise\",\n \"args\": [\"mcp\"],\n \"env\": {\n \"MISE_EXPERIMENTAL\": \"1\"\n }\n }\n }\n }\n\n # Interactive testing with JSON-RPC commands:\n $ echo '{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"initialize\",\"params\":{\"protocolVersion\":\"2024-11-05\",\"capabilities\":{},\"clientInfo\":{\"name\":\"test\",\"version\":\"1.0\"}}}' | mise mcp\n\n # Resources you can query:\n - mise://tools - List active tools\n - mise://tools?include_inactive=true - List all installed tools\n - mise://tasks - List all tasks\n - mise://env - List environment variables\n - mise://config - Show configuration info\n\n # Tools available:\n - install_tool - Install a tool (not yet implemented)\n - run_task - Execute a mise task with optional arguments\n Example: {\"task\": \"build\", \"args\": [\"--verbose\"]}\n"
}
cmd outdated help="Shows outdated tool versions" {
long_help "Shows outdated tool versions\n\nSee `mise upgrade` to upgrade these versions."
after_long_help "Examples:\n\n $ mise outdated\n Plugin Requested Current Latest\n python 3.11 3.11.0 3.11.1\n node 20 20.0.0 20.1.0\n\n $ mise outdated node\n Plugin Requested Current Latest\n node 20 20.0.0 20.1.0\n\n $ mise outdated --json\n {\"python\": {\"requested\": \"3.11\", \"current\": \"3.11.0\", \"latest\": \"3.11.1\"}, ...}\n\n $ mise outdated --local\n Plugin Requested Current Latest\n node 20 20.0.0 20.1.0\n"
flag "-J --json" help="Output in JSON format"
flag "-l --bump" help="Compares against the latest versions available, not what matches the current config" {
long_help "Compares against the latest versions available, not what matches the current config\n\nFor example, if you have `node = \"20\"` in your config by default `mise outdated` will only\nshow other 20.x versions, not 21.x or 22.x versions.\n\nUsing this flag, if there are 21.x or newer versions it will display those instead of 20.x."
}
flag --local help="Only show outdated tools defined in local config files" {
long_help "Only show outdated tools defined in local config files\n\nThis will only show tools that are defined in project-local mise.toml and\nwill skip tools defined in the global config (~/.config/mise/config.toml)."
}
flag --no-header help="Don't show table header"
arg "[TOOL@VERSION]…" help="Tool(s) to show outdated versions for\ne.g.: node@20 python@3.10\nIf not specified, all tools in global and local configs will be shown" required=#false var=#true
}
cmd plugins help="Manage plugins" {
alias p
alias plugin plugin-list hide=#true
flag "-a --all" help="list all available remote plugins" hide=#true {
long_help "list all available remote plugins\n\nsame as `mise plugins ls-remote`"
}
flag "-c --core" help="The built-in plugins only\nNormally these are not shown"
flag "-u --urls" help="Show the git url for each plugin\ne.g.: https://github.com/mise-plugins/vfox-cmake.git"
flag --refs help="Show the git refs for each plugin\ne.g.: main 1234abc" hide=#true
flag --user help="List installed plugins" {
long_help "List installed plugins\n\nThis is the default behavior but can be used with --core\nto show core and user plugins"
}
cmd install help="Install a plugin" {
alias i a add
long_help "Install a plugin\n\nnote that mise automatically can install plugins when you install a tool\ne.g.: `mise install cmake@3.30` will autoinstall the cmake plugin\n\nThis behavior can be modified in ~/.config/mise/config.toml"
after_long_help "Examples:\n\n # install the poetry via shorthand\n $ mise plugins install poetry\n\n # install the poetry plugin using a specific git url\n $ mise plugins install poetry https://github.com/mise-plugins/mise-poetry.git\n\n # install the poetry plugin using the git url only\n # (poetry is inferred from the url)\n $ mise plugins install https://github.com/mise-plugins/mise-poetry.git\n\n # install the poetry plugin using a specific ref\n $ mise plugins install poetry https://github.com/mise-plugins/mise-poetry.git#11d0c1e\n"
flag "-a --all" help="Install all missing plugins\nThis will only install plugins that have matching shorthands.\ni.e.: they don't need the full git repo url"
flag "-f --force" help="Reinstall even if plugin exists"
flag "-j --jobs" help="Number of jobs to run in parallel" {
arg <JOBS>
}
flag "-v --verbose" help="Show installation output" var=#true count=#true
arg "[NEW_PLUGIN]" help="The name of the plugin to install\ne.g.: cmake, poetry\nCan specify multiple plugins: `mise plugins install cmake poetry`" required=#false
arg "[GIT_URL]" help="The git url of the plugin" required=#false
arg "[REST]…" required=#false var=#true hide=#true
}
cmd link help="Symlinks a plugin into mise" {
alias ln
long_help "Symlinks a plugin into mise\n\nThis is used for developing a plugin."
after_long_help "Examples:\n\n # essentially just `ln -s ./vfox-cmake ~/.local/share/mise/plugins/cmake`\n $ mise plugins link cmake ./vfox-cmake\n\n # infer plugin name as \"cmake\"\n $ mise plugins link ./vfox-cmake\n"
flag "-f --force" help="Overwrite existing plugin"
arg <NAME> help="The name of the plugin\ne.g.: cmake, poetry"
arg "[DIR]" help="The local path to the plugin\ne.g.: ./vfox-cmake" required=#false
}
cmd ls help="List installed plugins" {
alias list
long_help "List installed plugins\n\nCan also show remotely available plugins to install."
after_long_help "Examples:\n\n $ mise plugins ls\n cmake\n poetry\n\n $ mise plugins ls --urls\n cmake https://github.com/mise-plugins/vfox-cmake.git\n poetry https://github.com/mise-plugins/vfox-poetry.git\n"
flag "-a --all" help="List all available remote plugins\nSame as `mise plugins ls-remote`" hide=#true
flag "-c --core" help="The built-in plugins only\nNormally these are not shown" hide=#true
flag "-o --outdated" help="Show plugins with available updates\nChecks the remote for newer versions and only displays plugins that are outdated"
flag "-u --urls" help="Show the git url for each plugin\ne.g.: https://github.com/mise-plugins/vfox-cmake.git"
flag --refs help="Show the git refs for each plugin\ne.g.: main 1234abc" hide=#true
flag --user help="List installed plugins" hide=#true
}
cmd ls-remote help="List all available remote plugins" {
alias list-remote list-all
long_help "\nList all available remote plugins\n\nThe full list is here: https://github.com/jdx/mise/blob/main/registry/\n\nExamples:\n\n $ mise plugins ls-remote\n"
flag "-u --urls" help="Show the git url for each plugin e.g.: https://github.com/mise-plugins/mise-poetry.git"
flag --only-names help="Only show the name of each plugin by default it will show a \"*\" next to installed plugins"
}
cmd uninstall help="Removes a plugin" {
alias remove rm
after_long_help "Examples:\n\n $ mise plugins uninstall cmake\n"
flag "-a --all" help="Remove all plugins"
flag "-p --purge" help="Also remove the plugin's installs, downloads, and cache"
arg "[PLUGIN]…" help="Plugin(s) to remove" required=#false var=#true
}
cmd update help="Updates a plugin to the latest version" {
alias up upgrade
long_help "Updates a plugin to the latest version\n\nnote: this updates the plugin itself, not the runtime versions"
after_long_help "Examples:\n\n $ mise plugins update # update all plugins\n $ mise plugins update cmake # update only cmake\n $ mise plugins update cmake#beta # specify a ref\n"
flag "-j --jobs" help="Number of jobs to run in parallel\nDefault: 4" {
arg <JOBS>
}
arg "[PLUGIN]…" help="Plugin(s) to update" required=#false var=#true
}
}
cmd prepare help="[experimental] Ensure project dependencies are ready" {
alias prep
long_help "[experimental] Ensure project dependencies are ready\n\nRuns all applicable prepare steps for the current project.\nThis checks if dependency lockfiles are newer than installed outputs\n(e.g., package-lock.json vs node_modules/) and runs install commands\nif needed.\n\nProviders with `auto = true` are automatically invoked before `mise x` and `mise run`\nunless skipped with the --no-prepare flag."
after_long_help "Examples:\n\n $ mise prepare # Run all applicable prepare steps\n $ mise prepare npm # Run only npm prepare\n $ mise prepare npm --explain # Show why npm is fresh or stale\n $ mise prepare --dry-run # Show what would run without executing\n $ mise prepare --force # Force run even if outputs are fresh\n $ mise prepare --list # List available prepare providers\n $ mise prepare --skip npm # Skip npm prepare\n\nConfiguration:\n\n Configure prepare providers in mise.toml:\n\n ```toml\n # Built-in npm provider (auto-detects lockfile)\n [prepare.npm]\n auto = true # Auto-run before mise x/run\n\n # Custom provider\n [prepare.codegen]\n auto = true\n sources = [\"schema/*.graphql\"]\n outputs = [\"src/generated/\"]\n run = \"npm run codegen\"\n\n [prepare]\n disable = [\"npm\"] # Disable specific providers at runtime\n ```\n"
flag --explain help="Show why a provider is fresh or stale (requires a provider argument)"
flag "-f --force" help="Force run all prepare steps even if outputs are fresh"
flag "-n --dry-run" help="Only check if prepare is needed, don't run commands"
flag --list help="Show what prepare steps are available"
flag --only help="Run specific prepare rule(s) only" var=#true {
arg <ONLY>
}
flag --skip help="Skip specific prepare rule(s)" var=#true {
arg <SKIP>
}
arg "[PROVIDER]" help="Provider to operate on (runs only this provider, or use with --explain)" required=#false
}
cmd prune help="Delete unused versions of tools" {
long_help "Delete unused versions of tools\n\nmise tracks which config files have been used in ~/.local/state/mise/tracked-configs\nVersions which are no longer the latest specified in any of those configs are deleted.\nVersions installed only with environment variables `MISE_<PLUGIN>_VERSION` will be deleted,\nas will versions only referenced on the command line `mise exec <PLUGIN>@<VERSION>`.\n\nYou can list prunable tools with `mise ls --prunable`"
after_long_help "Examples:\n\n $ mise prune --dry-run\n rm -rf ~/.local/share/mise/versions/node/20.0.0\n rm -rf ~/.local/share/mise/versions/node/20.0.1\n"
flag "-n --dry-run" help="Do not actually delete anything"
flag --configs help="Prune only tracked and trusted configuration links that point to non-existent configurations"
flag --dry-run-code help="Like --dry-run but exits with code 1 if there are tools to prune" {
long_help "Like --dry-run but exits with code 1 if there are tools to prune\n\nThis is useful for scripts to check if tools need to be pruned."
}
flag --tools help="Prune only unused versions of tools"
arg "[INSTALLED_TOOL]…" help="Prune only these tools" required=#false var=#true
}
cmd registry help="List available tools to install" {
long_help "List available tools to install\n\nThis command lists the tools available in the registry as shorthand names.\n\nFor example, `poetry` is shorthand for `asdf:mise-plugins/mise-poetry`."
after_long_help "Examples:\n\n $ mise registry\n node core:node\n poetry asdf:mise-plugins/mise-poetry\n ubi cargo:ubi-cli\n\n $ mise registry poetry\n asdf:mise-plugins/mise-poetry\n"
flag "-b --backend" help="Show only tools for this backend" {
arg <BACKEND>
}
flag --complete help="Print all tools with descriptions for shell completions" hide=#true
flag --hide-aliased help="Hide aliased tools"
flag "-J --json" help="Output in JSON format"
arg "[NAME]" help="Show only the specified tool's full name" required=#false
}
cmd render-help hide=#true help="internal command to generate markdown from help"
cmd reshim help="Creates new shims based on bin paths from currently installed tools." {
long_help "Creates new shims based on bin paths from currently installed tools.\n\nThis creates new shims in ~/.local/share/mise/shims for CLIs that have been added.\nmise will try to do this automatically for commands like `npm i -g` but there are\nother ways to install things (like using yarn or pnpm for node) that mise does\nnot know about and so it will be necessary to call this explicitly.\n\nIf you think mise should automatically call this for a particular command, please\nopen an issue on the mise repo. You can also setup a shell function to reshim\nautomatically (it's really fast so you don't need to worry about overhead):\n\n npm() {\n command npm \"$@\"\n mise reshim\n }\n\nNote that this creates shims for _all_ installed tools, not just the ones that are\ncurrently active in mise.toml."
after_long_help "Examples:\n\n $ mise reshim\n $ ~/.local/share/mise/shims/node -v\n v20.0.0\n"
flag "-f --force" help="Removes all shims before reshimming"
arg "[PLUGIN]" required=#false hide=#true
arg "[VERSION]" required=#false hide=#true
}
cmd run restart_token=::: help="Run task(s)" {
alias r
long_help "Run task(s)\n\nThis command will run a task, or multiple tasks in parallel.\nTasks may have dependencies on other tasks or on source files.\nIf source is configured on a task, it will only run if the source\nfiles have changed.\n\nTasks can be defined in mise.toml or as standalone scripts.\nIn mise.toml, tasks take this form:\n\n [tasks.build]\n run = \"npm run build\"\n sources = [\"src/**/*.ts\"]\n outputs = [\"dist/**/*.js\"]\n\nAlternatively, tasks can be defined as standalone scripts.\nThese must be located in `mise-tasks`, `.mise-tasks`, `.mise/tasks`, `mise/tasks` or\n`.config/mise/tasks`.\nThe name of the script will be the name of the tasks.\n\n $ cat .mise/tasks/build<<EOF\n #!/usr/bin/env bash\n npm run build\n EOF\n $ mise run build"
after_long_help "Examples:\n\n # Runs the \"lint\" tasks. This needs to either be defined in mise.toml\n # or as a standalone script. See the project README for more information.\n $ mise run lint\n\n # Forces the \"build\" tasks to run even if its sources are up-to-date.\n $ mise run --force build\n\n # Run \"test\" with stdin/stdout/stderr all connected to the current terminal.\n # This forces `--jobs=1` to prevent interleaving of output.\n $ mise run --raw test\n\n # Runs the \"lint\", \"test\", and \"check\" tasks in parallel.\n $ mise run lint ::: test ::: check\n\n # Execute multiple tasks each with their own arguments.\n $ mise run cmd1 arg1 arg2 ::: cmd2 arg1 arg2\n"
flag "-c --continue-on-error" help="Continue running tasks even if one fails"
flag "-C --cd" help="Change to this directory before executing the command" {
arg <CD>
}
flag "-f --force" help="Force the tasks to run even if outputs are up to date"
flag "-i --interleave" help="Print directly to stdout/stderr instead of by line\nDefaults to true if --jobs == 1\nConfigure with `task.output` config or `MISE_TASK_OUTPUT` env var" hide=#true
flag "-j --jobs" help="Number of tasks to run in parallel\n[default: 4]\nConfigure with `jobs` config or `MISE_JOBS` env var" {
arg <JOBS>
}
flag "-n --dry-run" help="Don't actually run the task(s), just print them in order of execution"
flag "-o --output" help="Change how tasks information is output when running tasks" {
long_help "Change how tasks information is output when running tasks\n\n- `prefix` - Print stdout/stderr by line, prefixed with the task's label\n- `interleave` - Print directly to stdout/stderr instead of by line\n- `replacing` - Stdout is replaced each time, stderr is printed as is\n- `timed` - Only show stdout lines if they are displayed for more than 1 second\n- `keep-order` - Print stdout/stderr by line, prefixed with the task's label, but keep the order of the output\n- `quiet` - Don't show extra output\n- `silent` - Don't show any output including stdout and stderr from the task except for errors"
arg <OUTPUT>
}
flag "-p --prefix" help="Print stdout/stderr by line, prefixed with the task's label\nDefaults to true if --jobs > 1\nConfigure with `task.output` config or `MISE_TASK_OUTPUT` env var" hide=#true
flag "-q --quiet" help="Don't show extra output"
flag "-r --raw" help="Read/write directly to stdin/stdout/stderr instead of by line\nRedactions are not applied with this option\nConfigure with `raw` config or `MISE_RAW` env var"
flag "-s --shell" help="Shell to use to run toml tasks" {
long_help "Shell to use to run toml tasks\n\nDefaults to `sh -c -o errexit -o pipefail` on unix, and `cmd /c` on Windows\nCan also be set with the setting `MISE_UNIX_DEFAULT_INLINE_SHELL_ARGS` or `MISE_WINDOWS_DEFAULT_INLINE_SHELL_ARGS`\nOr it can be overridden with the `shell` property on a task."
arg <SHELL>
}
flag "-S --silent" help="Don't show any output except for errors"
flag "-t --tool" help="Tool(s) to run in addition to what is in mise.toml files e.g.: node@20 python@3.10" var=#true {
arg <TOOL@VERSION>
}
flag --fresh-env help="Bypass the environment cache and recompute the environment"
flag --no-cache help="Do not use cache on remote tasks"
flag --no-prepare help="Skip automatic dependency preparation"
flag --no-timings help="Hides elapsed time after each task completes" {
long_help "Hides elapsed time after each task completes\n\nDefault to always hide with `MISE_TASK_TIMINGS=0`"
}
flag --skip-deps help="Run only the specified tasks skipping all dependencies"
flag --timeout help="Timeout for the task to complete\ne.g.: 30s, 5m" {
arg <TIMEOUT>
}
flag --timings help="Shows elapsed time after each task completes" hide=#true {
long_help "Shows elapsed time after each task completes\n\nDefault to always show with `MISE_TASK_TIMINGS=1`"
}
mount run="mise tasks --usage"
}
cmd search help="Search for tools in the registry" {
long_help "Search for tools in the registry\n\nThis command searches a tool in the registry.\n\nBy default, it will show all tools that fuzzy match the search term. For\nnon-fuzzy matches, use the `--match-type` flag."
after_long_help "Examples:\n\n $ mise search jq\n Tool Description\n jq Command-line JSON processor. https://github.com/jqlang/jq\n jqp A TUI playground to experiment with jq. https://github.com/noahgorstein/jqp\n jiq jid on jq - interactive JSON query tool using jq expressions. https://github.com/fiatjaf/jiq\n gojq Pure Go implementation of jq. https://github.com/itchyny/gojq\n\n $ mise search --interactive\n Tool\n Search a tool\n ❯ jq Command-line JSON processor. https://github.com/jqlang/jq\n jqp A TUI playground to experiment with jq. https://github.com/noahgorstein/jqp\n jiq jid on jq - interactive JSON query tool using jq expressions. https://github.com/fiatjaf/jiq\n gojq Pure Go implementation of jq. https://github.com/itchyny/gojq\n /jq \n esc clear filter • enter confirm\n"
flag "-i --interactive" help="Show interactive search"
flag "-m --match-type" help="Match type: equal, contains, or fuzzy" default=fuzzy {
arg <MATCH_TYPE> {
choices equal contains fuzzy
}
}
flag --no-header help="Don't display headers"
arg "[NAME]" help="The tool to search for" required=#false
}
cmd self-update help="Updates mise itself." {
long_help "Updates mise itself.\n\nUses the GitHub Releases API to find the latest release and binary.\nBy default, this will also update any installed plugins.\nUses the `GITHUB_API_TOKEN` environment variable if set for higher rate limits.\n\nThis command is not available if mise is installed via a package manager."
flag "-f --force" help="Update even if already up to date"
flag "-y --yes" help="Skip confirmation prompt"
flag --no-plugins help="Disable auto-updating plugins"
arg "[VERSION]" help="Update to a specific version" required=#false
}
cmd set help="Set environment variables in mise.toml" {
alias ev env-vars hide=#true
long_help "Set environment variables in mise.toml\n\nBy default, this command modifies `mise.toml` in the current directory.\nIf multiple config files exist (e.g., both `mise.toml` and `mise.local.toml`),\nthe lowest precedence file (`mise.toml`) will be used.\nSee https://mise.jdx.dev/configuration.html#target-file-for-write-operations\n\nUse `-E <env>` to create/modify environment-specific config files like `mise.<env>.toml`."
after_long_help "Examples:\n\n $ mise set NODE_ENV=production\n\n $ mise set NODE_ENV\n production\n\n $ mise set -E staging NODE_ENV=staging\n # creates or modifies mise.staging.toml\n\n $ mise set\n key value source\n NODE_ENV production ~/.config/mise/config.toml\n\n $ mise set --prompt PASSWORD\n Enter value for PASSWORD: [hidden input]\n\n Multiline Values (--stdin):\n\n $ cat private.key | mise set --stdin MY_KEY\n\n $ printf \"line1\\nline2\" | mise set --stdin MY_KEY\n\n [experimental] Age Encryption:\n\n $ mise set --age-encrypt API_KEY=secret\n\n $ mise set --age-encrypt --prompt API_KEY\n Enter value for API_KEY: [hidden input]\n"
flag "-E --env" help="Create/modify an environment-specific config file like .mise.<env>.toml" {
arg <ENV>
}
flag "-g --global" help="Set the environment variable in the global config file"
flag --age-encrypt help="[experimental] Encrypt the value with age before storing"
flag --age-key-file help="[experimental] Age identity file for encryption" {
long_help "[experimental] Age identity file for encryption\n\nDefaults to ~/.config/mise/age.txt if it exists"
arg <PATH>
}
flag --age-recipient help="[experimental] Age recipient (x25519 public key) for encryption" var=#true {
long_help "[experimental] Age recipient (x25519 public key) for encryption\n\nCan be used multiple times. Requires --age-encrypt."
arg <RECIPIENT>
}
flag --age-ssh-recipient help="[experimental] SSH recipient (public key or path) for age encryption" var=#true {
long_help "[experimental] SSH recipient (public key or path) for age encryption\n\nCan be used multiple times. Requires --age-encrypt."
arg <PATH_OR_PUBKEY>
}
flag --complete help="Render completions" hide=#true
flag --file help="The TOML file to update" {
long_help "The TOML file to update\n\nCan be a file path or directory. If a directory is provided, will create/use mise.toml in that directory.\nDefaults to MISE_DEFAULT_CONFIG_FILENAME environment variable, or `mise.toml`."
arg <FILE>
}
flag --prompt help="Prompt for environment variable values"
flag "--remove --rm --unset" help="Remove the environment variable from config file" var=#true hide=#true {
long_help "Remove the environment variable from config file\n\nCan be used multiple times."
arg <ENV_KEY>
}
flag --stdin help="Read the value from stdin (for multiline input)" {
long_help "Read the value from stdin (for multiline input)\n\nWhen using --stdin, provide a single key without a value. The value will be read from stdin until EOF."
}
arg "[ENV_VAR]…" help="Environment variable(s) to set\ne.g.: NODE_ENV=production" required=#false var=#true
}
cmd settings help="Manage settings" {
long_help "Show current settings\n\nThis is the contents of ~/.config/mise/config.toml\n\nNote that aliases are also stored in this file\nbut managed separately with `mise tool-alias`"
after_long_help "Examples:\n # list all settings\n $ mise settings\n\n # get the value of the setting \"always_keep_download\"\n $ mise settings always_keep_download\n\n # set the value of the setting \"always_keep_download\" to \"true\"\n $ mise settings always_keep_download=true\n\n # set the value of the setting \"node.mirror_url\" to \"https://npm.taobao.org/mirrors/node\"\n $ mise settings node.mirror_url https://npm.taobao.org/mirrors/node\n"
flag "-a --all" help="List all settings"
flag "-J --json" help="Output in JSON format"
flag "-l --local" help="Use the local config file instead of the global one" global=#true
flag "-T --toml" help="Output in TOML format"
flag --complete help="Print all settings with descriptions for shell completions" hide=#true
flag --json-extended help="Output in JSON format with sources"
arg "[SETTING]" help="Name of setting" required=#false
arg "[VALUE]" help="Setting value to set" required=#false
cmd add help="Adds a setting to the configuration file" {
long_help "Adds a setting to the configuration file\n\nUsed with an array setting, this will append the value to the array.\nThis modifies the contents of ~/.config/mise/config.toml"
after_long_help "Examples:\n\n $ mise settings add disable_hints python_multi\n"
flag "-l --local" help="Use the local config file instead of the global one"
arg <SETTING> help="The setting to set"
arg "[VALUE]" help="The value to set (optional if provided as KEY=VALUE)" required=#false
}
cmd get help="Show a current setting" {
long_help "Show a current setting\n\nThis is the contents of a single entry in ~/.config/mise/config.toml\n\nNote that aliases are also stored in this file\nbut managed separately with `mise tool-alias get`"
after_long_help "Examples:\n\n $ mise settings get idiomatic_version_file\n true\n"
flag "-l --local" help="Use the local config file instead of the global one"
arg <SETTING> help="The setting to show"
}
cmd ls help="Show current settings" {
alias list
long_help "Show current settings\n\nThis is the contents of ~/.config/mise/config.toml\n\nNote that aliases are also stored in this file\nbut managed separately with `mise tool-alias`"
after_long_help "Examples:\n\n $ mise settings ls\n idiomatic_version_file = false\n ...\n\n $ mise settings ls python\n default_packages_file = \"~/.default-python-packages\"\n ...\n"
flag "-a --all" help="List all settings"
flag "-J --json" help="Output in JSON format"
flag "-l --local" help="Use the local config file instead of the global one" global=#true
flag "-T --toml" help="Output in TOML format"
flag --complete help="Print all settings with descriptions for shell completions" hide=#true
flag --json-extended help="Output in JSON format with sources"
arg "[SETTING]" help="Name of setting" required=#false
}
cmd set help="Add/update a setting" {
alias create
long_help "Add/update a setting\n\nThis modifies the contents of ~/.config/mise/config.toml by default.\nWith `--local`, modifies the local config file instead.\nSee https://mise.jdx.dev/configuration.html#target-file-for-write-operations"
after_long_help "Examples:\n\n $ mise settings idiomatic_version_file=true\n"
flag "-l --local" help="Use the local config file instead of the global one"
arg <SETTING> help="The setting to set"
arg "[VALUE]" help="The value to set (optional if provided as KEY=VALUE)" required=#false
}
cmd unset help="Clears a setting" {
alias rm remove delete del
long_help "Clears a setting\n\nThis modifies the contents of ~/.config/mise/config.toml"
after_long_help "Examples:\n\n $ mise settings unset idiomatic_version_file\n"
flag "-l --local" help="Use the local config file instead of the global one"
arg <KEY> help="The setting to remove"
}
}
cmd shell help="Sets a tool version for the current session." {
alias sh
long_help "Sets a tool version for the current session.\n\nOnly works in a session where mise is already activated.\n\nThis works by setting environment variables for the current shell session\nsuch as `MISE_NODE_VERSION=20` which is \"eval\"ed as a shell function created by `mise activate`."
after_long_help "Examples:\n\n $ mise shell node@20\n $ node -v\n v20.0.0\n"
flag "-j --jobs" help="Number of jobs to run in parallel\n[default: 4]" {
arg <JOBS>
}
flag "-u --unset" help="Removes a previously set version"
flag --raw help="Directly pipe stdin/stdout/stderr from plugin to user Sets --jobs=1"
arg <TOOL@VERSION>… help="Tool(s) to use" var=#true
}
cmd shell-alias help="Manage shell aliases." {
flag --no-header help="Don't show table header"
cmd get help="Show the command for a shell alias" {
after_long_help "Examples:\n\n $ mise shell-alias get ll\n ls -la\n"
arg <shell_alias> help="The alias to show"
}
cmd ls help="List shell aliases" {
alias list
long_help "List shell aliases\n\nShows the shell aliases that are set in the current directory.\nThese are defined in `mise.toml` under the `[shell_alias]` section."
after_long_help "Examples:\n\n $ mise shell-alias ls\n alias command\n ll ls -la\n gs git status\n"
flag --no-header help="Don't show table header"
}
cmd set help="Add/update a shell alias" {
alias add create
long_help "Add/update a shell alias\n\nThis modifies the contents of ~/.config/mise/config.toml"
after_long_help "Examples:\n\n $ mise shell-alias set ll \"ls -la\"\n $ mise shell-alias set gs \"git status\"\n"
arg <shell_alias> help="The alias name"
arg "[COMMAND]" help="The command to run (optional if provided as ALIAS=COMMAND)" required=#false
}
cmd unset help="Removes a shell alias" {
alias rm remove delete del
long_help "Removes a shell alias\n\nThis modifies the contents of ~/.config/mise/config.toml"
after_long_help "Examples:\n\n $ mise shell-alias unset ll\n"
arg <shell_alias> help="The alias to remove"
}
}
cmd sync subcommand_required=#true help="Synchronize tools from other version managers with mise" {
cmd node help="Symlinks all tool versions from an external tool into mise" {
long_help "Symlinks all tool versions from an external tool into mise\n\nFor example, use this to import all Homebrew node installs into mise\n\nThis won't overwrite any existing installs but will overwrite any existing symlinks"
after_long_help "Examples:\n\n $ brew install node@18 node@20\n $ mise sync node --brew\n $ mise use -g node@18 - uses Homebrew-provided node\n"
flag --brew help="Get tool versions from Homebrew"
flag --nodenv help="Get tool versions from nodenv"
flag --nvm help="Get tool versions from nvm"
}
cmd python help="Symlinks all tool versions from an external tool into mise" {
long_help "Symlinks all tool versions from an external tool into mise\n\nFor example, use this to import all pyenv installs into mise\n\nThis won't overwrite any existing installs but will overwrite any existing symlinks"
after_long_help "Examples:\n\n $ pyenv install 3.11.0\n $ mise sync python --pyenv\n $ mise use -g python@3.11.0 - uses pyenv-provided python\n \n $ uv python install 3.11.0\n $ mise install python@3.10.0\n $ mise sync python --uv\n $ mise x python@3.11.0 -- python -V - uses uv-provided python\n $ uv run -p 3.10.0 -- python -V - uses mise-provided python\n"
flag --pyenv help="Get tool versions from pyenv"
flag --uv help="Sync tool versions with uv (2-way sync)"
}
cmd ruby help="Symlinks all ruby tool versions from an external tool into mise" {
after_long_help "Examples:\n\n $ brew install ruby\n $ mise sync ruby --brew\n $ mise use -g ruby - Use the latest version of Ruby installed by Homebrew\n"
flag --brew help="Get tool versions from Homebrew"
}
}
cmd tasks help="Manage tasks" {
alias t
alias task hide=#true
after_long_help "Examples:\n\n $ mise tasks ls\n"
flag "-g --global" help="Only show global tasks" global=#true
flag "-J --json" help="Output in JSON format" global=#true
flag "-l --local" help="Only show non-global tasks" global=#true
flag "-x --extended" help="Show all columns" global=#true
flag --all help="Load all tasks from the entire monorepo, including sibling directories.\nBy default, only tasks from the current directory hierarchy are loaded." global=#true
flag --complete help="Display tasks for usage completion" hide=#true
flag --hidden help="Show hidden tasks" global=#true
flag --no-header help="Do not print table header" global=#true
flag --sort help="Sort by column. Default is name." global=#true {
arg <COLUMN> {
choices name alias description source
}
}
flag --sort-order help="Sort order. Default is asc." global=#true {
arg <SORT_ORDER> {
choices asc desc
}
}
flag --usage hide=#true global=#true
arg "[TASK]" help="Task name to get info of" required=#false
cmd add help="Create a new task" {
long_help "Create a new task\n\nAdds a task to the local mise.toml file.\nSee https://mise.jdx.dev/configuration.html#target-file-for-write-operations"
after_long_help "Examples:\n\n $ mise tasks add pre-commit --depends \"test\" --depends \"render\" -- echo pre-commit\n"
flag "-a --alias" help="Other names for the task" var=#true {
arg <ALIAS>
}
flag "-d --depends" help="Add dependencies to the task" var=#true {
arg <DEPENDS>
}
flag "-D --dir" help="Run the task in a specific directory" {
arg <DIR>
}
flag "-f --file" help="Create a file task instead of a toml task"
flag "-H --hide" help="Hide the task from `mise tasks` and completions"
flag "-q --quiet" help="Do not print the command before running"
flag "-r --raw" help="Directly connect stdin/stdout/stderr"
flag "-s --sources" help="Glob patterns of files this task uses as input" var=#true {
arg <SOURCES>
}
flag "-w --wait-for" help="Wait for these tasks to complete if they are to run" var=#true {
arg <WAIT_FOR>
}
flag --depends-post help="Dependencies to run after the task runs" var=#true {
arg <DEPENDS_POST>
}
flag --description help="Description of the task" {
arg <DESCRIPTION>
}
flag --outputs help="Glob patterns of files this task creates, to skip if they are not modified" var=#true {
arg <OUTPUTS>
}
flag --run-windows help="Command to run on windows" {
arg <RUN_WINDOWS>
}
flag --shell help="Run the task in a specific shell" {
arg <SHELL>
}
flag --silent help="Do not print the command or its output"
arg <TASK> help="Tasks name to add"
arg "[-- RUN]…" required=#false var=#true
}
cmd deps help="Display a tree visualization of a dependency graph" {
after_long_help "Examples:\n\n # Show dependencies for all tasks\n $ mise tasks deps\n\n # Show dependencies for the \"lint\", \"test\" and \"check\" tasks\n $ mise tasks deps lint test check\n\n # Show dependencies in DOT format\n $ mise tasks deps --dot\n"
flag --dot help="Display dependencies in DOT format"
flag --hidden help="Show hidden tasks"
arg "[TASKS]…" help="Tasks to show dependencies for\nCan specify multiple tasks by separating with spaces\ne.g.: mise tasks deps lint test check" required=#false var=#true
}
cmd edit help="Edit a task with $EDITOR" {
long_help "Edit a task with $EDITOR\n\nThe task will be created as a standalone script if it does not already exist."
after_long_help "Examples:\n\n $ mise tasks edit build\n $ mise tasks edit test\n"
flag "-p --path" help="Display the path to the task instead of editing it"
arg <TASK> help="Task to edit"
}
cmd info help="Get information about a task" {
after_long_help "Examples:\n\n $ mise tasks info\n Name: test\n Aliases: t\n Description: Test the application\n Source: ~/src/myproj/mise.toml\n\n $ mise tasks info test --json\n {\n \"name\": \"test\",\n \"aliases\": \"t\",\n \"description\": \"Test the application\",\n \"source\": \"~/src/myproj/mise.toml\",\n \"depends\": [],\n \"env\": {},\n \"dir\": null,\n \"hide\": false,\n \"raw\": false,\n \"sources\": [],\n \"outputs\": [],\n \"run\": [\n \"echo \\\"testing!\\\"\"\n ],\n \"file\": null,\n \"usage_spec\": {}\n }\n"
flag "-J --json" help="Output in JSON format"
arg <TASK> help="Name of the task to get information about"
}
cmd ls help="List available tasks to execute\nThese may be included from the config file or from the project's .mise/tasks directory\nmise will merge all tasks from all parent directories into this list." {
long_help "List available tasks to execute\nThese may be included from the config file or from the project's .mise/tasks directory\nmise will merge all tasks from all parent directories into this list.\n\nSo if you have global tasks in `~/.config/mise/tasks/*` and project-specific tasks in\n~/myproject/.mise/tasks/*, then they'll both be available but the project-specific\ntasks will override the global ones if they have the same name."
after_long_help "Examples:\n\n $ mise tasks ls\n"
flag "-g --global" help="Only show global tasks" global=#true
flag "-J --json" help="Output in JSON format" global=#true
flag "-l --local" help="Only show non-global tasks" global=#true
flag "-x --extended" help="Show all columns" global=#true
flag --all help="Load all tasks from the entire monorepo, including sibling directories.\nBy default, only tasks from the current directory hierarchy are loaded." global=#true
flag --complete help="Display tasks for usage completion" hide=#true
flag --hidden help="Show hidden tasks" global=#true
flag --no-header help="Do not print table header" global=#true
flag --sort help="Sort by column. Default is name." global=#true {
arg <COLUMN> {
choices name alias description source
}