-
-
Notifications
You must be signed in to change notification settings - Fork 917
Expand file tree
/
Copy pathsettings.toml
More file actions
2144 lines (1813 loc) · 69.9 KB
/
settings.toml
File metadata and controls
2144 lines (1813 loc) · 69.9 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
# 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]
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.
"""
env = "MISE_ACTIVATE_AGGRESSIVE"
type = "Bool"
[age.identity_files]
description = "[experimental] List of age identity files to use for decryption."
env = "MISE_AGE_IDENTITY_FILES"
optional = true
rust_type = "Vec<PathBuf>"
type = "ListPath"
[age.key_file]
default_docs = "~/.config/mise/age.txt"
description = "[experimental] Path to the age private key file to use for encryption/decryption."
env = "MISE_AGE_KEY_FILE"
optional = true
type = "Path"
[age.ssh_identity_files]
description = "[experimental] List of SSH identity files to use for age decryption."
env = "MISE_AGE_SSH_IDENTITY_FILES"
optional = true
rust_type = "Vec<PathBuf>"
type = "ListPath"
[age.strict]
default = true
description = "If true, fail when age decryption fails (including when age is not available, the key is missing, or the key is invalid). If false, skip decryption and continue in these cases."
env = "MISE_AGE_STRICT"
type = "Bool"
[all_compile]
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.
"""
env = "MISE_ALL_COMPILE"
type = "Bool"
[always_keep_download]
description = "should mise keep downloaded files after installation"
env = "MISE_ALWAYS_KEEP_DOWNLOAD"
type = "Bool"
[always_keep_install]
description = "should mise keep install files after installation even if the installation fails"
env = "MISE_ALWAYS_KEEP_INSTALL"
type = "Bool"
[aqua.baked_registry]
default = true
description = "Use baked-in aqua registry."
env = "MISE_AQUA_BAKED_REGISTRY"
type = "Bool"
[aqua.cosign]
default = true
description = "Use cosign to verify aqua tool signatures."
env = "MISE_AQUA_COSIGN"
type = "Bool"
[aqua.cosign_extra_args]
description = "Extra arguments to pass to cosign when verifying aqua tool signatures."
env = "MISE_AQUA_COSIGN_EXTRA_ARGS"
optional = true
rust_type = "Vec<String>"
type = "ListString"
[aqua.github_attestations]
default = true
description = "Enable GitHub Artifact Attestations verification for aqua tools."
docs = """
Enable/disable GitHub Artifact Attestations verification for aqua tools.
When enabled, mise will verify the authenticity and integrity of downloaded tools
using GitHub's artifact attestation system.
"""
env = "MISE_AQUA_GITHUB_ATTESTATIONS"
type = "Bool"
[aqua.minisign]
default = true
description = "Use minisign to verify aqua tool signatures."
env = "MISE_AQUA_MINISIGN"
type = "Bool"
[aqua.registry_url]
description = "URL to fetch aqua registry from."
docs = """
URL to fetch aqua registry from. This is used to install tools from the aqua registry.
If this is set, the baked-in aqua registry is not used.
By default, the official aqua registry is used: https://github.com/aquaproj/aqua-registry
"""
env = "MISE_AQUA_REGISTRY_URL"
optional = true
type = "Url"
[aqua.slsa]
default = true
description = "Use SLSA to verify aqua tool signatures."
env = "MISE_AQUA_SLSA"
type = "Bool"
[arch]
default_docs = '"x86_64" | "aarch64" | "arm" | "loongarch64" | "riscv64"'
description = "Architecture to use for precompiled binaries."
docs = """
Architecture to use for precompiled binaries. This is used to determine which precompiled binaries
to download. If unset, mise will use the system's architecture.
"""
env = "MISE_ARCH"
optional = true
type = "String"
[asdf]
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.
"""
env = "MISE_ASDF"
hide = true
optional = true
type = "Bool"
[asdf_compat]
deprecated = "no longer supported"
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`.
"""
env = "MISE_ASDF_COMPAT"
hide = true
type = "Bool"
[auto_install]
default = true
description = "Automatically install missing tools when running `mise x`, `mise run`, or as part of the 'not found' handler."
env = "MISE_AUTO_INSTALL"
type = "Bool"
[auto_install_disable_tools]
description = "List of tools to skip automatically installing when running `mise x`, `mise run`, or as part of the 'not found' handler."
env = "MISE_AUTO_INSTALL_DISABLE_TOOLS"
optional = true
parse_env = "list_by_comma"
rust_type = "Vec<String>"
type = "ListString"
[cache_prune_age]
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.
"""
env = "MISE_CACHE_PRUNE_AGE"
type = "Duration"
[cargo.binstall]
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
```
"""
env = "MISE_CARGO_BINSTALL"
type = "Bool"
[cargo.binstall_only]
default = false
description = "Only use cargo-binstall for installation, fail if not available."
env = "MISE_CARGO_BINSTALL_ONLY"
type = "Bool"
[cargo.registry_name]
description = "Name of the cargo registry to use."
docs = """
Packages are installed from the official cargo registry.
You can set this to a different registry name if you have a custom feed or want to use a different source.
Please follow the [cargo alternative registries documentation](https://doc.rust-lang.org/cargo/reference/registries.html#using-an-alternate-registry) to configure your registry.
"""
env = "MISE_CARGO_REGISTRY_NAME"
optional = true
type = "String"
[cargo_binstall]
deprecated = "Use cargo.binstall instead."
description = "Use cargo-binstall instead of cargo install if available"
hide = true
optional = true
type = "Bool"
[cd]
description = "Path to change to after launching mise"
env = "MISE_CD"
hide = true
optional = true
type = "Path"
[ceiling_paths]
default = []
description = "Directories where mise stops searching for config files."
docs = """
Directories where mise stops searching for config files. By default, mise
will search from the current directory up to the root of the filesystem.
Setting this to a list of directories will stop the search when one of
those directories is reached. Config files **in** the ceiling directory
itself are excluded—only directories below it are searched. For example,
if `MISE_CEILING_PATHS="/home/user"`, then `/home/user/mise.toml` is
**not** loaded, but `/home/user/projects/myapp/mise.toml` is.
This follows the same semantics as Git's `GIT_CEILING_DIRECTORIES`.
This is an early-init setting: it must be set in `.miserc.toml`, environment
variables, or CLI flags. Setting it in `mise.toml` will have no effect because
config file discovery has already occurred by the time `mise.toml` is read.
"""
env = "MISE_CEILING_PATHS"
parse_env = "list_by_colon"
rc = true
rust_type = "BTreeSet<PathBuf>"
type = "ListPath"
[ci]
default = "false"
description = "Set to true if running in a CI environment"
deserialize_with = "bool_string"
env = "CI"
hide = true
type = "Bool"
[color]
default = true
description = "Use color in mise terminal output"
env = "MISE_COLOR"
type = "Bool"
[color_theme]
default = "default"
description = "Theme for interactive prompts (default/charm, base16, catppuccin, dracula)"
docs = """
Sets the color theme for interactive prompts like `mise run` task selection.
Available themes:
- `default` or `charm` - Default theme, works well on dark terminals
- `base16` - Base16 theme, works well on light terminals
- `catppuccin` - Catppuccin theme
- `dracula` - Dracula theme
If you're using a light terminal and the default theme is hard to read,
try setting this to `base16`.
"""
enum = ["default", "charm", "base16", "catppuccin", "dracula"]
env = "MISE_COLOR_THEME"
type = "String"
[conda.channel]
default = "conda-forge"
description = "Default channel for conda packages."
docs = """
Default conda channel when installing packages with the conda backend.
Override per-package with `conda:package[channel=bioconda]`.
The most common channels are:
- `conda-forge` - Community-maintained packages (default)
- `bioconda` - Bioinformatics packages
- `nvidia` - NVIDIA CUDA packages
"""
env = "MISE_CONDA_CHANNEL"
type = "String"
[debug]
description = "Sets log level to debug"
env = "MISE_DEBUG"
hide = true
type = "Bool"
[default_config_filename]
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."
env = "MISE_DEFAULT_CONFIG_FILENAME"
type = "String"
[default_tool_versions_filename]
default = ".tool-versions"
description = "The default .tool-versions filename read. This will not ignore .tool-versions—use override_tool_versions_filename for that. This must be an env var."
env = "MISE_DEFAULT_TOOL_VERSIONS_FILENAME"
type = "String"
[disable_backends]
default = []
description = "Backends to disable such as `asdf` or `pipx`"
env = "MISE_DISABLE_BACKENDS"
parse_env = "list_by_comma"
rust_type = "Vec<String>"
type = "ListString"
[disable_default_registry]
description = "Disable the default mapping of short tool names like `php` -> `asdf:mise-plugins/asdf-php`. This parameter disables only for the backends `vfox` and `asdf`."
env = "MISE_DISABLE_DEFAULT_REGISTRY"
type = "Bool"
[disable_default_shorthands]
deprecated = "Replaced with `disable_default_registry`"
description = "Disables built-in shorthands to asdf/vfox plugins"
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`
"""
env = "MISE_DISABLE_DEFAULT_SHORTHANDS"
hide = true
optional = true
type = "Bool"
[disable_hints]
default = []
description = "Turns off helpful hints when using different mise features"
env = "MISE_DISABLE_HINTS"
parse_env = "set_by_comma"
rust_type = "BTreeSet<String>"
type = "SetString"
[disable_tools]
default = []
description = "Tools defined in mise.toml that should be ignored"
env = "MISE_DISABLE_TOOLS"
parse_env = "set_by_comma"
rust_type = "BTreeSet<String>"
type = "SetString"
[dotnet.cli_telemetry_optout]
description = "Set DOTNET_CLI_TELEMETRY_OPTOUT to opt out of .NET CLI telemetry."
docs = """
When set to true, the `DOTNET_CLI_TELEMETRY_OPTOUT` environment variable is set to `1`,
disabling .NET CLI telemetry. When set to false, it is set to `0`.
When unset (default), mise does not set the variable and .NET uses its own default behavior.
"""
env = "MISE_DOTNET_CLI_TELEMETRY_OPTOUT"
optional = true
type = "Bool"
[dotnet.dotnet_root]
description = "Path to the shared .NET SDK root directory."
docs = """
All .NET SDK versions are installed side-by-side under this directory, matching .NET's native multi-version model.
By default, mise uses `~/.local/share/mise/dotnet-root`. Set this to override the location.
"""
env = "MISE_DOTNET_ROOT"
optional = true
type = "Path"
[dotnet.isolated]
default = false
description = "Install each .NET SDK version in its own isolated directory."
docs = """
When true, each SDK version is installed in its own directory under mise's installs path,
like most other tools. `dotnet --list-sdks` will only show the active version.
When false (default), all SDK versions share a single `DOTNET_ROOT` directory and
`dotnet --list-sdks` shows all installed versions, matching .NET's native side-by-side model.
"""
env = "MISE_DOTNET_ISOLATED"
type = "Bool"
[dotnet.package_flags]
default = []
description = "Extends dotnet search and install abilities."
docs = """
This is a list of flags to extend the search and install abilities of dotnet tools.
Here are the available flags:
- 'prerelease' : include prerelease versions in search and install
"""
env = "MISE_DOTNET_PACKAGE_FLAGS"
parse_env = "list_by_comma"
rust_type = "Vec<String>"
type = "ListString"
[dotnet.registry_url]
default = "https://api.nuget.org/v3/index.json"
description = "URL to fetch dotnet tools from."
docs = """
URL to fetch dotnet tools from. This is used when installing dotnet tools.
By default, mise will use the [nuget](https://api.nuget.org/v3/index.json) API to fetch.
However, you can set this to a different URL if you have a custom feed or want to use a different source.
"""
env = "MISE_DOTNET_REGISTRY_URL"
type = "Url"
[enable_tools]
default = []
description = "Tools defined in mise.toml that should be used - all other tools are ignored"
env = "MISE_ENABLE_TOOLS"
parse_env = "set_by_comma"
rust_type = "BTreeSet<String>"
type = "SetString"
[env]
default = []
description = "Env to use for mise.<MISE_ENV>.toml files."
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.html) for more on how
to use this feature.
Multiple envs can be set by separating them with a comma, e.g. `MISE_ENV=ci,test`.
They will be read in order, with the last one taking precedence.
This is an early-init setting: it must be set in `.miserc.toml`, environment
variables, or CLI flags (`-E`/`--env`). Setting it in `mise.toml` will have no
effect because `MISE_ENV` determines which config files to load.
"""
env = "MISE_ENV"
parse_env = "list_by_comma"
rc = true
type = "ListString"
[env_cache]
default = false
description = "[experimental] Enable environment caching for nested mise invocations"
docs = """
When enabled, mise will cache the computed environment (env vars and PATH) to disk.
This dramatically speeds up nested mise invocations (e.g., `mise x -- mise env`).
The cache is encrypted using a session-scoped key (`__MISE_ENV_CACHE_KEY`) that is
generated when you run `mise activate` or `mise exec`. This means:
- Cache files are encrypted and unreadable by other processes
- When your shell session ends, the key is lost
- Old cache files become unreadable and will be regenerated
Cache invalidation happens when:
- Any config file changes (mise.toml, .tool-versions, etc.)
- Tool versions change
- Settings change
- mise version changes
- TTL expires (configurable via `env_cache_ttl`)
- Any watched files change (from modules or _.source directives)
Modules (vfox plugins) can declare themselves cacheable by returning
`{cacheable = true, watch_files = [...], env = [...]}` from their mise_env hook.
Modules that don't declare cacheability are treated as dynamic and will be
re-executed on each cache hit.
Directives can opt out of caching by setting `cacheable = false`:
```toml
[env]
TIMESTAMP = { value = "{{ now() }}", cacheable = false }
_.source = { file = "dynamic.sh", cacheable = false }
```
"""
env = "MISE_ENV_CACHE"
type = "Bool"
[env_cache_ttl]
default = "1h"
description = "TTL for cached environments"
docs = """
How long cached environments remain valid before being regenerated.
Accepts duration strings like "1h", "30m", "1d".
Even with a valid TTL, caches are still invalidated when config files,
tool versions, settings, or watched files change.
"""
env = "MISE_ENV_CACHE_TTL"
type = "Duration"
[env_file]
description = "Path to a file containing environment variables to automatically load."
env = "MISE_ENV_FILE"
optional = true
type = "Path"
[env_shell_expand]
description = "Enable shell-style variable expansion in env values (e.g., $FOO, ${BAR:-default})"
docs = """
Controls shell-style variable expansion in `mise.toml` `[env]` values:
```toml
[env]
FOO = "hello"
BAR = "$FOO-world" # "hello-world"
BAZ = "${FOO}_suffix" # "hello_suffix"
QUX = "${UNDEF:-fallback}" # "fallback"
```
- `true` — enable shell expansion
- `false` — disable shell expansion (no warning)
- unset — disable shell expansion but warn if `$` is detected in env values
(shell expansion will become the default in a future release)
Expansion happens after Tera template rendering, so both syntaxes can be mixed.
Undefined variables are left unexpanded (e.g., `$MISSING` stays as `$MISSING`).
"""
env = "MISE_ENV_SHELL_EXPAND"
optional = true
type = "Bool"
[erlang.compile]
description = "If true, compile erlang from source. If false, use precompiled binaries. If not set, use precompiled binaries if available."
env = "MISE_ERLANG_COMPILE"
optional = true
type = "Bool"
[exec_auto_install]
default = true
description = "Automatically install missing tools when running `mise x`."
env = "MISE_EXEC_AUTO_INSTALL"
type = "Bool"
[experimental]
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.
"""
env = "MISE_EXPERIMENTAL"
type = "Bool"
[fetch_remote_versions_cache]
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
"""
env = "MISE_FETCH_REMOTE_VERSIONS_CACHE"
type = "Duration"
[fetch_remote_versions_timeout]
aliases = ["fetch_remote_version_timeout"]
default = "20s"
description = "Timeout in seconds for HTTP requests to fetch new tool versions in mise."
env = "MISE_FETCH_REMOTE_VERSIONS_TIMEOUT"
type = "Duration"
[github.github_attestations]
default = true
description = "Enable GitHub Artifact Attestations verification for github backend tools."
docs = """
Enable/disable GitHub Artifact Attestations verification for github backend tools.
When enabled, mise will verify the authenticity and integrity of downloaded tools
using GitHub's artifact attestation system.
"""
env = "MISE_GITHUB_GITHUB_ATTESTATIONS"
type = "Bool"
[github.slsa]
default = true
description = "Enable SLSA provenance verification for github backend tools."
docs = """
Enable/disable SLSA provenance verification for github backend tools.
When enabled, mise will verify the supply-chain integrity of downloaded tools
using SLSA provenance attestations.
"""
env = "MISE_GITHUB_SLSA"
type = "Bool"
[github_attestations]
default = true
description = "Enable GitHub Artifact Attestations verification for supported tools."
docs = """
Enable/disable GitHub Artifact Attestations verification globally.
When enabled, mise will verify the authenticity and integrity of downloaded tools
using GitHub's artifact attestation system for tools that support it (e.g., Ruby precompiled binaries).
"""
env = "MISE_GITHUB_ATTESTATIONS"
type = "Bool"
[gix]
default = true
description = "Use gix for git operations, set to false to shell out to git."
docs = """
Use gix for git operations. This is generally faster but may not be as compatible if the
system's gix is not the same version as the one used by mise.
"""
env = "MISE_GIX"
hide = true
type = "Bool"
[global_config_file]
description = "Path to the global mise config file. Default is `~/.config/mise/config.toml`. This must be an env var."
env = "MISE_GLOBAL_CONFIG_FILE"
optional = true
type = "Path"
[global_config_root]
description = "Path which is used as `{{config_root}}` for the global config file. Default is `$HOME`. This must be an env var."
env = "MISE_GLOBAL_CONFIG_ROOT"
optional = true
type = "Path"
[go_default_packages_file]
default = "~/.default-go-packages"
description = "Path to a file containing default go packages to install when installing go"
env = "MISE_GO_DEFAULT_PACKAGES_FILE"
type = "Path"
[go_download_mirror]
default = "https://dl.google.com/go"
description = "Mirror to download go sdk tarballs from."
env = "MISE_GO_DOWNLOAD_MIRROR"
type = "String"
[go_repo]
default = "https://github.com/golang/go"
description = "URL to fetch go from."
env = "MISE_GO_REPO"
type = "Url"
[go_set_gobin]
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`).
"""
env = "MISE_GO_SET_GOBIN"
optional = true
type = "Bool"
[go_set_gopath]
deprecated = "Use env._go.set_goroot instead."
description = "[deprecated] Set to true to set GOPATH=~/.local/share/mise/installs/go/.../packages."
env = "MISE_GO_SET_GOPATH"
type = "Bool"
[go_set_goroot]
default = true
description = "Sets GOROOT=~/.local/share/mise/installs/go/.../."
env = "MISE_GO_SET_GOROOT"
type = "Bool"
[go_skip_checksum]
description = "Set to true to skip checksum verification when downloading go sdk tarballs."
env = "MISE_GO_SKIP_CHECKSUM"
type = "Bool"
[gpg_verify]
description = "Use gpg to verify all tool signatures."
env = "MISE_GPG_VERIFY"
optional = true
type = "Bool"
[hook_env.cache_ttl]
default = "0s"
description = "Cache hook-env directory checks for this duration. Useful for slow filesystems like NFS."
docs = """
On slow filesystems (like NFS with cold cache), mise's hook-env can be slow due to
multiple filesystem stat operations. Setting this to a positive value (e.g., "5s")
will cache the results of directory traversal and only re-check after the TTL expires.
When set to "0s" (default), no caching is performed and every hook-env call will
check the filesystem for changes. This is the safest option but slowest on NFS.
Note: When caching is enabled, newly created config files may not be detected until
the TTL expires. Use `mise hook-env --force` to bypass the cache.
"""
env = "MISE_HOOK_ENV_CACHE_TTL"
type = "Duration"
[hook_env.chpwd_only]
default = false
description = "Only run hook-env checks on directory change, not on every prompt."
docs = """
When enabled, mise will only perform full config file checks when the directory changes
(chpwd), not on every shell prompt (precmd). This significantly reduces filesystem
operations on slow filesystems like NFS.
With this enabled, changes to config files will not be detected until you change
directories. Use `mise hook-env --force` to manually trigger a full update.
This setting is useful when:
- You're working on an NFS filesystem with slow stat operations
- Config files rarely change during a session
- You want the fastest possible shell prompt response time
"""
env = "MISE_HOOK_ENV_CHPWD_ONLY"
type = "Bool"
[http_retries]
default = 0
description = "Number of retries for HTTP requests in mise."
docs = """
Uses an exponential backoff strategy. The duration is calculated by taking the base (10ms) to the n-th power.
"""
env = "MISE_HTTP_RETRIES"
type = "Integer"
[http_timeout]
default = "30s"
description = "Timeout in seconds for all HTTP requests in mise."
env = "MISE_HTTP_TIMEOUT"
type = "Duration"
[idiomatic_version_file]
deprecated = "This has been replaced with the idiomatic_version_file_enable_tools setting."
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](/configuration.html#idiomatic-version-files)
for more
information.
Set to "false" to disable idiomatic version file parsing.
"""
env = "MISE_IDIOMATIC_VERSION_FILE"
hide = true
optional = true
type = "Bool"
[idiomatic_version_file_disable_tools]
default = []
deprecated = "This has been replaced with the idiomatic_version_file_enable_tools setting."
description = "Specific tools to disable idiomatic version files for."
env = "MISE_IDIOMATIC_VERSION_FILE_DISABLE_TOOLS"
hide = true
parse_env = "set_by_comma"
rust_type = "BTreeSet<String>"
type = "SetString"
[idiomatic_version_file_enable_tools]
default = []
description = "Specific tools to enable idiomatic version files for like .node-version, .ruby-version, etc."
docs = """
By default, idiomatic version files are disabled. You can enable them for specific tools with this setting.
For example, to enable idiomatic version files for node and python:
mise settings add idiomatic_version_file_enable_tools node
mise settings add idiomatic_version_file_enable_tools python
See [Idiomatic Version Files](/configuration.html#idiomatic-version-files) for more information.
"""
env = "MISE_IDIOMATIC_VERSION_FILE_ENABLE_TOOLS"
parse_env = "set_by_comma"
rust_type = "BTreeSet<String>"
type = "SetString"
[ignored_config_paths]
default = []
description = "This is a list of config paths that mise will ignore."
docs = """
This is a list of config paths that mise will ignore.
This is an early-init setting: it must be set in `.miserc.toml`, environment
variables, or CLI flags. Setting it in `mise.toml` will have no effect because
config file discovery has already occurred by the time `mise.toml` is read.
"""
env = "MISE_IGNORED_CONFIG_PATHS"
parse_env = "list_by_colon"
rc = true
rust_type = "BTreeSet<PathBuf>"
type = "ListPath"
[install_before]
description = "Only install versions released before this date"
docs = """
Filter tool versions by release date. Supports:
- Absolute dates: `2024-06-01`, `2024-06-01T12:00:00Z`
- Relative durations: `90d` (90 days ago), `1y` (1 year ago), `6m` (6 months ago)
This is useful for reproducible builds or security purposes where you want to ensure
you're only installing versions that existed before a certain point in time.
Only affects backends that provide release timestamps (aqua, cargo, npm, pipx, and some core plugins).
Versions without timestamps are included by default.
**Behavior**: This filter only applies when resolving fuzzy version requests like `node@20` or `latest`.
Explicitly pinned versions like `node@22.5.0` are not filtered, allowing you to selectively
use newer versions for specific tools while keeping others behind the cutoff date.
Can be overridden with the `--before` CLI flag.
"""
env = "MISE_INSTALL_BEFORE"
optional = true
type = "String"
[java.shorthand_vendor]
default = "openjdk"
description = "Shorthand for Java. Used when installing Java without a vendor prefix."
env = "MISE_JAVA_SHORTHAND_VENDOR"
type = "String"
[jobs]
default = 8
description = "How many jobs to run concurrently such as tool installs."
env = "MISE_JOBS"
rust_type = "usize"
type = "Integer"
[legacy_version_file]
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."
env = "MISE_LEGACY_VERSION_FILE"
hide = true
type = "Bool"
[legacy_version_file_disable_tools]
default = []
deprecated = "Use idiomatic_version_file_disable_tools instead."
description = "Specific tools to disable idiomatic version files for."
env = "MISE_LEGACY_VERSION_FILE_DISABLE_TOOLS"
hide = true
parse_env = "set_by_comma"
rust_type = "BTreeSet<String>"
type = "SetString"
[libgit2]
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.
"""
env = "MISE_LIBGIT2"
hide = true
type = "Bool"
[locked]
default = false
description = "Require lockfile URLs to be present during installation."
docs = """
> [!NOTE]
> This setting requires [lockfile](#lockfile) to be enabled.
When enabled, `mise install` will fail if tools don't have pre-resolved URLs in the lockfile
for the current platform. This prevents API calls to GitHub, aqua registry, etc. and ensures
reproducible installations.
This is useful in CI/CD environments where you want to:
- Avoid GitHub API rate limits
- Ensure deterministic builds using pre-resolved URLs
- Fail fast if the lockfile is incomplete
To generate lockfile URLs, run:
```sh
mise lock
```
Equivalent to passing `--locked` to `mise install`.
"""
env = "MISE_LOCKED"
type = "Bool"
[lockfile]
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`
When set to `true`, lockfiles are read and written. When set to `false`, lockfiles are explicitly disabled—this
will cause an error if `locked = true` is also set, since locked mode requires reading lockfiles.
When unset (the default), lockfiles are enabled (same as `true`) but there is no conflict with `locked` mode.
"""
env = "MISE_LOCKFILE"
optional = true
type = "Bool"
[log_level]
default = "info"
description = "Show more/less output."
enum = ["trace", "debug", "info", "warn", "error"]
env = "MISE_LOG_LEVEL"
hide = true
type = "String"
[netrc]
default = true
description = "Use a netrc file for HTTP Basic authentication."
docs = """
When enabled, mise will read credentials from the netrc file and apply
HTTP Basic authentication for matching hosts. This is useful for accessing
private artifact repositories like Artifactory or Nexus.
On Unix/macOS, the default path is `~/.netrc`.
On Windows, mise looks for `%USERPROFILE%\\_netrc` first, then falls back to `%USERPROFILE%\\.netrc`.
The netrc file format is:
```
machine artifactory.example.com
login myuser
password mytoken
```
You can also specify a custom netrc file path using the `netrc_file` setting.
"""
env = "MISE_NETRC"
type = "Bool"
[netrc_file]
description = "Path to the netrc file to use for HTTP Basic authentication."
docs = """
Override the default netrc file path. This is useful if you want to use a
different netrc file for mise or if your netrc file is in a non-standard location.
"""
env = "MISE_NETRC_FILE"
optional = true