-
Notifications
You must be signed in to change notification settings - Fork 295
/
settings.toml
969 lines (819 loc) · 29.5 KB
/
settings.toml
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
# This file generates code and documentation for settings in mise
# When this file is updated, run `mise run render` to update generated files
[activate_aggressive]
env = "MISE_ACTIVATE_AGGRESSIVE"
type = "Bool"
description = "Pushes tools' bin-paths to the front of PATH instead of allowing modifications of PATH after activation to take precedence."
docs = """
Pushes tools' bin-paths to the front of PATH instead of allowing modifications of PATH after activation to take precedence. For example, if you have the following in your `mise.toml`:
```toml
[tools]
node = '20'
python = '3.12'
```
But you also have this in your `~/.zshrc`:
```sh
eval "$(mise activate zsh)"
PATH="/some/other/python:$PATH"
```
What will happen is `/some/other/python` will be used instead of the python installed by mise. This
means
you typically want to put `mise activate` at the end of your shell config so nothing overrides it.
If you want to always use the mise versions of tools despite what is in your shell config, set this
to `true`.
In that case, using this example again, `/some/other/python` will be after mise's python in PATH.
"""
[all_compile]
env = "MISE_ALL_COMPILE"
type = "Bool"
description = "do not use precompiled binaries for any tool"
docs = """
Default: false unless running NixOS or Alpine (let me know if others should be added)
Do not use precompiled binaries for all languages. Useful if running on a Linux distribution
like Alpine that does not use glibc and therefore likely won't be able to run precompiled binaries.
Note that this needs to be setup for each language. File a ticket if you notice a language that is
not
working with this config.
"""
[always_keep_download]
env = "MISE_ALWAYS_KEEP_DOWNLOAD"
type = "Bool"
description = "should mise keep downloaded files after installation"
[always_keep_install]
env = "MISE_ALWAYS_KEEP_INSTALL"
type = "Bool"
description = "should mise keep install files after installation even if the installation fails"
[aqua.cosign]
env = "MISE_AQUA_COSIGN"
type = "Bool"
default = true
description = "Use cosign to verify aqua tool signatures."
[aqua.registry_url]
env = "MISE_AQUA_REGISTRY_URL"
type = "Url"
optional = true
description = "URL to fetch aqua registry from."
docs = """
URL to fetch aqua registry from. This is used to install tools from the aqua registry.
By default, the official aqua registry is used: https://github.com/aquaproj/aqua-registry
However when this is not specified, instead of cloning the entire registry each individual tool's metadata is fetched
via HTTP individually.
"""
[aqua.slsa]
env = "MISE_AQUA_SLSA"
type = "Bool"
default = true
description = "Use SLSA to verify aqua tool signatures."
[asdf]
env = "MISE_ASDF"
type = "Bool"
hide = true
optional = true
deprecated = "Use disable_backends instead."
description = "use asdf as a default plugin backend"
docs = """
Use asdf as a default plugin backend. This means running something like `mise use cmake` will
default to using an asdf plugin for cmake.
"""
[asdf_compat]
env = "MISE_ASDF_COMPAT"
type = "Bool"
description = "set to true to ensure .tool-versions will be compatible with asdf"
docs = """
Only output `.tool-versions` files in `mise local|global` which will be usable by asdf.
This disables mise functionality that would otherwise make these files incompatible with asdf such
as non-pinned versions.
This will also change the default global tool config to be `~/.tool-versions` instead
of `~/.config/mise/config.toml`.
"""
[cache_prune_age]
env = "MISE_CACHE_PRUNE_AGE"
type = "Duration"
default = "30d"
description = "Delete files in cache that have not been accessed in this duration"
docs = """
The age of the cache before it is considered stale. mise will occasionally delete cache files which
have not been accessed in this amount of time.
Set to `0s` to keep cache files indefinitely.
"""
[cargo.binstall]
env = "MISE_CARGO_BINSTALL"
type = "Bool"
default = true
description = "Use cargo-binstall instead of cargo install if available"
docs = """
If true, mise will use `cargo binstall` instead of `cargo install` if
[`cargo-binstall`](https://crates.io/crates/cargo-binstall) is installed and on PATH.
This makes installing CLIs with cargo _much_ faster by downloading precompiled binaries.
You can install it with mise:
```sh
mise use -g cargo-binstall
```
"""
[cargo_binstall]
type = "Bool"
hide = true
optional = true
description = "Use cargo-binstall instead of cargo install if available"
[cd]
env = "MISE_CD"
type = "Path"
optional = true
description = "Path to change to after launching mise"
hide = true
[ci]
env = "CI"
type = "Bool"
description = "Set to true if running in a CI environment"
hide = true
[color]
env = "MISE_COLOR"
type = "Bool"
default = true
description = "Use color in mise terminal output"
[debug]
env = "MISE_DEBUG"
type = "Bool"
hide = true
description = "Sets log level to debug"
[default_config_filename]
env = "MISE_DEFAULT_CONFIG_FILENAME"
type = "String"
default = "mise.toml"
description = "The default config filename read. `mise use` and other commands that create new config files will use this value. This must be an env var."
[default_tool_versions_filename]
env = "MISE_DEFAULT_TOOL_VERSIONS_FILENAME"
type = "String"
default = ".tool-versions"
description = "The default .tool-versions filename read. `mise use` and other commands that write to new config files will use this if asdf_compat=1. This must be an env var."
[disable_backends]
env = "MISE_DISABLE_BACKENDS"
type = "ListString"
rust_type = "Vec<String>"
default = []
parse_env = "list_by_comma"
description = "Backends to disable such as `asdf` or `pipx`"
[disable_default_registry]
env = "MISE_DISABLE_DEFAULT_REGISTRY"
type = "Bool"
description = "Disable the default mapping of short tool names like `go` -> `vfox:version-fox/vfox-golang`"
[disable_default_shorthands]
env = "MISE_DISABLE_DEFAULT_SHORTHANDS"
type = "Bool"
description = "Disables built-in shorthands to asdf/vfox plugins"
deprecated = "Replaced with `disable_default_registry`"
hide = true
optional = true
docs = """
Disables the shorthand aliases for installing plugins. You will have to specify full URLs when
installing plugins, e.g.: `mise plugin install node https://github.com/asdf-vm/asdf-node.git`
"""
[disable_hints]
env = "MISE_DISABLE_HINTS"
type = "ListString"
rust_type = "BTreeSet<String>"
default = []
parse_env = "list_by_comma"
description = "Turns off helpful hints when using different mise features"
[disable_tools]
env = "MISE_DISABLE_TOOLS"
type = "ListString"
rust_type = "BTreeSet<String>"
default = []
parse_env = "list_by_comma"
description = "Tools defined in mise.toml that should be ignored"
[env]
env = "MISE_ENV"
type = "String"
description = "Env to use for mise.<MISE_ENV>.toml files."
optional = true
docs = """
Enables profile-specific config files such as `.mise.development.toml`.
Use this for different env vars or different tool versions in
development/staging/production environments. See
[Configuration Environments](/configuration/environments) for more on how
to use this feature.
"""
[env_file]
env = "MISE_ENV_FILE"
type = "Path"
optional = true
description = "Path to a file containing environment variables."
hide = true
[exec_auto_install]
env = "MISE_EXEC_AUTO_INSTALL"
type = "Bool"
default = true
description = "Automatically install missing tools when running `mise x`."
[experimental]
env = "MISE_EXPERIMENTAL"
type = "Bool"
description = "Enable experimental mise features which are incomplete or unstable—breakings changes may occur"
docs = """
Enables experimental features. I generally will publish new features under
this config which needs to be enabled to use them. While a feature is marked
as "experimental" its behavior may change or even disappear in any release.
The idea is experimental features can be iterated on this way so we can get
the behavior right, but once that label goes away you shouldn't expect things
to change without a proper deprecation—and even then it's unlikely.
Also, I very often will use experimental as a beta flag as well. New
functionality that I want to test with a smaller subset of users I will often
push out under experimental mode even if it's not related to an experimental
feature.
If you'd like to help me out, consider enabling it even if you don't have
a particular feature you'd like to try. Also, if something isn't working
right, try disabling it if you can.
"""
[fetch_remote_versions_cache]
env = "MISE_FETCH_REMOTE_VERSIONS_CACHE"
type = "Duration"
default = "1h"
description = "How long to cache remote versions for tools."
docs = """
duration that remote version cache is kept for
"fast" commands (represented by PREFER_STALE), these are always
cached. For "slow" commands like `mise ls-remote` or `mise install`:
- if MISE_FETCH_REMOTE_VERSIONS_CACHE is set, use that
- if MISE_FETCH_REMOTE_VERSIONS_CACHE is not set, use HOURLY
"""
[fetch_remote_versions_timeout]
env = "MISE_FETCH_REMOTE_VERSIONS_TIMEOUT"
type = "Duration"
default = "10s"
description = "Timeout in seconds for HTTP requests to fetch new tool versions in mise."
aliases = ["fetch_remote_version_timeout"]
[global_config_file]
env = "MISE_GLOBAL_CONFIG_FILE"
type = "Path"
optional = true
description = "Path to the global mise config file. Default is `~/.config/mise/config.toml`. This must be an env var."
[go_default_packages_file]
env = "MISE_GO_DEFAULT_PACKAGES_FILE"
type = "Path"
default = "~/.default-go-packages"
description = "Path to a file containing default go packages to install when installing go"
[go_download_mirror]
env = "MISE_GO_DOWNLOAD_MIRROR"
type = "String"
default = "https://dl.google.com/go"
description = "Mirror to download go sdk tarballs from."
[go_repo]
env = "MISE_GO_REPO"
type = "Url"
default = "https://github.com/golang/go"
description = "URL to fetch go from."
[go_set_gobin]
env = "MISE_GO_SET_GOBIN"
type = "Bool"
optional = true
description = "Changes where `go install` installs binaries to."
docs = """
Defaults to `~/.local/share/mise/installs/go/.../bin`.
Set to `true` to override GOBIN if previously set.
Set to `false` to not set GOBIN (default is `${GOPATH:-$HOME/go}/bin`).
"""
[go_set_gopath]
env = "MISE_GO_SET_GOPATH"
type = "Bool"
description = "[deprecated] Set to true to set GOPATH=~/.local/share/mise/installs/go/.../packages."
deprecated = "Use env._go.set_goroot instead."
[go_set_goroot]
env = "MISE_GO_SET_GOROOT"
type = "Bool"
default = true
description = "Sets GOROOT=~/.local/share/mise/installs/go/.../."
[go_skip_checksum]
env = "MISE_GO_SKIP_CHECKSUM"
type = "Bool"
description = "Set to true to skip checksum verification when downloading go sdk tarballs."
[http_timeout]
env = "MISE_HTTP_TIMEOUT"
type = "Duration"
default = "30s"
description = "Timeout in seconds for all HTTP requests in mise."
[idiomatic_version_file]
env = "MISE_IDIOMATIC_VERSION_FILE"
type = "Bool"
default = true
description = "Set to false to disable the idiomatic version files such as .node-version, .ruby-version, etc."
docs = """
Plugins can read the versions files used by other version managers (if enabled by the plugin)
for example, `.nvmrc` in the case of node's nvm. See [idiomatic version files](#idiomatic-version-files)
for more
information.
Set to "false" to disable idiomatic version file parsing.
"""
[idiomatic_version_file_disable_tools]
env = "MISE_IDIOMATIC_VERSION_FILE_DISABLE_TOOLS"
type = "ListString"
rust_type = "BTreeSet<String>"
default = []
parse_env = "list_by_comma"
description = "Specific tools to disable idiomatic version files for."
[ignored_config_paths]
env = "MISE_IGNORED_CONFIG_PATHS"
type = "ListPath"
rust_type = "BTreeSet<PathBuf>"
default = []
parse_env = "list_by_colon"
description = "This is a list of config paths that mise will ignore."
[jobs]
env = "MISE_JOBS"
type = "Integer"
rust_type = "usize"
default = 4
description = "How many jobs to run concurrently such as tool installs."
[legacy_version_file]
env = "MISE_LEGACY_VERSION_FILE"
type = "Bool"
default = true
deprecated = "Use idiomatic_version_file instead."
description = "Set to false to disable the idiomatic version files such as .node-version, .ruby-version, etc."
hide = true
[legacy_version_file_disable_tools]
env = "MISE_LEGACY_VERSION_FILE_DISABLE_TOOLS"
type = "ListString"
rust_type = "BTreeSet<String>"
default = []
parse_env = "list_by_comma"
deprecated = "Use idiomatic_version_file_disable_tools instead."
description = "Specific tools to disable idiomatic version files for."
hide = true
[libgit2]
env = "MISE_LIBGIT2"
type = "Bool"
default = true
description = "Use libgit2 for git operations, set to false to shell out to git."
docs = """
Use libgit2 for git operations. This is generally faster but may not be as compatible if the
system's libgit2 is not the same version as the one used by mise.
"""
[lockfile]
env = "MISE_LOCKFILE"
type = "Bool"
default = true
description = "Create and read lockfiles for tool versions."
docs = """
Read/update lockfiles for tool versions. This is useful when you'd like to have loose versions in mise.toml like this:
```toml
[tools]
node = "22"
gh = "latest"
```
But you'd like the versions installed to be consistent within a project. When this is enabled, mise will update mise.lock
files next to mise.toml files containing pinned versions. When installing tools, mise will reference this lockfile if it exists and this setting is enabled to resolve versions.
The lockfiles are not created automatically. To generate them, run the following (assuming the config file is `mise.toml`):
```sh
touch mise.lock && mise install
```
The lockfile is named the same as the config file but with `.lock` instead of `.toml` as the extension, e.g.:
- `mise.toml` -> `mise.lock`
- `mise.local.toml` -> `mise.local.lock`
- `.config/mise.toml` -> `.config/mise.lock`
"""
[log_level]
env = "MISE_LOG_LEVEL"
type = "String"
default = "info"
hide = true
description = "Show more/less output."
enum = [["trace"], ["debug"], ["info"], ["warn"], ["error"]]
[node.compile]
env = "MISE_NODE_COMPILE"
type = "Bool"
optional = true
description = "Compile node from source."
[node.flavor]
env = "MISE_NODE_FLAVOR"
type = "String"
optional = true
description = "Install a specific node flavor like glibc-217 or musl. Use with unofficial node build repo."
[node.gpg_verify]
env = "MISE_NODE_GPG_VERIFY"
type = "Bool"
optional = true
description = "Use gpg to verify node tool signatures."
[node.mirror_url]
env = "MISE_NODE_MIRROR_URL"
type = "Url"
optional = true
description = "Mirror to download node tarballs from."
[not_found_auto_install]
env = "MISE_NOT_FOUND_AUTO_INSTALL"
type = "Bool"
default = true
description = "Set to false to disable the \"command not found\" handler to autoinstall missing tool versions."
docs = """
Set to false to disable the "command not found" handler to autoinstall missing tool versions.
Disable this if experiencing strange behavior in your shell when a command is not found.
This also runs in shims if the terminal is interactive.
"""
[npm.bun]
type = "Bool"
description = "Use bun instead of npm if bun is installed and on PATH."
docs = """
If true, mise will use `bun` instead of `npm` if
[`bun`](https://bun.sh/) is installed and on PATH.
This makes installing CLIs faster by using `bun` as the package manager.
You can install it with mise:
```sh
mise use -g bun
```
"""
[override_config_filenames]
env = "MISE_OVERRIDE_CONFIG_FILENAMES"
type = "ListString"
default = []
description = "If set, mise will ignore default config files like `mise.toml` and use these filenames instead. This must be an env var."
parse_env = "list_by_colon"
[override_tool_versions_filename]
env = "MISE_OVERRIDE_TOOL_VERSIONS_FILENAME"
type = "ListString"
default = []
description = "If set, mise will ignore .tool-versions files and use these filename instead. Can be set to `none` to disable .tool-versions. This must be an env var."
parse_env = "list_by_colon"
[paranoid]
env = "MISE_PARANOID"
type = "Bool"
description = "Enables extra-secure behavior."
docs = """
Enables extra-secure behavior. See [Paranoid](/paranoid).
"""
[pin]
env = "MISE_PIN"
type = "Bool"
description = "Default to pinning versions when running `mise use` in mise.toml files."
docs = """
This sets `--pin` by default when running `mise use` in mise.toml files. This can be overridden by
passing `--fuzzy` on the command line.
"""
[pipx.uvx]
env = "MISE_PIPX_UVX"
type = "Bool"
description = "Use uvx instead of pipx if uv is installed and on PATH."
docs = """
If true, mise will use `uvx` instead of `pipx` if
[`uv`](https://docs.astral.sh/uv/) is installed and on PATH.
This makes installing CLIs _much_ faster by using `uv` as the package manager.
You can install it with mise:
```sh
mise use -g uv
```
"""
[pipx_uvx]
type = "Bool"
description = "Use uvx instead of pipx if uv is installed and on PATH."
hide = true
optional = true
[plugin_autoupdate_last_check_duration]
env = "MISE_PLUGIN_AUTOUPDATE_LAST_CHECK_DURATION"
type = "String"
default = "7d"
description = "How long to wait before updating plugins automatically (note this isn't currently implemented)."
[profile]
env = "MISE_PROFILE"
type = "String"
description = "Profile to use for mise.${MISE_PROFILE}.toml files."
optional = true
hide = true
[python.compile]
env = "MISE_PYTHON_COMPILE"
type = "Bool"
optional = true
description = "If true, compile python from source. If false, use precompiled binaries. If not set, use precompiled binaries if available."
docs = """
* Values:
* `true` - always compile with python-build instead of downloading [precompiled binaries](#precompiled-python-binaries).
* `false` - always download precompiled binaries.
* [undefined] - use precompiled binary if one is available for the current platform, compile otherwise.
"""
[python.default_packages_file]
env = "MISE_PYTHON_DEFAULT_PACKAGES_FILE"
type = "Path"
optional = true
description = "Path to a file containing default python packages to install when installing a python version."
[python.patch_url]
env = "MISE_PYTHON_PATCH_URL"
type = "Url"
optional = true
description = "URL to fetch python patches from to pass to python-build."
[python.patches_directory]
env = "MISE_PYTHON_PATCHES_DIRECTORY"
type = "Path"
optional = true
description = "Directory to fetch python patches from."
[python.precompiled_arch]
env = "MISE_PYTHON_PRECOMPILED_ARCH"
type = "String"
optional = true
description = "Specify the architecture to use for precompiled binaries."
default_docs = '"apple-darwin" | "unknown-linux-gnu" | "unknown-linux-musl"'
[python.precompiled_os]
env = "MISE_PYTHON_PRECOMPILED_OS"
type = "String"
optional = true
default_docs = '"x86_64_v3" | "aarch64"'
description = "Specify the OS to use for precompiled binaries."
docs = """
Specify the architecture to use for precompiled binaries. If on an old CPU, you may want to set this to "x86_64" for the most compatible binaries. See https://gregoryszorc.com/docs/python-build-standalone/main/running.html for more information.
"""
[python.pyenv_repo]
env = "MISE_PYENV_REPO"
type = "String"
default = "https://github.com/pyenv/pyenv.git"
description = "URL to fetch pyenv from for compiling python with python-build."
[python.uv_venv_auto]
env = "MISE_PYTHON_UV_VENV_AUTO"
type = "Bool"
description = "Integrate with uv to automatically create/source venvs if uv.lock is present."
[python.venv_auto_create]
env = "MISE_PYTHON_VENV_AUTO_CREATE"
type = "Bool"
hide = true
deprecated = "Use env._python.venv instead."
description = "Automatically create virtualenvs for python tools."
[python.venv_stdlib]
env = "MISE_VENV_STDLIB"
type = "Bool"
description = "Prefer to use venv from Python's standard library."
[python_compile]
type = "Bool"
optional = true
description = "If true, compile python from source. If false, use precompiled binaries. If not set, use precompiled binaries if available."
deprecated = "Use python.compile instead."
hide = true
[python_default_packages_file]
type = "Path"
optional = true
description = "Path to a file containing default python packages to install when installing python."
deprecated = "Use python.default_packages_file instead."
hide = true
[python_patch_url]
type = "String"
optional = true
description = "URL to fetch python patches from."
deprecated = "Use python.patch_url instead."
hide = true
[python_patches_directory]
type = "Path"
optional = true
description = "Directory to fetch python patches from."
deprecated = "Use python.patch_url instead."
hide = true
[python_precompiled_arch]
type = "String"
optional = true
description = "Specify the architecture to use for precompiled binaries."
deprecated = "Use python.precompiled_arch instead."
hide = true
[python_precompiled_os]
type = "String"
optional = true
description = "Specify the OS to use for precompiled binaries."
deprecated = "Use python.precompiled_os instead."
hide = true
[python_pyenv_repo]
type = "String"
optional = true
description = "URL to fetch pyenv from for compiling python."
deprecated = "Use python.pyenv_repo instead."
hide = true
[python_venv_auto_create]
type = "Bool"
optional = true
hide = true
deprecated = "Use env._python.venv instead."
description = "Automatically create virtualenvs for python tools."
[python_venv_stdlib]
type = "Bool"
optional = true
description = "Prefer to use venv from Python's standard library."
deprecated = "Use python.venv_stdlib instead."
hide = true
[quiet]
env = "MISE_QUIET"
type = "Bool"
description = "Suppress all output except errors."
[raw]
env = "MISE_RAW"
type = "Bool"
description = "Connect stdin/stdout/stderr to child processes."
[ruby.apply_patches]
env = "MISE_RUBY_APPLY_PATCHES"
type = "String"
optional = true
description = "A list of patch files or URLs to apply to ruby source."
[ruby.default_packages_file]
env = "MISE_RUBY_DEFAULT_PACKAGES_FILE"
type = "String"
default = "~/.default-gems"
description = "Path to a file containing default ruby gems to install when installing ruby."
[ruby.ruby_build_opts]
env = "MISE_RUBY_BUILD_OPTS"
type = "String"
optional = true
description = "Options to pass to ruby-build."
[ruby.ruby_build_repo]
env = "MISE_RUBY_BUILD_REPO"
type = "String"
default = "https://github.com/rbenv/ruby-build.git"
description = "URL to fetch ruby-build from."
[ruby.ruby_install]
env = "MISE_RUBY_INSTALL"
type = "Bool"
description = "Use ruby-install instead of ruby-build."
[ruby.ruby_install_opts]
env = "MISE_RUBY_INSTALL_OPTS"
type = "String"
optional = true
description = "Options to pass to ruby-install."
[ruby.ruby_install_repo]
env = "MISE_RUBY_INSTALL_REPO"
type = "String"
default = "https://github.com/postmodern/ruby-install.git"
description = "URL to fetch ruby-install from."
[ruby.verbose_install]
env = "MISE_RUBY_VERBOSE_INSTALL"
type = "Bool"
optional = true
description = "Set to true to enable verbose output during ruby installation."
[rust.cargo_home]
env = "MISE_CARGO_HOME"
type = "Path"
optional = true
description = "Path to the cargo home directory. Defaults to ~/.cargo or %USERPROFILE%\\.cargo"
[rust.rustup_home]
env = "MISE_RUSTUP_HOME"
type = "Path"
optional = true
description = "Path to the rustup home directory. Defaults to ~/.rustup or %USERPROFILE%\\.rustup"
[shorthands_file]
env = "MISE_SHORTHANDS_FILE"
type = "Path"
optional = true
description = "Path to a file containing custom tool shorthands."
docs = """
Use a custom file for the shorthand aliases. This is useful if you want to share plugins within
an organization.
Shorthands make it so when a user runs something like `mise install elixir` mise will
automatically install the [asdf-elixir](https://github.com/asdf-vm/asdf-elixir) plugin. By
default, it uses the shorthands in
[`registry.toml`](https://github.com/jdx/mise/blob/main/registry.toml).
The file should be in this toml format:
```toml
elixir = "https://github.com/my-org/mise-elixir.git"
node = "https://github.com/my-org/mise-node.git"
```
"""
[status.missing_tools]
env = "MISE_STATUS_MESSAGE_MISSING_TOOLS"
type = "String"
default = "if_other_versions_installed"
description = "Show a warning if tools are not installed when entering a directory with a mise.toml file."
docs = """
| Choice | Description |
|-----------------------------------------|----------------------------------------------------------------------------|
| `if_other_versions_installed` [default] | Show the warning only when the tool has at least 1 other version installed |
| `always` | Always show the warning |
| `never` | Never show the warning |
Show a warning if tools are not installed when entering a directory with a `mise.toml` file.
::: tip
Disable tools with [`disable_tools`](#disable_tools).
:::
"""
[status.show_env]
env = "MISE_STATUS_MESSAGE_SHOW_ENV"
type = "Bool"
description = "Show configured env vars when entering a directory with a mise.toml file."
[status.show_tools]
env = "MISE_STATUS_MESSAGE_SHOW_TOOLS"
type = "Bool"
description = "Show configured env vars when entering a directory with a mise.toml file."
[swift.gpg_verify]
env = "MISE_SWIFT_GPG_VERIFY"
type = "Bool"
optional = true
description = "Use gpg to verify swift tool signatures."
[system_config_file]
env = "MISE_SYSTEM_CONFIG_FILE"
type = "Path"
optional = true
description = "Path to the system mise config file. Default is `/etc/mise/config.toml`. This must be an env var."
[task_disable_paths]
env = "MISE_TASK_DISABLE_PATHS"
type = "ListPath"
rust_type = "BTreeSet<PathBuf>"
default = []
parse_env = "list_by_colon"
description = "Paths that mise will not look for tasks in."
[task_output]
env = "MISE_TASK_OUTPUT"
type = "String"
optional = true
description = "Change output style when executing tasks."
enum = [
[
"prefix",
"(default if jobs > 1) print by line with the prefix of the task name"
],
[
"interleave",
"(default if jobs == 1 or all tasks run sequentially) print output as it comes in"
]
]
docs = """
Change output style when executing tasks. This controls the output of `mise run`.
"""
[task_run_auto_install]
env = "MISE_TASK_RUN_AUTO_INSTALL"
type = "Bool"
default = true
description = "Automatically install missing tools when executing tasks."
[task_skip]
env = "MISE_TASK_SKIP"
type = "ListString"
rust_type = "BTreeSet<String>"
default = []
parse_env = "list_by_comma"
description = "Tasks to skip when running `mise run`."
[task_timings]
env = "MISE_TASK_TIMINGS"
type = "Bool"
optional = true
description = "Show completion message with elapsed time for each task on `mise run`. Default shows when output type is `prefix`."
[trace]
env = "MISE_TRACE"
type = "Bool"
hide = true
description = "Sets log level to trace"
[trusted_config_paths]
env = "MISE_TRUSTED_CONFIG_PATHS"
type = "ListPath"
rust_type = "BTreeSet<PathBuf>"
default = []
parse_env = "list_by_colon"
description = "This is a list of config paths that mise will automatically mark as trusted."
[unix_default_file_shell_args]
env = "MISE_UNIX_DEFAULT_FILE_SHELL_ARGS"
type = "String"
default = "sh"
description = "List of default shell arguments for unix to be used with `file`. For example `sh`."
[unix_default_inline_shell_args]
env = "MISE_UNIX_DEFAULT_INLINE_SHELL_ARGS"
type = "String"
default = "sh -c -o errexit"
description = "List of default shell arguments for unix to be used with inline commands. For example, `sh`, `-c` for sh."
[use_file_shell_for_executable_tasks]
env = "MISE_USE_FILE_SHELL_FOR_EXECUTABLE_TASKS"
type = "Bool"
default = false
description = "Determines whether to use a specified shell for executing tasks in the tasks directory. When set to true, the shell defined in the file will be used, or the default shell specified by `windows_default_file_shell_args` or `unix_default_file_shell_args` will be applied. If set to false, tasks will be executed directly as programs."
[use_versions_host]
env = "MISE_USE_VERSIONS_HOST"
type = "Bool"
default = true
description = "Set to false to disable using the mise-versions API as a quick way for mise to query for new versions."
docs = """
Set to "false" to disable using [mise-versions](https://mise-versions.jdx.dev) as
a quick way for mise to query for new versions. This host regularly grabs all the
latest versions of core and community plugins. It's faster than running a plugin's
`list-all` command and gets around GitHub rate limiting problems when using it.
See [FAQ](/faq#new-version-of-a-tool-is-not-available) for more information.
"""
[verbose]
env = "MISE_VERBOSE"
type = "Bool"
description = "Shows more verbose output such as installation logs when installing tools."
[vfox]
env = "MISE_VFOX"
type = "Bool"
hide = true
optional = true
deprecated = "Use disable_backends instead."
description = "Use vfox as a default plugin backend instead of asdf."
docs = """
Use vfox as a default plugin backend. This means running something like `mise use cmake` will
default to using a vfox plugin for cmake.
"""
[windows_default_file_shell_args]
env = "MISE_WINDOWS_DEFAULT_FILE_SHELL_ARGS"
type = "ListString"
rust_type = "String"
default = "cmd /c"
description = "List of default shell arguments for Windows to be used for file commands. For example, `cmd`, `/c` for cmd.exe."
[windows_default_inline_shell_args]
env = "MISE_WINDOWS_DEFAULT_INLINE_SHELL_ARGS"
type = "String"
default = "cmd /c"
description = "List of default shell arguments for Windows to be used for inline commands. For example, `cmd`, `/c` for cmd.exe."
[windows_executable_extensions]
env = "MISE_WINDOWS_EXECUTABLE_EXTENSIONS"
type = "ListString"
rust_type = "Vec<String>"
default = ["exe", "bat", "cmd", "com", "ps1", "vbs"]
parse_env = "list_by_comma"
description = "List of executable extensions for Windows. For example, `exe` for .exe files, `bat` for .bat files, and so on."
[yes]
env = "MISE_YES"
type = "Bool"
description = "This will automatically answer yes or no to prompts. This is useful for scripting."