mise-projen 0.0.9 → 0.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/API.md CHANGED
@@ -1958,6 +1958,7 @@ const miseTomlSchemaBootstrapDirectories: MiseTomlSchemaBootstrapDirectories = {
1958
1958
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.group">group</a></code> | <code>string</code> | *No description.* |
1959
1959
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.mode">mode</a></code> | <code>string</code> | *No description.* |
1960
1960
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.notify">notify</a></code> | <code>string[]</code> | *No description.* |
1961
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.os">os</a></code> | <code>string[]</code> | OS or OS/arch selectors; |
1961
1962
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.owner">owner</a></code> | <code>string</code> | *No description.* |
1962
1963
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.phase">phase</a></code> | <code><a href="#mise-projen.BootstrapFilePhase">BootstrapFilePhase</a></code> | *No description.* |
1963
1964
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.recursive">recursive</a></code> | <code>boolean</code> | *No description.* |
@@ -1996,6 +1997,20 @@ public readonly notify: string[];
1996
1997
 
1997
1998
  ---
1998
1999
 
2000
+ ##### `os`<sup>Optional</sup> <a name="os" id="mise-projen.MiseTomlSchemaBootstrapDirectories.property.os"></a>
2001
+
2002
+ ```typescript
2003
+ public readonly os: string[];
2004
+ ```
2005
+
2006
+ - *Type:* string[]
2007
+
2008
+ OS or OS/arch selectors;
2009
+
2010
+ entries on other platforms are skipped
2011
+
2012
+ ---
2013
+
1999
2014
  ##### `owner`<sup>Optional</sup> <a name="owner" id="mise-projen.MiseTomlSchemaBootstrapDirectories.property.owner"></a>
2000
2015
 
2001
2016
  ```typescript
@@ -2064,6 +2079,7 @@ const miseTomlSchemaBootstrapFiles: MiseTomlSchemaBootstrapFiles = { ... }
2064
2079
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.group">group</a></code> | <code>string</code> | *No description.* |
2065
2080
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.mode">mode</a></code> | <code>string</code> | *No description.* |
2066
2081
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.notify">notify</a></code> | <code>string[]</code> | *No description.* |
2082
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.os">os</a></code> | <code>string[]</code> | OS or OS/arch selectors; |
2067
2083
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.owner">owner</a></code> | <code>string</code> | *No description.* |
2068
2084
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.phase">phase</a></code> | <code><a href="#mise-projen.BootstrapFilePhase">BootstrapFilePhase</a></code> | *No description.* |
2069
2085
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.removeEmpty">removeEmpty</a></code> | <code>boolean</code> | remove the target when the template renders to empty or whitespace-only content; |
@@ -2114,6 +2130,20 @@ public readonly notify: string[];
2114
2130
 
2115
2131
  ---
2116
2132
 
2133
+ ##### `os`<sup>Optional</sup> <a name="os" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.os"></a>
2134
+
2135
+ ```typescript
2136
+ public readonly os: string[];
2137
+ ```
2138
+
2139
+ - *Type:* string[]
2140
+
2141
+ OS or OS/arch selectors;
2142
+
2143
+ entries on other platforms are skipped
2144
+
2145
+ ---
2146
+
2117
2147
  ##### `owner`<sup>Optional</sup> <a name="owner" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.owner"></a>
2118
2148
 
2119
2149
  ```typescript
@@ -2711,6 +2741,7 @@ const miseTomlSchemaBootstrapLinuxSystemdUnits: MiseTomlSchemaBootstrapLinuxSyst
2711
2741
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.standardError">standardError</a></code> | <code>string</code> | write StandardError in the [Service] section. |
2712
2742
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.standardOutput">standardOutput</a></code> | <code>string</code> | write StandardOutput in the [Service] section. |
2713
2743
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.start">start</a></code> | <code>boolean</code> | restart the unit after writing it; |
2744
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState">MiseTomlSchemaBootstrapLinuxSystemdUnitsState</a></code> | present writes and manages the unit; |
2714
2745
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.timeoutStartSec">timeoutStartSec</a></code> | <code>string</code> | write TimeoutStartSec in the [Service] section. |
2715
2746
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.timeoutStopSec">timeoutStopSec</a></code> | <code>string</code> | write TimeoutStopSec in the [Service] section. |
2716
2747
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.type">type</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsType">MiseTomlSchemaBootstrapLinuxSystemdUnitsType</a></code> | write Type in the [Service] section. |
@@ -3084,6 +3115,20 @@ when false, stop the unit after writing it
3084
3115
 
3085
3116
  ---
3086
3117
 
3118
+ ##### `state`<sup>Optional</sup> <a name="state" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.state"></a>
3119
+
3120
+ ```typescript
3121
+ public readonly state: MiseTomlSchemaBootstrapLinuxSystemdUnitsState;
3122
+ ```
3123
+
3124
+ - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState">MiseTomlSchemaBootstrapLinuxSystemdUnitsState</a>
3125
+
3126
+ present writes and manages the unit;
3127
+
3128
+ absent stops, disables, and removes both dev.mise.<name>.service and dev.mise.<name>.timer
3129
+
3130
+ ---
3131
+
3087
3132
  ##### `timeoutStartSec`<sup>Optional</sup> <a name="timeoutStartSec" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.timeoutStartSec"></a>
3088
3133
 
3089
3134
  ```typescript
@@ -5158,6 +5203,7 @@ const miseTomlSchemaHistory: MiseTomlSchemaHistory = { ... }
5158
5203
  | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.encryption">encryption</a></code> | <code><a href="#mise-projen.MiseTomlSchemaHistoryEncryption">MiseTomlSchemaHistoryEncryption</a></code> | *No description.* |
5159
5204
  | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.exclude">exclude</a></code> | <code>string[]</code> | globs never captured by dotfiles history; |
5160
5205
  | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.gitEmail">gitEmail</a></code> | <code>string</code> | email used for history commit authors and committers; |
5206
+ | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.machine">machine</a></code> | <code>string</code> | this machine's name in per-machine streams (variants = [{ machine = true }]) instead of the name generated with the history store. |
5161
5207
  | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.origin">origin</a></code> | <code><a href="#mise-projen.MiseTomlSchemaHistoryOrigin">MiseTomlSchemaHistoryOrigin</a></code> | the setup repository this machine publishes to and fetches from; |
5162
5208
  | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.reload">reload</a></code> | <code>{[ key: string ]: string}</code> | commands run once after a rollback or undo writes a path matching the glob (trusted global or system config only). |
5163
5209
 
@@ -5201,6 +5247,18 @@ email used for history commit authors and committers;
5201
5247
 
5202
5248
  ---
5203
5249
 
5250
+ ##### `machine`<sup>Optional</sup> <a name="machine" id="mise-projen.MiseTomlSchemaHistory.property.machine"></a>
5251
+
5252
+ ```typescript
5253
+ public readonly machine: string;
5254
+ ```
5255
+
5256
+ - *Type:* string
5257
+
5258
+ this machine's name in per-machine streams (variants = [{ machine = true }]) instead of the name generated with the history store.
5259
+
5260
+ ---
5261
+
5204
5262
  ##### `origin`<sup>Optional</sup> <a name="origin" id="mise-projen.MiseTomlSchemaHistory.property.origin"></a>
5205
5263
 
5206
5264
  ```typescript
@@ -5792,179 +5850,179 @@ const settings: Settings = { ... }
5792
5850
 
5793
5851
  | **Name** | **Type** | **Description** |
5794
5852
  | --- | --- | --- |
5795
- | <code><a href="#mise-projen.Settings.property.activateAggressive">activateAggressive</a></code> | <code>boolean</code> | Pushes tools' bin-paths to the front of PATH instead of allowing modifications of PATH after activation to take precedence. |
5796
- | <code><a href="#mise-projen.Settings.property.activateShims">activateShims</a></code> | <code>boolean</code> | Allow full shell activation to add tool shims to PATH. |
5853
+ | <code><a href="#mise-projen.Settings.property.activateAggressive">activateAggressive</a></code> | <code>boolean</code> | Keep mise's tool directories ahead of `PATH` entries added after `mise activate`. |
5854
+ | <code><a href="#mise-projen.Settings.property.activateShims">activateShims</a></code> | <code>boolean</code> | Let `mise activate` add the shims directories to `PATH` for auto-install and lazy tools. |
5797
5855
  | <code><a href="#mise-projen.Settings.property.age">age</a></code> | <code><a href="#mise-projen.SettingsAge">SettingsAge</a></code> | *No description.* |
5798
- | <code><a href="#mise-projen.Settings.property.allCompile">allCompile</a></code> | <code>boolean</code> | do not use precompiled binaries for any tool. |
5799
- | <code><a href="#mise-projen.Settings.property.alwaysKeepDownload">alwaysKeepDownload</a></code> | <code>boolean</code> | keep downloaded files after installation for debugging. |
5800
- | <code><a href="#mise-projen.Settings.property.alwaysKeepInstall">alwaysKeepInstall</a></code> | <code>boolean</code> | should mise keep install files after installation even if the installation fails. |
5856
+ | <code><a href="#mise-projen.Settings.property.allCompile">allCompile</a></code> | <code>boolean</code> | Compile Node.js, Python, Ruby and Erlang from source instead of using precompiled builds. |
5857
+ | <code><a href="#mise-projen.Settings.property.alwaysKeepDownload">alwaysKeepDownload</a></code> | <code>boolean</code> | Keep downloaded archives and sources after installing, for debugging. |
5858
+ | <code><a href="#mise-projen.Settings.property.alwaysKeepInstall">alwaysKeepInstall</a></code> | <code>boolean</code> | Keep a failed installation's partial install directory and downloads, for debugging. |
5801
5859
  | <code><a href="#mise-projen.Settings.property.aqua">aqua</a></code> | <code><a href="#mise-projen.SettingsAqua">SettingsAqua</a></code> | *No description.* |
5802
- | <code><a href="#mise-projen.Settings.property.arch">arch</a></code> | <code>string</code> | Architecture to use for precompiled binaries. |
5803
- | <code><a href="#mise-projen.Settings.property.asdfCompat">asdfCompat</a></code> | <code>boolean</code> | set to true to ensure .tool-versions will be compatible with asdf. |
5860
+ | <code><a href="#mise-projen.Settings.property.arch">arch</a></code> | <code>string</code> | Architecture of the precompiled binaries mise downloads. |
5861
+ | <code><a href="#mise-projen.Settings.property.asdfCompat">asdfCompat</a></code> | <code>boolean</code> | Write `.tool-versions` files that asdf can read, with exact versions. |
5804
5862
  | <code><a href="#mise-projen.Settings.property.autoEnv">autoEnv</a></code> | <code>boolean</code> | Automatically enable platform config environments (unix, {os}, {os}-{arch}). |
5805
- | <code><a href="#mise-projen.Settings.property.autoInstall">autoInstall</a></code> | <code>boolean</code> | Automatically install missing tools when running `mise x`, `mise run`, or as part of the 'not found' handler. |
5806
- | <code><a href="#mise-projen.Settings.property.autoInstallDisableTools">autoInstallDisableTools</a></code> | <code>string[]</code> | List of tools to skip automatically installing when running `mise x`, `mise run`, or as part of the 'not found' handler. |
5807
- | <code><a href="#mise-projen.Settings.property.autoUpdate">autoUpdate</a></code> | <code>boolean</code> | [deprecated] Use `self_update.auto` instead. |
5808
- | <code><a href="#mise-projen.Settings.property.autoUpdateCheckDuration">autoUpdateCheckDuration</a></code> | <code>string</code> | [deprecated] Use `self_update.check_duration` instead. |
5809
- | <code><a href="#mise-projen.Settings.property.cachePruneAge">cachePruneAge</a></code> | <code>string</code> | Delete files in cache that have not been accessed in this duration. |
5863
+ | <code><a href="#mise-projen.Settings.property.autoInstall">autoInstall</a></code> | <code>boolean</code> | Install missing tools automatically when a command needs them. |
5864
+ | <code><a href="#mise-projen.Settings.property.autoInstallDisableTools">autoInstallDisableTools</a></code> | <code>string[]</code> | Tools that automatic installs skip, such as `node`. |
5865
+ | <code><a href="#mise-projen.Settings.property.autoUpdate">autoUpdate</a></code> | <code>boolean</code> | [deprecated] Old name for `self_update.auto`. |
5866
+ | <code><a href="#mise-projen.Settings.property.autoUpdateCheckDuration">autoUpdateCheckDuration</a></code> | <code>string</code> | [deprecated] Old name for `self_update.check_duration`. |
5867
+ | <code><a href="#mise-projen.Settings.property.cachePruneAge">cachePruneAge</a></code> | <code>string</code> | Delete cache files that have not been accessed for this long. |
5810
5868
  | <code><a href="#mise-projen.Settings.property.cargo">cargo</a></code> | <code><a href="#mise-projen.SettingsCargo">SettingsCargo</a></code> | *No description.* |
5811
- | <code><a href="#mise-projen.Settings.property.cd">cd</a></code> | <code>string</code> | Path to change to after launching mise. |
5812
- | <code><a href="#mise-projen.Settings.property.ceilingPaths">ceilingPaths</a></code> | <code>string[]</code> | Directories where mise stops searching for config files. |
5813
- | <code><a href="#mise-projen.Settings.property.ci">ci</a></code> | <code>boolean</code> | Set to true if running in a CI environment. |
5814
- | <code><a href="#mise-projen.Settings.property.color">color</a></code> | <code>boolean</code> | Use color in mise terminal output. |
5815
- | <code><a href="#mise-projen.Settings.property.colorTheme">colorTheme</a></code> | <code><a href="#mise-projen.SettingsColorTheme">SettingsColorTheme</a></code> | Theme for interactive prompts (auto/default, charm, base16, catppuccin, dracula). |
5869
+ | <code><a href="#mise-projen.Settings.property.cd">cd</a></code> | <code>string</code> | Directory to change to after mise starts. |
5870
+ | <code><a href="#mise-projen.Settings.property.ceilingPaths">ceilingPaths</a></code> | <code>string[]</code> | Directories where mise stops searching parent directories for config files. |
5871
+ | <code><a href="#mise-projen.Settings.property.ci">ci</a></code> | <code>boolean</code> | Behave as in CI, which answers yes to confirmation prompts; |
5872
+ | <code><a href="#mise-projen.Settings.property.color">color</a></code> | <code>boolean</code> | Use color in mise's terminal output. |
5873
+ | <code><a href="#mise-projen.Settings.property.colorTheme">colorTheme</a></code> | <code><a href="#mise-projen.SettingsColorTheme">SettingsColorTheme</a></code> | Color theme for interactive prompts, such as the task picker in `mise run`. |
5816
5874
  | <code><a href="#mise-projen.Settings.property.conda">conda</a></code> | <code><a href="#mise-projen.SettingsConda">SettingsConda</a></code> | *No description.* |
5817
- | <code><a href="#mise-projen.Settings.property.debug">debug</a></code> | <code>boolean</code> | Sets log level to debug. |
5818
- | <code><a href="#mise-projen.Settings.property.defaultConfigFilename">defaultConfigFilename</a></code> | <code>string</code> | The default config filename read. |
5819
- | <code><a href="#mise-projen.Settings.property.defaultToolVersionsFilename">defaultToolVersionsFilename</a></code> | <code>string</code> | 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. |
5820
- | <code><a href="#mise-projen.Settings.property.disableBackends">disableBackends</a></code> | <code>string[]</code> | Backends to exclude from tool resolution and new installs, such as `asdf`, `pypi`, or a vfox-backend plugin name. |
5821
- | <code><a href="#mise-projen.Settings.property.disableDefaultRegistry">disableDefaultRegistry</a></code> | <code>boolean</code> | Disable the default mapping of short tool names like `php` -> `asdf:mise-plugins/asdf-php`. |
5822
- | <code><a href="#mise-projen.Settings.property.disableHints">disableHints</a></code> | <code>string[]</code> | Turns off helpful hints when using different mise features. |
5823
- | <code><a href="#mise-projen.Settings.property.disableTools">disableTools</a></code> | <code>string[]</code> | Tools defined in mise.toml that should be ignored. |
5875
+ | <code><a href="#mise-projen.Settings.property.debug">debug</a></code> | <code>boolean</code> | Set the log level to debug. |
5876
+ | <code><a href="#mise-projen.Settings.property.defaultConfigFilename">defaultConfigFilename</a></code> | <code>string</code> | Extra project config filename mise reads, and the name it gives new config files. |
5877
+ | <code><a href="#mise-projen.Settings.property.defaultToolVersionsFilename">defaultToolVersionsFilename</a></code> | <code>string</code> | Extra filename mise reads as a `.tool-versions` file. |
5878
+ | <code><a href="#mise-projen.Settings.property.disableBackends">disableBackends</a></code> | <code>string[]</code> | Backends mise ignores when resolving and installing tools, such as `asdf` or `pypi`. |
5879
+ | <code><a href="#mise-projen.Settings.property.disableDefaultRegistry">disableDefaultRegistry</a></code> | <code>boolean</code> | Stop mapping short names such as `php` to the asdf and vfox plugins listed in the registry. |
5880
+ | <code><a href="#mise-projen.Settings.property.disableHints">disableHints</a></code> | <code>string[]</code> | Hints to stop showing, by ID; |
5881
+ | <code><a href="#mise-projen.Settings.property.disableTools">disableTools</a></code> | <code>string[]</code> | Tools mise ignores even when a config file lists them. |
5824
5882
  | <code><a href="#mise-projen.Settings.property.disableUpdateWarning">disableUpdateWarning</a></code> | <code>boolean</code> | Suppress warnings when a newer mise version is available. |
5825
5883
  | <code><a href="#mise-projen.Settings.property.dotfiles">dotfiles</a></code> | <code><a href="#mise-projen.SettingsDotfiles">SettingsDotfiles</a></code> | *No description.* |
5826
5884
  | <code><a href="#mise-projen.Settings.property.dotnet">dotnet</a></code> | <code><a href="#mise-projen.SettingsDotnet">SettingsDotnet</a></code> | *No description.* |
5827
- | <code><a href="#mise-projen.Settings.property.enableTools">enableTools</a></code> | <code>string[]</code> | Tools defined in mise.toml that should be used; unset enables all tools and empty disables all tools. |
5828
- | <code><a href="#mise-projen.Settings.property.env">env</a></code> | <code>string[]</code> | Env to use for mise.<MISE_ENV>.toml files. |
5829
- | <code><a href="#mise-projen.Settings.property.envCache">envCache</a></code> | <code>boolean</code> | [experimental] Enable environment caching for nested mise invocations. |
5830
- | <code><a href="#mise-projen.Settings.property.envCacheTtl">envCacheTtl</a></code> | <code>string</code> | TTL for cached environments. |
5885
+ | <code><a href="#mise-projen.Settings.property.enableTools">enableTools</a></code> | <code>string[]</code> | Allowlist of configured tools mise uses; |
5886
+ | <code><a href="#mise-projen.Settings.property.env">env</a></code> | <code>string[]</code> | Config environments to load, such as `development` for `mise.development.toml`. |
5887
+ | <code><a href="#mise-projen.Settings.property.envCache">envCache</a></code> | <code>boolean</code> | [experimental] Cache computed environments on disk for nested mise commands. |
5888
+ | <code><a href="#mise-projen.Settings.property.envCacheTtl">envCacheTtl</a></code> | <code>string</code> | How long a cached environment stays valid. |
5831
5889
  | <code><a href="#mise-projen.Settings.property.envConfD">envConfD</a></code> | <code>boolean</code> | Enable environment-specific filenames in conf.d directories. |
5832
- | <code><a href="#mise-projen.Settings.property.envFile">envFile</a></code> | <code>string</code> | Path to a file containing environment variables to automatically load. |
5833
- | <code><a href="#mise-projen.Settings.property.envShellExpand">envShellExpand</a></code> | <code>boolean</code> | Controls shell-style variable expansion in env values (e.g., $FOO, ${BAR:-default}). |
5890
+ | <code><a href="#mise-projen.Settings.property.envFile">envFile</a></code> | <code>string</code> | Dotenv file name to load from the current directory and each parent directory. |
5891
+ | <code><a href="#mise-projen.Settings.property.envShellExpand">envShellExpand</a></code> | <code>boolean</code> | Expand shell-style variables such as `$FOO` and `${BAR:-default}` in `[env]` values. |
5834
5892
  | <code><a href="#mise-projen.Settings.property.erlang">erlang</a></code> | <code><a href="#mise-projen.SettingsErlang">SettingsErlang</a></code> | *No description.* |
5835
- | <code><a href="#mise-projen.Settings.property.execAutoInstall">execAutoInstall</a></code> | <code>boolean</code> | Automatically install missing tools when running `mise x`. |
5836
- | <code><a href="#mise-projen.Settings.property.experimental">experimental</a></code> | <code>boolean</code> | Enable experimental mise features which are incomplete or unstable—breakings changes may occur. |
5837
- | <code><a href="#mise-projen.Settings.property.fetchRemoteVersionsCache">fetchRemoteVersionsCache</a></code> | <code>string</code> | How long to cache remote versions for tools. |
5838
- | <code><a href="#mise-projen.Settings.property.fetchRemoteVersionsTimeout">fetchRemoteVersionsTimeout</a></code> | <code>string</code> | Timeout in seconds for HTTP requests to fetch new tool versions in mise. |
5893
+ | <code><a href="#mise-projen.Settings.property.execAutoInstall">execAutoInstall</a></code> | <code>boolean</code> | Install missing tools automatically when you run `mise exec`. |
5894
+ | <code><a href="#mise-projen.Settings.property.experimental">experimental</a></code> | <code>boolean</code> | Enable experimental features, which may change or be removed in any release. |
5895
+ | <code><a href="#mise-projen.Settings.property.fetchRemoteVersionsCache">fetchRemoteVersionsCache</a></code> | <code>string</code> | How long a tool's cached list of available versions stays fresh. |
5896
+ | <code><a href="#mise-projen.Settings.property.fetchRemoteVersionsTimeout">fetchRemoteVersionsTimeout</a></code> | <code>string</code> | Timeout for looking up a tool's available versions. |
5839
5897
  | <code><a href="#mise-projen.Settings.property.forgejo">forgejo</a></code> | <code><a href="#mise-projen.SettingsForgejo">SettingsForgejo</a></code> | *No description.* |
5840
5898
  | <code><a href="#mise-projen.Settings.property.github">github</a></code> | <code><a href="#mise-projen.SettingsGithub">SettingsGithub</a></code> | *No description.* |
5841
- | <code><a href="#mise-projen.Settings.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Enable GitHub Artifact Attestations verification for supported tools. |
5899
+ | <code><a href="#mise-projen.Settings.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Verify GitHub artifact attestations for downloads whose publisher provides them. |
5842
5900
  | <code><a href="#mise-projen.Settings.property.githubRelay">githubRelay</a></code> | <code><a href="#mise-projen.SettingsGithubRelay">SettingsGithubRelay</a></code> | *No description.* |
5843
5901
  | <code><a href="#mise-projen.Settings.property.gitlab">gitlab</a></code> | <code><a href="#mise-projen.SettingsGitlab">SettingsGitlab</a></code> | *No description.* |
5844
- | <code><a href="#mise-projen.Settings.property.gix">gix</a></code> | <code>boolean</code> | Use gix for git operations, set to false to shell out to git. |
5845
- | <code><a href="#mise-projen.Settings.property.globalConfigFile">globalConfigFile</a></code> | <code>string</code> | Path to the global mise config file. |
5846
- | <code><a href="#mise-projen.Settings.property.globalConfigRoot">globalConfigRoot</a></code> | <code>string</code> | Path which is used as `{{config_root}}` for the global config file. |
5902
+ | <code><a href="#mise-projen.Settings.property.gix">gix</a></code> | <code>boolean</code> | Clone Git repositories with the built-in gix library instead of running `git`. |
5903
+ | <code><a href="#mise-projen.Settings.property.globalConfigFile">globalConfigFile</a></code> | <code>string</code> | One file to use as the global config instead of the config files in `~/.config/mise`. |
5904
+ | <code><a href="#mise-projen.Settings.property.globalConfigRoot">globalConfigRoot</a></code> | <code>string</code> | Directory used as `config_root` for the global config, such as for `{{config_root}}` in templates. |
5847
5905
  | <code><a href="#mise-projen.Settings.property.go">go</a></code> | <code><a href="#mise-projen.SettingsGo">SettingsGo</a></code> | *No description.* |
5848
- | <code><a href="#mise-projen.Settings.property.goDefaultPackagesFile">goDefaultPackagesFile</a></code> | <code>string</code> | Path to a file containing default go packages to install when installing go. |
5849
- | <code><a href="#mise-projen.Settings.property.goDownloadMirror">goDownloadMirror</a></code> | <code>string</code> | Mirror to download go sdk tarballs from. |
5850
- | <code><a href="#mise-projen.Settings.property.goRepo">goRepo</a></code> | <code>string</code> | URL to fetch go from. |
5851
- | <code><a href="#mise-projen.Settings.property.goSetGobin">goSetGobin</a></code> | <code>boolean</code> | Changes where `go install` installs binaries to. |
5852
- | <code><a href="#mise-projen.Settings.property.goSetGopath">goSetGopath</a></code> | <code>boolean</code> | [deprecated] Set to true to set GOPATH=~/.local/share/mise/installs/go/.../packages. |
5853
- | <code><a href="#mise-projen.Settings.property.goSetGoroot">goSetGoroot</a></code> | <code>boolean</code> | Sets GOROOT=~/.local/share/mise/installs/go/.../. |
5854
- | <code><a href="#mise-projen.Settings.property.goSkipChecksum">goSkipChecksum</a></code> | <code>boolean</code> | Set to true to skip checksum verification when downloading go sdk tarballs. |
5855
- | <code><a href="#mise-projen.Settings.property.gpgVerify">gpgVerify</a></code> | <code>boolean</code> | Verify OpenPGP signatures for all tools (built-in, no external gpg required). |
5906
+ | <code><a href="#mise-projen.Settings.property.goDefaultPackagesFile">goDefaultPackagesFile</a></code> | <code>string</code> | File listing Go packages to install with every Go version. |
5907
+ | <code><a href="#mise-projen.Settings.property.goDownloadMirror">goDownloadMirror</a></code> | <code>string</code> | Base URL that mise downloads Go archives and their checksums from. |
5908
+ | <code><a href="#mise-projen.Settings.property.goRepo">goRepo</a></code> | <code>string</code> | Git repository mise lists Go versions from. |
5909
+ | <code><a href="#mise-projen.Settings.property.goSetGobin">goSetGobin</a></code> | <code>boolean</code> | Set `GOBIN` so `go install` puts binaries in the active Go version's directory. |
5910
+ | <code><a href="#mise-projen.Settings.property.goSetGopath">goSetGopath</a></code> | <code>boolean</code> | [deprecated] Set `GOPATH` to the `packages` directory inside the active Go install. |
5911
+ | <code><a href="#mise-projen.Settings.property.goSetGoroot">goSetGoroot</a></code> | <code>boolean</code> | Set `GOROOT` to the active Go version's install directory. |
5912
+ | <code><a href="#mise-projen.Settings.property.goSkipChecksum">goSkipChecksum</a></code> | <code>boolean</code> | Skip SHA-256 verification of Go downloads. |
5913
+ | <code><a href="#mise-projen.Settings.property.gpgVerify">gpgVerify</a></code> | <code>boolean</code> | Verify OpenPGP signatures of Node.js and Swift downloads. |
5856
5914
  | <code><a href="#mise-projen.Settings.property.history">history</a></code> | <code><a href="#mise-projen.SettingsHistory">SettingsHistory</a></code> | *No description.* |
5857
5915
  | <code><a href="#mise-projen.Settings.property.hookEnv">hookEnv</a></code> | <code><a href="#mise-projen.SettingsHookEnv">SettingsHookEnv</a></code> | *No description.* |
5858
- | <code><a href="#mise-projen.Settings.property.httpDownloadTimeout">httpDownloadTimeout</a></code> | <code>string</code> | Total time allowed for an HTTP download, including retries. |
5859
- | <code><a href="#mise-projen.Settings.property.httpRetries">httpRetries</a></code> | <code>number</code> | Number of retries for transient HTTP failures in mise. |
5916
+ | <code><a href="#mise-projen.Settings.property.httpDownloadTimeout">httpDownloadTimeout</a></code> | <code>string</code> | Total time allowed to download one file, including retries. |
5917
+ | <code><a href="#mise-projen.Settings.property.httpRetries">httpRetries</a></code> | <code>number</code> | Number of retries after a transient HTTP failure. |
5860
5918
  | <code><a href="#mise-projen.Settings.property.httpTimeout">httpTimeout</a></code> | <code>string</code> | Timeout for connecting or waiting between reads during HTTP requests. |
5861
- | <code><a href="#mise-projen.Settings.property.idiomaticVersionFile">idiomaticVersionFile</a></code> | <code>boolean</code> | Set to false to disable the idiomatic version files such as .node-version, .ruby-version, etc. |
5862
- | <code><a href="#mise-projen.Settings.property.idiomaticVersionFileDisableFiles">idiomaticVersionFileDisableFiles</a></code> | <code>string[]</code> | Specific idiomatic version files to disable for a tool. |
5863
- | <code><a href="#mise-projen.Settings.property.idiomaticVersionFileDisableTools">idiomaticVersionFileDisableTools</a></code> | <code>string[]</code> | Specific tools to disable idiomatic version files for. |
5864
- | <code><a href="#mise-projen.Settings.property.idiomaticVersionFileEnableTools">idiomaticVersionFileEnableTools</a></code> | <code>string[]</code> | Specific tools to enable idiomatic version files for like .node-version, .ruby-version, etc. |
5919
+ | <code><a href="#mise-projen.Settings.property.idiomaticVersionFile">idiomaticVersionFile</a></code> | <code>boolean</code> | [deprecated] No effect; |
5920
+ | <code><a href="#mise-projen.Settings.property.idiomaticVersionFileDisableFiles">idiomaticVersionFileDisableFiles</a></code> | <code>string[]</code> | Idiomatic version files to ignore for one tool, as `tool:filename` pairs. |
5921
+ | <code><a href="#mise-projen.Settings.property.idiomaticVersionFileDisableTools">idiomaticVersionFileDisableTools</a></code> | <code>string[]</code> | [deprecated] No effect; |
5922
+ | <code><a href="#mise-projen.Settings.property.idiomaticVersionFileEnableTools">idiomaticVersionFileEnableTools</a></code> | <code>string[]</code> | Tools that read idiomatic version files such as `.node-version` or `.ruby-version`. |
5865
5923
  | <code><a href="#mise-projen.Settings.property.idiomaticVersionFileIgnoreMinimumVersions">idiomaticVersionFileIgnoreMinimumVersions</a></code> | <code>boolean</code> | Ignore idiomatic version file fields that only declare a minimum compatible version. |
5866
- | <code><a href="#mise-projen.Settings.property.ignoredConfigPaths">ignoredConfigPaths</a></code> | <code>string[]</code> | This is a list of config paths that mise will ignore. |
5867
- | <code><a href="#mise-projen.Settings.property.installBefore">installBefore</a></code> | <code>string</code> | Minimum release age / supply chain protection — only install versions released before this date. |
5924
+ | <code><a href="#mise-projen.Settings.property.ignoredConfigPaths">ignoredConfigPaths</a></code> | <code>string[]</code> | Config files and directories mise does not load. |
5925
+ | <code><a href="#mise-projen.Settings.property.installBefore">installBefore</a></code> | <code>string</code> | [deprecated] Install only versions released before this date; |
5868
5926
  | <code><a href="#mise-projen.Settings.property.installLayout">installLayout</a></code> | <code><a href="#mise-projen.SettingsInstallLayout">SettingsInstallLayout</a></code> | [experimental] Name installations by what they are (`identity`) instead of `installs/<tool>/<version>` (`legacy`). |
5869
5927
  | <code><a href="#mise-projen.Settings.property.java">java</a></code> | <code><a href="#mise-projen.SettingsJava">SettingsJava</a></code> | *No description.* |
5870
5928
  | <code><a href="#mise-projen.Settings.property.jobs">jobs</a></code> | <code>number</code> | How many jobs to run concurrently such as tool installs. |
5871
- | <code><a href="#mise-projen.Settings.property.legacyVersionFile">legacyVersionFile</a></code> | <code>boolean</code> | Set to false to disable the idiomatic version files such as .node-version, .ruby-version, etc. |
5872
- | <code><a href="#mise-projen.Settings.property.legacyVersionFileDisableTools">legacyVersionFileDisableTools</a></code> | <code>string[]</code> | Specific tools to disable idiomatic version files for. |
5873
- | <code><a href="#mise-projen.Settings.property.libc">libc</a></code> | <code><a href="#mise-projen.SettingsLibc">SettingsLibc</a></code> | Libc implementation to use for precompiled Linux binaries. |
5874
- | <code><a href="#mise-projen.Settings.property.libgit2">libgit2</a></code> | <code>boolean</code> | Use libgit2 for git operations, set to false to shell out to git. |
5875
- | <code><a href="#mise-projen.Settings.property.locked">locked</a></code> | <code>boolean</code> | Require lockfile URLs to be present during installation. |
5929
+ | <code><a href="#mise-projen.Settings.property.legacyVersionFile">legacyVersionFile</a></code> | <code>boolean</code> | [deprecated] No effect; |
5930
+ | <code><a href="#mise-projen.Settings.property.legacyVersionFileDisableTools">legacyVersionFileDisableTools</a></code> | <code>string[]</code> | [deprecated] No effect; |
5931
+ | <code><a href="#mise-projen.Settings.property.libc">libc</a></code> | <code><a href="#mise-projen.SettingsLibc">SettingsLibc</a></code> | Libc build to install on Linux when a tool publishes both glibc and musl builds. |
5932
+ | <code><a href="#mise-projen.Settings.property.libgit2">libgit2</a></code> | <code>boolean</code> | Clone Git repositories with the built-in gix library instead of running `git`; |
5933
+ | <code><a href="#mise-projen.Settings.property.locked">locked</a></code> | <code>boolean</code> | Require tool versions and download URLs to come from the lockfile. |
5876
5934
  | <code><a href="#mise-projen.Settings.property.lockedScopes">lockedScopes</a></code> | <code><a href="#mise-projen.SettingsLockedScopes">SettingsLockedScopes</a>[]</code> | Config scopes where invocation-wide locked mode is enforced. |
5877
- | <code><a href="#mise-projen.Settings.property.lockedVerifyProvenance">lockedVerifyProvenance</a></code> | <code>boolean</code> | Re-verify provenance at install time even when the lockfile already has provenance. |
5878
- | <code><a href="#mise-projen.Settings.property.lockfile">lockfile</a></code> | <code>boolean</code> | Create and read lockfiles for tool versions. |
5935
+ | <code><a href="#mise-projen.Settings.property.lockedVerifyProvenance">lockedVerifyProvenance</a></code> | <code>boolean</code> | Re-verify provenance at install time even when the lockfile already records it. |
5936
+ | <code><a href="#mise-projen.Settings.property.lockfile">lockfile</a></code> | <code>boolean</code> | Create, read and update `mise.lock` lockfiles for tool versions. |
5879
5937
  | <code><a href="#mise-projen.Settings.property.lockfileAutoPrune">lockfileAutoPrune</a></code> | <code>boolean</code> | Remove lockfile tools that are absent from the active configuration. |
5880
- | <code><a href="#mise-projen.Settings.property.lockfileMode">lockfileMode</a></code> | <code><a href="#mise-projen.SettingsLockfileMode">SettingsLockfileMode</a></code> | Choose incremental merging or complete lockfile generation. |
5881
- | <code><a href="#mise-projen.Settings.property.lockfilePlatforms">lockfilePlatforms</a></code> | <code>string[]</code> | Platforms to target in lockfile operations. |
5882
- | <code><a href="#mise-projen.Settings.property.logLevel">logLevel</a></code> | <code><a href="#mise-projen.SettingsLogLevel">SettingsLogLevel</a></code> | Show more/less output. |
5883
- | <code><a href="#mise-projen.Settings.property.minimumReleaseAge">minimumReleaseAge</a></code> | <code>string</code> | Minimum release age / supply chain protection — only install versions older than this threshold. |
5884
- | <code><a href="#mise-projen.Settings.property.minimumReleaseAgeExcludes">minimumReleaseAgeExcludes</a></code> | <code>string[]</code> | Tools and backends to exclude from the global/default minimum_release_age setting. |
5938
+ | <code><a href="#mise-projen.Settings.property.lockfileMode">lockfileMode</a></code> | <code><a href="#mise-projen.SettingsLockfileMode">SettingsLockfileMode</a></code> | How lockfiles are written: entry by entry, or rebuilt from the current requests. |
5939
+ | <code><a href="#mise-projen.Settings.property.lockfilePlatforms">lockfilePlatforms</a></code> | <code>string[]</code> | Platforms to resolve lockfile URLs and checksums for. |
5940
+ | <code><a href="#mise-projen.Settings.property.logLevel">logLevel</a></code> | <code><a href="#mise-projen.SettingsLogLevel">SettingsLogLevel</a></code> | Log level for mise's own output. |
5941
+ | <code><a href="#mise-projen.Settings.property.minimumReleaseAge">minimumReleaseAge</a></code> | <code>string</code> | Skip versions published more recently than this duration or date. |
5942
+ | <code><a href="#mise-projen.Settings.property.minimumReleaseAgeExcludes">minimumReleaseAgeExcludes</a></code> | <code>string[]</code> | Tools and backends that the configured and default `minimum_release_age` do not apply to. |
5885
5943
  | <code><a href="#mise-projen.Settings.property.netrc">netrc</a></code> | <code>boolean</code> | Use a netrc file for HTTP Basic authentication. |
5886
- | <code><a href="#mise-projen.Settings.property.netrcFile">netrcFile</a></code> | <code>string</code> | Path to the netrc file to use for HTTP Basic authentication. |
5944
+ | <code><a href="#mise-projen.Settings.property.netrcFile">netrcFile</a></code> | <code>string</code> | Path of the netrc file to use instead of `~/.netrc` (`%USERPROFILE%\_netrc` on Windows). |
5887
5945
  | <code><a href="#mise-projen.Settings.property.node">node</a></code> | <code><a href="#mise-projen.SettingsNode">SettingsNode</a></code> | *No description.* |
5888
5946
  | <code><a href="#mise-projen.Settings.property.noEnv">noEnv</a></code> | <code>boolean</code> | Do not load environment variables from config files. |
5889
5947
  | <code><a href="#mise-projen.Settings.property.noHooks">noHooks</a></code> | <code>boolean</code> | Do not execute hooks from config files. |
5890
- | <code><a href="#mise-projen.Settings.property.notFoundAutoInstall">notFoundAutoInstall</a></code> | <code>boolean</code> | Set to false to disable the "command not found" handler to autoinstall missing tool versions. |
5891
- | <code><a href="#mise-projen.Settings.property.notFoundAutoInstallRegistry">notFoundAutoInstallRegistry</a></code> | <code>boolean</code> | Automatically install an unconfigured tool when its registry bin matches a missing command. |
5892
- | <code><a href="#mise-projen.Settings.property.notFoundSystemFallback">notFoundSystemFallback</a></code> | <code>boolean</code> | Set to false to stop shims from falling back to a same-named binary found elsewhere on PATH. |
5948
+ | <code><a href="#mise-projen.Settings.property.notFoundAutoInstall">notFoundAutoInstall</a></code> | <code>boolean</code> | Install the tool that provides a command when your shell cannot find that command. |
5949
+ | <code><a href="#mise-projen.Settings.property.notFoundAutoInstallRegistry">notFoundAutoInstallRegistry</a></code> | <code>boolean</code> | Install an unconfigured tool when exactly one registry entry provides a command your shell cannot find. |
5950
+ | <code><a href="#mise-projen.Settings.property.notFoundSystemFallback">notFoundSystemFallback</a></code> | <code>boolean</code> | Let a shim run a same-named executable from elsewhere on `PATH` when mise cannot resolve the tool. |
5893
5951
  | <code><a href="#mise-projen.Settings.property.npm">npm</a></code> | <code><a href="#mise-projen.SettingsNpm">SettingsNpm</a></code> | *No description.* |
5894
5952
  | <code><a href="#mise-projen.Settings.property.oci">oci</a></code> | <code><a href="#mise-projen.SettingsOci">SettingsOci</a></code> | *No description.* |
5895
- | <code><a href="#mise-projen.Settings.property.offline">offline</a></code> | <code>boolean</code> | Disable all HTTP requests. |
5896
- | <code><a href="#mise-projen.Settings.property.os">os</a></code> | <code>string</code> | OS to use for precompiled binaries. |
5953
+ | <code><a href="#mise-projen.Settings.property.offline">offline</a></code> | <code>boolean</code> | Block every HTTP request, so mise uses only installed tools and cached data. |
5954
+ | <code><a href="#mise-projen.Settings.property.os">os</a></code> | <code>string</code> | Operating system of the precompiled binaries mise downloads. |
5897
5955
  | <code><a href="#mise-projen.Settings.property.otel">otel</a></code> | <code><a href="#mise-projen.SettingsOtel">SettingsOtel</a></code> | *No description.* |
5898
- | <code><a href="#mise-projen.Settings.property.overrideConfigFilenames">overrideConfigFilenames</a></code> | <code>string[]</code> | If set, mise will ignore default config files like `mise.toml` and use these filenames instead. |
5899
- | <code><a href="#mise-projen.Settings.property.overrideToolVersionsFilenames">overrideToolVersionsFilenames</a></code> | <code>string[]</code> | If set, mise will ignore .tool-versions files and use these filenames instead. Can be set to `none` to disable .tool-versions. |
5956
+ | <code><a href="#mise-projen.Settings.property.overrideConfigFilenames">overrideConfigFilenames</a></code> | <code>string[]</code> | Project config filenames that mise looks for instead of `mise.toml`, `.mise.toml` and the other standard names. |
5957
+ | <code><a href="#mise-projen.Settings.property.overrideToolVersionsFilenames">overrideToolVersionsFilenames</a></code> | <code>string[]</code> | Filenames that mise reads as `.tool-versions` files instead of `.tool-versions`. |
5900
5958
  | <code><a href="#mise-projen.Settings.property.packslip">packslip</a></code> | <code><a href="#mise-projen.SettingsPackslip">SettingsPackslip</a></code> | *No description.* |
5901
- | <code><a href="#mise-projen.Settings.property.paranoid">paranoid</a></code> | <code>boolean</code> | Enables extra-secure behavior. |
5902
- | <code><a href="#mise-projen.Settings.property.pin">pin</a></code> | <code>boolean</code> | Default to pinning versions when running `mise use` in mise.toml files. |
5959
+ | <code><a href="#mise-projen.Settings.property.paranoid">paranoid</a></code> | <code>boolean</code> | Require explicit, content-bound trust for project config, and re-verify provenance on every install. |
5960
+ | <code><a href="#mise-projen.Settings.property.pin">pin</a></code> | <code>boolean</code> | Make `mise use` write the resolved version, such as `24.14.0` for `node@24`, instead of the requested one. |
5903
5961
  | <code><a href="#mise-projen.Settings.property.pipx">pipx</a></code> | <code><a href="#mise-projen.SettingsPipx">SettingsPipx</a></code> | *No description.* |
5904
- | <code><a href="#mise-projen.Settings.property.pluginAutoupdateLastCheckDuration">pluginAutoupdateLastCheckDuration</a></code> | <code>string</code> | How long to wait before updating plugins automatically (note this isn't currently implemented). |
5905
- | <code><a href="#mise-projen.Settings.property.preferOffline">preferOffline</a></code> | <code>boolean</code> | Prefer locally cached data over remote fetches when possible. |
5906
- | <code><a href="#mise-projen.Settings.property.prereleases">prereleases</a></code> | <code>boolean</code> | Include pre-release versions in `ls-remote`, `latest` resolution, and fuzzy matching for all tools. |
5907
- | <code><a href="#mise-projen.Settings.property.profile">profile</a></code> | <code>string</code> | Profile to use for mise.${MISE_PROFILE}.toml files. |
5908
- | <code><a href="#mise-projen.Settings.property.provenanceApiFailuresFatal">provenanceApiFailuresFatal</a></code> | <code>boolean</code> | Fail when provenance API checks cannot be completed. |
5962
+ | <code><a href="#mise-projen.Settings.property.pluginAutoupdateLastCheckDuration">pluginAutoupdateLastCheckDuration</a></code> | <code>string</code> | [deprecated] Has no effect; |
5963
+ | <code><a href="#mise-projen.Settings.property.preferOffline">preferOffline</a></code> | <code>boolean</code> | Use cached version lists instead of fetching new ones, and go to the network only when nothing is cached. |
5964
+ | <code><a href="#mise-projen.Settings.property.prereleases">prereleases</a></code> | <code>boolean</code> | Include prereleases in `mise ls-remote`, `latest` and prefix matching for every tool. |
5965
+ | <code><a href="#mise-projen.Settings.property.profile">profile</a></code> | <code>string</code> | Older name for the `env` setting; |
5966
+ | <code><a href="#mise-projen.Settings.property.provenanceApiFailuresFatal">provenanceApiFailuresFatal</a></code> | <code>boolean</code> | Fail an install when a provenance API, such as GitHub's attestation API, cannot be reached or queried. |
5909
5967
  | <code><a href="#mise-projen.Settings.property.prune">prune</a></code> | <code><a href="#mise-projen.SettingsPrune">SettingsPrune</a></code> | *No description.* |
5910
5968
  | <code><a href="#mise-projen.Settings.property.pypi">pypi</a></code> | <code><a href="#mise-projen.SettingsPypi">SettingsPypi</a></code> | *No description.* |
5911
5969
  | <code><a href="#mise-projen.Settings.property.python">python</a></code> | <code><a href="#mise-projen.SettingsPython">SettingsPython</a></code> | *No description.* |
5912
- | <code><a href="#mise-projen.Settings.property.quiet">quiet</a></code> | <code>boolean</code> | Suppress all output except errors. |
5913
- | <code><a href="#mise-projen.Settings.property.raw">raw</a></code> | <code>boolean</code> | Connect stdin/stdout/stderr to child processes. |
5914
- | <code><a href="#mise-projen.Settings.property.registryCacheTtl">registryCacheTtl</a></code> | <code>string</code> | How long to cache the floating mise registry. |
5915
- | <code><a href="#mise-projen.Settings.property.registryFloating">registryFloating</a></code> | <code>boolean</code> | Fetch the latest released mise registry and current aqua registry instead of using only the snapshots baked into this mise release. |
5970
+ | <code><a href="#mise-projen.Settings.property.quiet">quiet</a></code> | <code>boolean</code> | Hide mise's own non-error messages, such as progress and task headers; |
5971
+ | <code><a href="#mise-projen.Settings.property.raw">raw</a></code> | <code>boolean</code> | Connect tasks and install commands directly to the terminal's stdin, stdout and stderr. |
5972
+ | <code><a href="#mise-projen.Settings.property.registryCacheTtl">registryCacheTtl</a></code> | <code>string</code> | How long a downloaded mise registry stays fresh when `registry_floating` is on. |
5973
+ | <code><a href="#mise-projen.Settings.property.registryFloating">registryFloating</a></code> | <code>boolean</code> | Use the latest released mise registry and the current aqua registry, not only the copies built into mise. |
5916
5974
  | <code><a href="#mise-projen.Settings.property.ruby">ruby</a></code> | <code><a href="#mise-projen.SettingsRuby">SettingsRuby</a></code> | *No description.* |
5917
5975
  | <code><a href="#mise-projen.Settings.property.rust">rust</a></code> | <code><a href="#mise-projen.SettingsRust">SettingsRust</a></code> | *No description.* |
5918
- | <code><a href="#mise-projen.Settings.property.safe">safe</a></code> | <code>boolean</code> | Prevent project configuration from executing code during config loading and version resolution. |
5976
+ | <code><a href="#mise-projen.Settings.property.safe">safe</a></code> | <code>boolean</code> | Load project config without letting it run code or change the environment, for automation that reads untrusted config. |
5919
5977
  | <code><a href="#mise-projen.Settings.property.sandbox">sandbox</a></code> | <code><a href="#mise-projen.SettingsSandbox">SettingsSandbox</a></code> | *No description.* |
5920
5978
  | <code><a href="#mise-projen.Settings.property.selfUpdate">selfUpdate</a></code> | <code><a href="#mise-projen.SettingsSelfUpdate">SettingsSelfUpdate</a></code> | *No description.* |
5921
- | <code><a href="#mise-projen.Settings.property.sharedInstallDirs">sharedInstallDirs</a></code> | <code>string[]</code> | Additional read-only directories to search for installed tool versions. |
5979
+ | <code><a href="#mise-projen.Settings.property.sharedInstallDirs">sharedInstallDirs</a></code> | <code>string[]</code> | Extra read-only directories that mise searches for installed tool versions. |
5922
5980
  | <code><a href="#mise-projen.Settings.property.shims">shims</a></code> | <code><a href="#mise-projen.SettingsShims">SettingsShims</a></code> | *No description.* |
5923
- | <code><a href="#mise-projen.Settings.property.shimsDir">shimsDir</a></code> | <code>string</code> | Directory containing user shims. |
5924
- | <code><a href="#mise-projen.Settings.property.shorthandsFile">shorthandsFile</a></code> | <code>string</code> | [deprecated] Path to a file containing custom tool shorthands. |
5925
- | <code><a href="#mise-projen.Settings.property.silent">silent</a></code> | <code>boolean</code> | Suppress all `mise run\|watch` output except errors—including what tasks output. |
5981
+ | <code><a href="#mise-projen.Settings.property.shimsDir">shimsDir</a></code> | <code>string</code> | Directory where mise writes user shims. |
5982
+ | <code><a href="#mise-projen.Settings.property.shorthandsFile">shorthandsFile</a></code> | <code>string</code> | [deprecated] File of custom tool shorthands; |
5983
+ | <code><a href="#mise-projen.Settings.property.silent">silent</a></code> | <code>boolean</code> | Hide all output from `mise run` and `mise watch`, including what tasks print, except errors; |
5926
5984
  | <code><a href="#mise-projen.Settings.property.skills">skills</a></code> | <code><a href="#mise-projen.SettingsSkills">SettingsSkills</a></code> | *No description.* |
5927
- | <code><a href="#mise-projen.Settings.property.slsa">slsa</a></code> | <code>boolean</code> | Enable SLSA provenance verification globally. |
5985
+ | <code><a href="#mise-projen.Settings.property.slsa">slsa</a></code> | <code>boolean</code> | Verify SLSA provenance of downloads whose publisher provides it. |
5928
5986
  | <code><a href="#mise-projen.Settings.property.sops">sops</a></code> | <code><a href="#mise-projen.SettingsSops">SettingsSops</a></code> | *No description.* |
5929
5987
  | <code><a href="#mise-projen.Settings.property.spm">spm</a></code> | <code><a href="#mise-projen.SettingsSpm">SettingsSpm</a></code> | *No description.* |
5930
5988
  | <code><a href="#mise-projen.Settings.property.status">status</a></code> | <code><a href="#mise-projen.SettingsStatus">SettingsStatus</a></code> | *No description.* |
5931
5989
  | <code><a href="#mise-projen.Settings.property.swift">swift</a></code> | <code><a href="#mise-projen.SettingsSwift">SettingsSwift</a></code> | *No description.* |
5932
- | <code><a href="#mise-projen.Settings.property.systemConfigFile">systemConfigFile</a></code> | <code>string</code> | Path to the system mise config file. |
5933
- | <code><a href="#mise-projen.Settings.property.systemDeps">systemDeps</a></code> | <code><a href="#mise-projen.SettingsSystemDeps">SettingsSystemDeps</a></code> | How to handle a plugin's declared system dependencies before installing a tool. |
5934
- | <code><a href="#mise-projen.Settings.property.systemInstallsDir">systemInstallsDir</a></code> | <code>string</code> | Directory containing system tool installs. |
5990
+ | <code><a href="#mise-projen.Settings.property.systemConfigFile">systemConfigFile</a></code> | <code>string</code> | One file to use as the system config instead of the config files in `/etc/mise`. |
5991
+ | <code><a href="#mise-projen.Settings.property.systemDeps">systemDeps</a></code> | <code><a href="#mise-projen.SettingsSystemDeps">SettingsSystemDeps</a></code> | What mise does when a plugin's declared system dependencies are missing before it installs a tool. |
5992
+ | <code><a href="#mise-projen.Settings.property.systemInstallsDir">systemInstallsDir</a></code> | <code>string</code> | Directory that `mise install --system` installs into. |
5935
5993
  | <code><a href="#mise-projen.Settings.property.systemPackages">systemPackages</a></code> | <code><a href="#mise-projen.SettingsSystemPackages">SettingsSystemPackages</a></code> | *No description.* |
5936
- | <code><a href="#mise-projen.Settings.property.systemShimsDir">systemShimsDir</a></code> | <code>string</code> | Directory containing system shims. |
5994
+ | <code><a href="#mise-projen.Settings.property.systemShimsDir">systemShimsDir</a></code> | <code>string</code> | Directory where `mise reshim --system` writes shims for system installs. |
5937
5995
  | <code><a href="#mise-projen.Settings.property.task">task</a></code> | <code><a href="#mise-projen.SettingsTask">SettingsTask</a></code> | *No description.* |
5938
- | <code><a href="#mise-projen.Settings.property.taskDisablePaths">taskDisablePaths</a></code> | <code>string[]</code> | Paths that mise will not look for tasks in. |
5939
- | <code><a href="#mise-projen.Settings.property.taskOutput">taskOutput</a></code> | <code>string</code> | Change output style when executing tasks. |
5940
- | <code><a href="#mise-projen.Settings.property.taskRemoteNoCache">taskRemoteNoCache</a></code> | <code>boolean</code> | Mise will always fetch the latest tasks from the remote, by default the cache is used. |
5941
- | <code><a href="#mise-projen.Settings.property.taskRunAutoInstall">taskRunAutoInstall</a></code> | <code>boolean</code> | Automatically install missing tools when executing tasks. |
5942
- | <code><a href="#mise-projen.Settings.property.taskShowFullCmd">taskShowFullCmd</a></code> | <code>boolean</code> | Disable truncation of command lines in task execution output. |
5943
- | <code><a href="#mise-projen.Settings.property.taskSkip">taskSkip</a></code> | <code>string[]</code> | Tasks to skip when running `mise run`. |
5944
- | <code><a href="#mise-projen.Settings.property.taskSkipDepends">taskSkipDepends</a></code> | <code>boolean</code> | Run only specified tasks skipping all dependencies. |
5945
- | <code><a href="#mise-projen.Settings.property.taskTimeout">taskTimeout</a></code> | <code>string</code> | Default timeout for tasks. |
5946
- | <code><a href="#mise-projen.Settings.property.taskTimings">taskTimings</a></code> | <code>boolean</code> | Show completion message with elapsed time for each task on `mise run`. |
5947
- | <code><a href="#mise-projen.Settings.property.teraV1">teraV1</a></code> | <code>boolean</code> | Use Tera v1 instead of Tera v2 for template rendering. |
5948
- | <code><a href="#mise-projen.Settings.property.terminalProgress">terminalProgress</a></code> | <code>boolean</code> | Enable terminal progress indicators (OSC 9;4) for compatible terminals. |
5996
+ | <code><a href="#mise-projen.Settings.property.taskDisablePaths">taskDisablePaths</a></code> | <code>string[]</code> | Deprecated alias for `task.disable_paths`. |
5997
+ | <code><a href="#mise-projen.Settings.property.taskOutput">taskOutput</a></code> | <code>string</code> | Deprecated alias for `task.output`. |
5998
+ | <code><a href="#mise-projen.Settings.property.taskRemoteNoCache">taskRemoteNoCache</a></code> | <code>boolean</code> | Deprecated alias for `task.remote_no_cache`. |
5999
+ | <code><a href="#mise-projen.Settings.property.taskRunAutoInstall">taskRunAutoInstall</a></code> | <code>boolean</code> | Deprecated alias for `task.run_auto_install`. |
6000
+ | <code><a href="#mise-projen.Settings.property.taskShowFullCmd">taskShowFullCmd</a></code> | <code>boolean</code> | Deprecated alias for `task.show_full_cmd`. |
6001
+ | <code><a href="#mise-projen.Settings.property.taskSkip">taskSkip</a></code> | <code>string[]</code> | Deprecated alias for `task.skip`. |
6002
+ | <code><a href="#mise-projen.Settings.property.taskSkipDepends">taskSkipDepends</a></code> | <code>boolean</code> | Deprecated alias for `task.skip_depends`. |
6003
+ | <code><a href="#mise-projen.Settings.property.taskTimeout">taskTimeout</a></code> | <code>string</code> | Deprecated alias for `task.timeout`. |
6004
+ | <code><a href="#mise-projen.Settings.property.taskTimings">taskTimings</a></code> | <code>boolean</code> | Deprecated alias for `task.timings`. |
6005
+ | <code><a href="#mise-projen.Settings.property.teraV1">teraV1</a></code> | <code>boolean</code> | [deprecated] Render templates with Tera v1 instead of Tera v2. |
6006
+ | <code><a href="#mise-projen.Settings.property.terminalProgress">terminalProgress</a></code> | <code>boolean</code> | Show install progress in the terminal window's own progress indicator, with OSC 9;4 escape sequences. |
5949
6007
  | <code><a href="#mise-projen.Settings.property.toolUpdate">toolUpdate</a></code> | <code><a href="#mise-projen.SettingsToolUpdate">SettingsToolUpdate</a></code> | *No description.* |
5950
- | <code><a href="#mise-projen.Settings.property.trace">trace</a></code> | <code>boolean</code> | Sets log level to trace. |
6008
+ | <code><a href="#mise-projen.Settings.property.trace">trace</a></code> | <code>boolean</code> | Set the log level to trace. |
5951
6009
  | <code><a href="#mise-projen.Settings.property.truncate">truncate</a></code> | <code>boolean</code> | Truncate long terminal output to fit the available width. |
5952
- | <code><a href="#mise-projen.Settings.property.trustedConfigPaths">trustedConfigPaths</a></code> | <code>string[]</code> | This is a list of config paths that mise will automatically mark as trusted. |
5953
- | <code><a href="#mise-projen.Settings.property.unixDefaultFileShellArgs">unixDefaultFileShellArgs</a></code> | <code>string</code> | Default shell arguments for Unix to be used for file commands. |
5954
- | <code><a href="#mise-projen.Settings.property.unixDefaultInlineShellArgs">unixDefaultInlineShellArgs</a></code> | <code>string</code> | Default shell arguments for Unix to be used for inline commands. |
6010
+ | <code><a href="#mise-projen.Settings.property.trustedConfigPaths">trustedConfigPaths</a></code> | <code>string[]</code> | Directories whose config files mise trusts without asking. |
6011
+ | <code><a href="#mise-projen.Settings.property.unixDefaultFileShellArgs">unixDefaultFileShellArgs</a></code> | <code>string</code> | Shell that runs a file task on Unix when the task sets no `shell` and the file has no shebang or known extension. |
6012
+ | <code><a href="#mise-projen.Settings.property.unixDefaultInlineShellArgs">unixDefaultInlineShellArgs</a></code> | <code>string</code> | Shell and arguments that run inline scripts on Unix, such as a task's `run`, hooks and `postinstall`. |
5955
6013
  | <code><a href="#mise-projen.Settings.property.upgrade">upgrade</a></code> | <code><a href="#mise-projen.SettingsUpgrade">SettingsUpgrade</a></code> | *No description.* |
5956
- | <code><a href="#mise-projen.Settings.property.urlReplacements">urlReplacements</a></code> | <code>{[ key: string ]: string}</code> | Map of URL patterns to replacement URLs applied to all requests. |
5957
- | <code><a href="#mise-projen.Settings.property.useFileShellForExecutableTasks">useFileShellForExecutableTasks</a></code> | <code>boolean</code> | Determines whether to use a specified shell for executing tasks in the tasks directory. |
5958
- | <code><a href="#mise-projen.Settings.property.useVersionsHost">useVersionsHost</a></code> | <code>boolean</code> | Set to false to disable using the mise-versions API for version lists, public GitHub release metadata, and GitHub artifact attestations. |
5959
- | <code><a href="#mise-projen.Settings.property.useVersionsHostTrack">useVersionsHostTrack</a></code> | <code>boolean</code> | Send anonymous download statistics when installing tools. |
5960
- | <code><a href="#mise-projen.Settings.property.verbose">verbose</a></code> | <code>boolean</code> | Shows more verbose output such as installation logs when installing tools. |
5961
- | <code><a href="#mise-projen.Settings.property.windowsDefaultFileShellArgs">windowsDefaultFileShellArgs</a></code> | <code>string</code> | Default shell arguments for Windows to be used for file commands. |
5962
- | <code><a href="#mise-projen.Settings.property.windowsDefaultInlineShellArgs">windowsDefaultInlineShellArgs</a></code> | <code>string</code> | Default shell arguments for Windows to be used for inline commands. |
5963
- | <code><a href="#mise-projen.Settings.property.windowsExecutableExtensions">windowsExecutableExtensions</a></code> | <code>string[]</code> | List of executable extensions for Windows. |
5964
- | <code><a href="#mise-projen.Settings.property.windowsPowershellNoProfile">windowsPowershellNoProfile</a></code> | <code>boolean</code> | Pass `-NoProfile` to PowerShell (`pwsh`/`powershell`) shells that mise spawns for tasks and inline commands, so startup profiles are skipped. |
5965
- | <code><a href="#mise-projen.Settings.property.windowsShimMode">windowsShimMode</a></code> | <code>string</code> | Shim file mode for Windows. |
6014
+ | <code><a href="#mise-projen.Settings.property.urlReplacements">urlReplacements</a></code> | <code>{[ key: string ]: string}</code> | URL patterns and replacements that mise's HTTP client applies before sending a request, for mirrors and proxies. |
6015
+ | <code><a href="#mise-projen.Settings.property.useFileShellForExecutableTasks">useFileShellForExecutableTasks</a></code> | <code>boolean</code> | Run executable file tasks through a shell instead of executing them directly. |
6016
+ | <code><a href="#mise-projen.Settings.property.useVersionsHost">useVersionsHost</a></code> | <code>boolean</code> | Get version lists, public GitHub release metadata and attestations from mise-versions instead of upstream APIs. |
6017
+ | <code><a href="#mise-projen.Settings.property.useVersionsHostTrack">useVersionsHostTrack</a></code> | <code>boolean</code> | Send anonymous download statistics to mise-versions after installing a tool. |
6018
+ | <code><a href="#mise-projen.Settings.property.verbose">verbose</a></code> | <code>boolean</code> | Show extra output, such as installation logs, and set the log level to debug; |
6019
+ | <code><a href="#mise-projen.Settings.property.windowsDefaultFileShellArgs">windowsDefaultFileShellArgs</a></code> | <code>string</code> | Shell that runs a file task on Windows when the task sets no `shell` and the file has no shebang or known extension. |
6020
+ | <code><a href="#mise-projen.Settings.property.windowsDefaultInlineShellArgs">windowsDefaultInlineShellArgs</a></code> | <code>string</code> | Shell and arguments that run inline scripts on Windows, such as a task's `run`, hooks and `postinstall`. |
6021
+ | <code><a href="#mise-projen.Settings.property.windowsExecutableExtensions">windowsExecutableExtensions</a></code> | <code>string[]</code> | File extensions, without the dot, that mise treats as executable on Windows. |
6022
+ | <code><a href="#mise-projen.Settings.property.windowsPowershellNoProfile">windowsPowershellNoProfile</a></code> | <code>boolean</code> | Pass `-NoProfile` to the PowerShell (`pwsh` or `powershell`) that mise starts, so startup profiles are skipped. |
6023
+ | <code><a href="#mise-projen.Settings.property.windowsShimMode">windowsShimMode</a></code> | <code><a href="#mise-projen.SettingsWindowsShimMode">SettingsWindowsShimMode</a></code> | How mise creates shims on Windows. |
5966
6024
  | <code><a href="#mise-projen.Settings.property.writeTargets">writeTargets</a></code> | <code><a href="#mise-projen.SettingsWriteTargets">SettingsWriteTargets</a></code> | *No description.* |
5967
- | <code><a href="#mise-projen.Settings.property.yes">yes</a></code> | <code>boolean</code> | This will automatically answer yes or no to prompts. |
6025
+ | <code><a href="#mise-projen.Settings.property.yes">yes</a></code> | <code>boolean</code> | Answer yes to every confirmation prompt, as `--yes` does. |
5968
6026
  | <code><a href="#mise-projen.Settings.property.zig">zig</a></code> | <code><a href="#mise-projen.SettingsZig">SettingsZig</a></code> | *No description.* |
5969
6027
 
5970
6028
  ---
@@ -5977,7 +6035,7 @@ public readonly activateAggressive: boolean;
5977
6035
 
5978
6036
  - *Type:* boolean
5979
6037
 
5980
- Pushes tools' bin-paths to the front of PATH instead of allowing modifications of PATH after activation to take precedence.
6038
+ Keep mise's tool directories ahead of `PATH` entries added after `mise activate`.
5981
6039
 
5982
6040
  ---
5983
6041
 
@@ -5989,7 +6047,7 @@ public readonly activateShims: boolean;
5989
6047
 
5990
6048
  - *Type:* boolean
5991
6049
 
5992
- Allow full shell activation to add tool shims to PATH.
6050
+ Let `mise activate` add the shims directories to `PATH` for auto-install and lazy tools.
5993
6051
 
5994
6052
  ---
5995
6053
 
@@ -6011,7 +6069,7 @@ public readonly allCompile: boolean;
6011
6069
 
6012
6070
  - *Type:* boolean
6013
6071
 
6014
- do not use precompiled binaries for any tool.
6072
+ Compile Node.js, Python, Ruby and Erlang from source instead of using precompiled builds.
6015
6073
 
6016
6074
  ---
6017
6075
 
@@ -6023,7 +6081,7 @@ public readonly alwaysKeepDownload: boolean;
6023
6081
 
6024
6082
  - *Type:* boolean
6025
6083
 
6026
- keep downloaded files after installation for debugging.
6084
+ Keep downloaded archives and sources after installing, for debugging.
6027
6085
 
6028
6086
  ---
6029
6087
 
@@ -6035,7 +6093,7 @@ public readonly alwaysKeepInstall: boolean;
6035
6093
 
6036
6094
  - *Type:* boolean
6037
6095
 
6038
- should mise keep install files after installation even if the installation fails.
6096
+ Keep a failed installation's partial install directory and downloads, for debugging.
6039
6097
 
6040
6098
  ---
6041
6099
 
@@ -6057,7 +6115,7 @@ public readonly arch: string;
6057
6115
 
6058
6116
  - *Type:* string
6059
6117
 
6060
- Architecture to use for precompiled binaries.
6118
+ Architecture of the precompiled binaries mise downloads.
6061
6119
 
6062
6120
  ---
6063
6121
 
@@ -6069,7 +6127,7 @@ public readonly asdfCompat: boolean;
6069
6127
 
6070
6128
  - *Type:* boolean
6071
6129
 
6072
- set to true to ensure .tool-versions will be compatible with asdf.
6130
+ Write `.tool-versions` files that asdf can read, with exact versions.
6073
6131
 
6074
6132
  ---
6075
6133
 
@@ -6093,7 +6151,7 @@ public readonly autoInstall: boolean;
6093
6151
 
6094
6152
  - *Type:* boolean
6095
6153
 
6096
- Automatically install missing tools when running `mise x`, `mise run`, or as part of the 'not found' handler.
6154
+ Install missing tools automatically when a command needs them.
6097
6155
 
6098
6156
  ---
6099
6157
 
@@ -6105,7 +6163,7 @@ public readonly autoInstallDisableTools: string[];
6105
6163
 
6106
6164
  - *Type:* string[]
6107
6165
 
6108
- List of tools to skip automatically installing when running `mise x`, `mise run`, or as part of the 'not found' handler.
6166
+ Tools that automatic installs skip, such as `node`.
6109
6167
 
6110
6168
  ---
6111
6169
 
@@ -6117,7 +6175,7 @@ public readonly autoUpdate: boolean;
6117
6175
 
6118
6176
  - *Type:* boolean
6119
6177
 
6120
- [deprecated] Use `self_update.auto` instead.
6178
+ [deprecated] Old name for `self_update.auto`.
6121
6179
 
6122
6180
  ---
6123
6181
 
@@ -6129,7 +6187,7 @@ public readonly autoUpdateCheckDuration: string;
6129
6187
 
6130
6188
  - *Type:* string
6131
6189
 
6132
- [deprecated] Use `self_update.check_duration` instead.
6190
+ [deprecated] Old name for `self_update.check_duration`.
6133
6191
 
6134
6192
  ---
6135
6193
 
@@ -6141,7 +6199,7 @@ public readonly cachePruneAge: string;
6141
6199
 
6142
6200
  - *Type:* string
6143
6201
 
6144
- Delete files in cache that have not been accessed in this duration.
6202
+ Delete cache files that have not been accessed for this long.
6145
6203
 
6146
6204
  ---
6147
6205
 
@@ -6163,7 +6221,7 @@ public readonly cd: string;
6163
6221
 
6164
6222
  - *Type:* string
6165
6223
 
6166
- Path to change to after launching mise.
6224
+ Directory to change to after mise starts.
6167
6225
 
6168
6226
  ---
6169
6227
 
@@ -6175,7 +6233,7 @@ public readonly ceilingPaths: string[];
6175
6233
 
6176
6234
  - *Type:* string[]
6177
6235
 
6178
- Directories where mise stops searching for config files.
6236
+ Directories where mise stops searching parent directories for config files.
6179
6237
 
6180
6238
  ---
6181
6239
 
@@ -6187,7 +6245,9 @@ public readonly ci: boolean;
6187
6245
 
6188
6246
  - *Type:* boolean
6189
6247
 
6190
- Set to true if running in a CI environment.
6248
+ Behave as in CI, which answers yes to confirmation prompts;
6249
+
6250
+ read from the `CI` variable.
6191
6251
 
6192
6252
  ---
6193
6253
 
@@ -6199,7 +6259,7 @@ public readonly color: boolean;
6199
6259
 
6200
6260
  - *Type:* boolean
6201
6261
 
6202
- Use color in mise terminal output.
6262
+ Use color in mise's terminal output.
6203
6263
 
6204
6264
  ---
6205
6265
 
@@ -6211,7 +6271,7 @@ public readonly colorTheme: SettingsColorTheme;
6211
6271
 
6212
6272
  - *Type:* <a href="#mise-projen.SettingsColorTheme">SettingsColorTheme</a>
6213
6273
 
6214
- Theme for interactive prompts (auto/default, charm, base16, catppuccin, dracula).
6274
+ Color theme for interactive prompts, such as the task picker in `mise run`.
6215
6275
 
6216
6276
  ---
6217
6277
 
@@ -6233,7 +6293,7 @@ public readonly debug: boolean;
6233
6293
 
6234
6294
  - *Type:* boolean
6235
6295
 
6236
- Sets log level to debug.
6296
+ Set the log level to debug.
6237
6297
 
6238
6298
  ---
6239
6299
 
@@ -6245,9 +6305,7 @@ public readonly defaultConfigFilename: string;
6245
6305
 
6246
6306
  - *Type:* string
6247
6307
 
6248
- The default config filename read.
6249
-
6250
- `mise use` and other commands that create new config files will use this value. This must be an env var.
6308
+ Extra project config filename mise reads, and the name it gives new config files.
6251
6309
 
6252
6310
  ---
6253
6311
 
@@ -6259,7 +6317,7 @@ public readonly defaultToolVersionsFilename: string;
6259
6317
 
6260
6318
  - *Type:* string
6261
6319
 
6262
- 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.
6320
+ Extra filename mise reads as a `.tool-versions` file.
6263
6321
 
6264
6322
  ---
6265
6323
 
@@ -6271,9 +6329,7 @@ public readonly disableBackends: string[];
6271
6329
 
6272
6330
  - *Type:* string[]
6273
6331
 
6274
- Backends to exclude from tool resolution and new installs, such as `asdf`, `pypi`, or a vfox-backend plugin name.
6275
-
6276
- Existing installations are left on disk and become available again if the backend is re-enabled.
6332
+ Backends mise ignores when resolving and installing tools, such as `asdf` or `pypi`.
6277
6333
 
6278
6334
  ---
6279
6335
 
@@ -6285,9 +6341,7 @@ public readonly disableDefaultRegistry: boolean;
6285
6341
 
6286
6342
  - *Type:* boolean
6287
6343
 
6288
- Disable the default mapping of short tool names like `php` -> `asdf:mise-plugins/asdf-php`.
6289
-
6290
- This parameter disables only for the backends `vfox` and `asdf`.
6344
+ Stop mapping short names such as `php` to the asdf and vfox plugins listed in the registry.
6291
6345
 
6292
6346
  ---
6293
6347
 
@@ -6299,7 +6353,9 @@ public readonly disableHints: string[];
6299
6353
 
6300
6354
  - *Type:* string[]
6301
6355
 
6302
- Turns off helpful hints when using different mise features.
6356
+ Hints to stop showing, by ID;
6357
+
6358
+ `*` turns off every hint.
6303
6359
 
6304
6360
  ---
6305
6361
 
@@ -6311,7 +6367,7 @@ public readonly disableTools: string[];
6311
6367
 
6312
6368
  - *Type:* string[]
6313
6369
 
6314
- Tools defined in mise.toml that should be ignored.
6370
+ Tools mise ignores even when a config file lists them.
6315
6371
 
6316
6372
  ---
6317
6373
 
@@ -6355,7 +6411,9 @@ public readonly enableTools: string[];
6355
6411
 
6356
6412
  - *Type:* string[]
6357
6413
 
6358
- Tools defined in mise.toml that should be used; unset enables all tools and empty disables all tools.
6414
+ Allowlist of configured tools mise uses;
6415
+
6416
+ other tools are ignored.
6359
6417
 
6360
6418
  ---
6361
6419
 
@@ -6367,7 +6425,7 @@ public readonly env: string[];
6367
6425
 
6368
6426
  - *Type:* string[]
6369
6427
 
6370
- Env to use for mise.<MISE_ENV>.toml files.
6428
+ Config environments to load, such as `development` for `mise.development.toml`.
6371
6429
 
6372
6430
  ---
6373
6431
 
@@ -6379,7 +6437,7 @@ public readonly envCache: boolean;
6379
6437
 
6380
6438
  - *Type:* boolean
6381
6439
 
6382
- [experimental] Enable environment caching for nested mise invocations.
6440
+ [experimental] Cache computed environments on disk for nested mise commands.
6383
6441
 
6384
6442
  ---
6385
6443
 
@@ -6391,7 +6449,7 @@ public readonly envCacheTtl: string;
6391
6449
 
6392
6450
  - *Type:* string
6393
6451
 
6394
- TTL for cached environments.
6452
+ How long a cached environment stays valid.
6395
6453
 
6396
6454
  ---
6397
6455
 
@@ -6415,7 +6473,7 @@ public readonly envFile: string;
6415
6473
 
6416
6474
  - *Type:* string
6417
6475
 
6418
- Path to a file containing environment variables to automatically load.
6476
+ Dotenv file name to load from the current directory and each parent directory.
6419
6477
 
6420
6478
  ---
6421
6479
 
@@ -6427,7 +6485,7 @@ public readonly envShellExpand: boolean;
6427
6485
 
6428
6486
  - *Type:* boolean
6429
6487
 
6430
- Controls shell-style variable expansion in env values (e.g., $FOO, ${BAR:-default}).
6488
+ Expand shell-style variables such as `$FOO` and `${BAR:-default}` in `[env]` values.
6431
6489
 
6432
6490
  ---
6433
6491
 
@@ -6449,7 +6507,7 @@ public readonly execAutoInstall: boolean;
6449
6507
 
6450
6508
  - *Type:* boolean
6451
6509
 
6452
- Automatically install missing tools when running `mise x`.
6510
+ Install missing tools automatically when you run `mise exec`.
6453
6511
 
6454
6512
  ---
6455
6513
 
@@ -6461,7 +6519,7 @@ public readonly experimental: boolean;
6461
6519
 
6462
6520
  - *Type:* boolean
6463
6521
 
6464
- Enable experimental mise features which are incomplete or unstable—breakings changes may occur.
6522
+ Enable experimental features, which may change or be removed in any release.
6465
6523
 
6466
6524
  ---
6467
6525
 
@@ -6473,7 +6531,7 @@ public readonly fetchRemoteVersionsCache: string;
6473
6531
 
6474
6532
  - *Type:* string
6475
6533
 
6476
- How long to cache remote versions for tools.
6534
+ How long a tool's cached list of available versions stays fresh.
6477
6535
 
6478
6536
  ---
6479
6537
 
@@ -6485,7 +6543,7 @@ public readonly fetchRemoteVersionsTimeout: string;
6485
6543
 
6486
6544
  - *Type:* string
6487
6545
 
6488
- Timeout in seconds for HTTP requests to fetch new tool versions in mise.
6546
+ Timeout for looking up a tool's available versions.
6489
6547
 
6490
6548
  ---
6491
6549
 
@@ -6517,7 +6575,7 @@ public readonly githubAttestations: boolean;
6517
6575
 
6518
6576
  - *Type:* boolean
6519
6577
 
6520
- Enable GitHub Artifact Attestations verification for supported tools.
6578
+ Verify GitHub artifact attestations for downloads whose publisher provides them.
6521
6579
 
6522
6580
  ---
6523
6581
 
@@ -6549,7 +6607,7 @@ public readonly gix: boolean;
6549
6607
 
6550
6608
  - *Type:* boolean
6551
6609
 
6552
- Use gix for git operations, set to false to shell out to git.
6610
+ Clone Git repositories with the built-in gix library instead of running `git`.
6553
6611
 
6554
6612
  ---
6555
6613
 
@@ -6560,11 +6618,8 @@ public readonly globalConfigFile: string;
6560
6618
  ```
6561
6619
 
6562
6620
  - *Type:* string
6563
- - *Default:* config/mise/config.toml`. This must be an env var.
6564
6621
 
6565
- Path to the global mise config file.
6566
-
6567
- Default is `~/.config/mise/config.toml`. This must be an env var.
6622
+ One file to use as the global config instead of the config files in `~/.config/mise`.
6568
6623
 
6569
6624
  ---
6570
6625
 
@@ -6575,11 +6630,8 @@ public readonly globalConfigRoot: string;
6575
6630
  ```
6576
6631
 
6577
6632
  - *Type:* string
6578
- - *Default:* HOME`. This must be an env var.
6579
-
6580
- Path which is used as `{{config_root}}` for the global config file.
6581
6633
 
6582
- Default is `$HOME`. This must be an env var.
6634
+ Directory used as `config_root` for the global config, such as for `{{config_root}}` in templates.
6583
6635
 
6584
6636
  ---
6585
6637
 
@@ -6601,7 +6653,7 @@ public readonly goDefaultPackagesFile: string;
6601
6653
 
6602
6654
  - *Type:* string
6603
6655
 
6604
- Path to a file containing default go packages to install when installing go.
6656
+ File listing Go packages to install with every Go version.
6605
6657
 
6606
6658
  ---
6607
6659
 
@@ -6613,7 +6665,7 @@ public readonly goDownloadMirror: string;
6613
6665
 
6614
6666
  - *Type:* string
6615
6667
 
6616
- Mirror to download go sdk tarballs from.
6668
+ Base URL that mise downloads Go archives and their checksums from.
6617
6669
 
6618
6670
  ---
6619
6671
 
@@ -6625,7 +6677,7 @@ public readonly goRepo: string;
6625
6677
 
6626
6678
  - *Type:* string
6627
6679
 
6628
- URL to fetch go from.
6680
+ Git repository mise lists Go versions from.
6629
6681
 
6630
6682
  ---
6631
6683
 
@@ -6637,7 +6689,7 @@ public readonly goSetGobin: boolean;
6637
6689
 
6638
6690
  - *Type:* boolean
6639
6691
 
6640
- Changes where `go install` installs binaries to.
6692
+ Set `GOBIN` so `go install` puts binaries in the active Go version's directory.
6641
6693
 
6642
6694
  ---
6643
6695
 
@@ -6649,7 +6701,7 @@ public readonly goSetGopath: boolean;
6649
6701
 
6650
6702
  - *Type:* boolean
6651
6703
 
6652
- [deprecated] Set to true to set GOPATH=~/.local/share/mise/installs/go/.../packages.
6704
+ [deprecated] Set `GOPATH` to the `packages` directory inside the active Go install.
6653
6705
 
6654
6706
  ---
6655
6707
 
@@ -6661,7 +6713,7 @@ public readonly goSetGoroot: boolean;
6661
6713
 
6662
6714
  - *Type:* boolean
6663
6715
 
6664
- Sets GOROOT=~/.local/share/mise/installs/go/.../.
6716
+ Set `GOROOT` to the active Go version's install directory.
6665
6717
 
6666
6718
  ---
6667
6719
 
@@ -6673,7 +6725,7 @@ public readonly goSkipChecksum: boolean;
6673
6725
 
6674
6726
  - *Type:* boolean
6675
6727
 
6676
- Set to true to skip checksum verification when downloading go sdk tarballs.
6728
+ Skip SHA-256 verification of Go downloads.
6677
6729
 
6678
6730
  ---
6679
6731
 
@@ -6685,9 +6737,7 @@ public readonly gpgVerify: boolean;
6685
6737
 
6686
6738
  - *Type:* boolean
6687
6739
 
6688
- Verify OpenPGP signatures for all tools (built-in, no external gpg required).
6689
-
6690
- Set to false to disable.
6740
+ Verify OpenPGP signatures of Node.js and Swift downloads.
6691
6741
 
6692
6742
  ---
6693
6743
 
@@ -6719,7 +6769,7 @@ public readonly httpDownloadTimeout: string;
6719
6769
 
6720
6770
  - *Type:* string
6721
6771
 
6722
- Total time allowed for an HTTP download, including retries.
6772
+ Total time allowed to download one file, including retries.
6723
6773
 
6724
6774
  ---
6725
6775
 
@@ -6731,7 +6781,7 @@ public readonly httpRetries: number;
6731
6781
 
6732
6782
  - *Type:* number
6733
6783
 
6734
- Number of retries for transient HTTP failures in mise.
6784
+ Number of retries after a transient HTTP failure.
6735
6785
 
6736
6786
  ---
6737
6787
 
@@ -6755,7 +6805,9 @@ public readonly idiomaticVersionFile: boolean;
6755
6805
 
6756
6806
  - *Type:* boolean
6757
6807
 
6758
- Set to false to disable the idiomatic version files such as .node-version, .ruby-version, etc.
6808
+ [deprecated] No effect;
6809
+
6810
+ enable idiomatic version files per tool with `idiomatic_version_file_enable_tools`.
6759
6811
 
6760
6812
  ---
6761
6813
 
@@ -6767,7 +6819,7 @@ public readonly idiomaticVersionFileDisableFiles: string[];
6767
6819
 
6768
6820
  - *Type:* string[]
6769
6821
 
6770
- Specific idiomatic version files to disable for a tool.
6822
+ Idiomatic version files to ignore for one tool, as `tool:filename` pairs.
6771
6823
 
6772
6824
  ---
6773
6825
 
@@ -6779,7 +6831,9 @@ public readonly idiomaticVersionFileDisableTools: string[];
6779
6831
 
6780
6832
  - *Type:* string[]
6781
6833
 
6782
- Specific tools to disable idiomatic version files for.
6834
+ [deprecated] No effect;
6835
+
6836
+ idiomatic version files are off unless enabled with `idiomatic_version_file_enable_tools`.
6783
6837
 
6784
6838
  ---
6785
6839
 
@@ -6791,7 +6845,7 @@ public readonly idiomaticVersionFileEnableTools: string[];
6791
6845
 
6792
6846
  - *Type:* string[]
6793
6847
 
6794
- Specific tools to enable idiomatic version files for like .node-version, .ruby-version, etc.
6848
+ Tools that read idiomatic version files such as `.node-version` or `.ruby-version`.
6795
6849
 
6796
6850
  ---
6797
6851
 
@@ -6815,7 +6869,7 @@ public readonly ignoredConfigPaths: string[];
6815
6869
 
6816
6870
  - *Type:* string[]
6817
6871
 
6818
- This is a list of config paths that mise will ignore.
6872
+ Config files and directories mise does not load.
6819
6873
 
6820
6874
  ---
6821
6875
 
@@ -6827,7 +6881,9 @@ public readonly installBefore: string;
6827
6881
 
6828
6882
  - *Type:* string
6829
6883
 
6830
- Minimum release age / supply chain protection — only install versions released before this date.
6884
+ [deprecated] Install only versions released before this date;
6885
+
6886
+ use `minimum_release_age` instead.
6831
6887
 
6832
6888
  ---
6833
6889
 
@@ -6875,7 +6931,9 @@ public readonly legacyVersionFile: boolean;
6875
6931
 
6876
6932
  - *Type:* boolean
6877
6933
 
6878
- Set to false to disable the idiomatic version files such as .node-version, .ruby-version, etc.
6934
+ [deprecated] No effect;
6935
+
6936
+ enable idiomatic version files per tool with `idiomatic_version_file_enable_tools`.
6879
6937
 
6880
6938
  ---
6881
6939
 
@@ -6887,7 +6945,9 @@ public readonly legacyVersionFileDisableTools: string[];
6887
6945
 
6888
6946
  - *Type:* string[]
6889
6947
 
6890
- Specific tools to disable idiomatic version files for.
6948
+ [deprecated] No effect;
6949
+
6950
+ idiomatic version files are off unless enabled with `idiomatic_version_file_enable_tools`.
6891
6951
 
6892
6952
  ---
6893
6953
 
@@ -6899,7 +6959,7 @@ public readonly libc: SettingsLibc;
6899
6959
 
6900
6960
  - *Type:* <a href="#mise-projen.SettingsLibc">SettingsLibc</a>
6901
6961
 
6902
- Libc implementation to use for precompiled Linux binaries.
6962
+ Libc build to install on Linux when a tool publishes both glibc and musl builds.
6903
6963
 
6904
6964
  ---
6905
6965
 
@@ -6911,7 +6971,9 @@ public readonly libgit2: boolean;
6911
6971
 
6912
6972
  - *Type:* boolean
6913
6973
 
6914
- Use libgit2 for git operations, set to false to shell out to git.
6974
+ Clone Git repositories with the built-in gix library instead of running `git`;
6975
+
6976
+ same as `gix`.
6915
6977
 
6916
6978
  ---
6917
6979
 
@@ -6923,7 +6985,7 @@ public readonly locked: boolean;
6923
6985
 
6924
6986
  - *Type:* boolean
6925
6987
 
6926
- Require lockfile URLs to be present during installation.
6988
+ Require tool versions and download URLs to come from the lockfile.
6927
6989
 
6928
6990
  ---
6929
6991
 
@@ -6947,7 +7009,7 @@ public readonly lockedVerifyProvenance: boolean;
6947
7009
 
6948
7010
  - *Type:* boolean
6949
7011
 
6950
- Re-verify provenance at install time even when the lockfile already has provenance.
7012
+ Re-verify provenance at install time even when the lockfile already records it.
6951
7013
 
6952
7014
  ---
6953
7015
 
@@ -6959,7 +7021,7 @@ public readonly lockfile: boolean;
6959
7021
 
6960
7022
  - *Type:* boolean
6961
7023
 
6962
- Create and read lockfiles for tool versions.
7024
+ Create, read and update `mise.lock` lockfiles for tool versions.
6963
7025
 
6964
7026
  ---
6965
7027
 
@@ -6983,7 +7045,7 @@ public readonly lockfileMode: SettingsLockfileMode;
6983
7045
 
6984
7046
  - *Type:* <a href="#mise-projen.SettingsLockfileMode">SettingsLockfileMode</a>
6985
7047
 
6986
- Choose incremental merging or complete lockfile generation.
7048
+ How lockfiles are written: entry by entry, or rebuilt from the current requests.
6987
7049
 
6988
7050
  ---
6989
7051
 
@@ -6995,7 +7057,7 @@ public readonly lockfilePlatforms: string[];
6995
7057
 
6996
7058
  - *Type:* string[]
6997
7059
 
6998
- Platforms to target in lockfile operations.
7060
+ Platforms to resolve lockfile URLs and checksums for.
6999
7061
 
7000
7062
  ---
7001
7063
 
@@ -7007,7 +7069,7 @@ public readonly logLevel: SettingsLogLevel;
7007
7069
 
7008
7070
  - *Type:* <a href="#mise-projen.SettingsLogLevel">SettingsLogLevel</a>
7009
7071
 
7010
- Show more/less output.
7072
+ Log level for mise's own output.
7011
7073
 
7012
7074
  ---
7013
7075
 
@@ -7019,7 +7081,7 @@ public readonly minimumReleaseAge: string;
7019
7081
 
7020
7082
  - *Type:* string
7021
7083
 
7022
- Minimum release age / supply chain protection — only install versions older than this threshold.
7084
+ Skip versions published more recently than this duration or date.
7023
7085
 
7024
7086
  ---
7025
7087
 
@@ -7031,7 +7093,7 @@ public readonly minimumReleaseAgeExcludes: string[];
7031
7093
 
7032
7094
  - *Type:* string[]
7033
7095
 
7034
- Tools and backends to exclude from the global/default minimum_release_age setting.
7096
+ Tools and backends that the configured and default `minimum_release_age` do not apply to.
7035
7097
 
7036
7098
  ---
7037
7099
 
@@ -7055,7 +7117,7 @@ public readonly netrcFile: string;
7055
7117
 
7056
7118
  - *Type:* string
7057
7119
 
7058
- Path to the netrc file to use for HTTP Basic authentication.
7120
+ Path of the netrc file to use instead of `~/.netrc` (`%USERPROFILE%\_netrc` on Windows).
7059
7121
 
7060
7122
  ---
7061
7123
 
@@ -7101,7 +7163,7 @@ public readonly notFoundAutoInstall: boolean;
7101
7163
 
7102
7164
  - *Type:* boolean
7103
7165
 
7104
- Set to false to disable the "command not found" handler to autoinstall missing tool versions.
7166
+ Install the tool that provides a command when your shell cannot find that command.
7105
7167
 
7106
7168
  ---
7107
7169
 
@@ -7113,7 +7175,7 @@ public readonly notFoundAutoInstallRegistry: boolean;
7113
7175
 
7114
7176
  - *Type:* boolean
7115
7177
 
7116
- Automatically install an unconfigured tool when its registry bin matches a missing command.
7178
+ Install an unconfigured tool when exactly one registry entry provides a command your shell cannot find.
7117
7179
 
7118
7180
  ---
7119
7181
 
@@ -7125,7 +7187,7 @@ public readonly notFoundSystemFallback: boolean;
7125
7187
 
7126
7188
  - *Type:* boolean
7127
7189
 
7128
- Set to false to stop shims from falling back to a same-named binary found elsewhere on PATH.
7190
+ Let a shim run a same-named executable from elsewhere on `PATH` when mise cannot resolve the tool.
7129
7191
 
7130
7192
  ---
7131
7193
 
@@ -7157,9 +7219,7 @@ public readonly offline: boolean;
7157
7219
 
7158
7220
  - *Type:* boolean
7159
7221
 
7160
- Disable all HTTP requests.
7161
-
7162
- Tools will only use locally cached data.
7222
+ Block every HTTP request, so mise uses only installed tools and cached data.
7163
7223
 
7164
7224
  ---
7165
7225
 
@@ -7171,7 +7231,7 @@ public readonly os: string;
7171
7231
 
7172
7232
  - *Type:* string
7173
7233
 
7174
- OS to use for precompiled binaries.
7234
+ Operating system of the precompiled binaries mise downloads.
7175
7235
 
7176
7236
  ---
7177
7237
 
@@ -7193,7 +7253,7 @@ public readonly overrideConfigFilenames: string[];
7193
7253
 
7194
7254
  - *Type:* string[]
7195
7255
 
7196
- If set, mise will ignore default config files like `mise.toml` and use these filenames instead.
7256
+ Project config filenames that mise looks for instead of `mise.toml`, `.mise.toml` and the other standard names.
7197
7257
 
7198
7258
  ---
7199
7259
 
@@ -7205,7 +7265,7 @@ public readonly overrideToolVersionsFilenames: string[];
7205
7265
 
7206
7266
  - *Type:* string[]
7207
7267
 
7208
- If set, mise will ignore .tool-versions files and use these filenames instead. Can be set to `none` to disable .tool-versions.
7268
+ Filenames that mise reads as `.tool-versions` files instead of `.tool-versions`.
7209
7269
 
7210
7270
  ---
7211
7271
 
@@ -7227,7 +7287,7 @@ public readonly paranoid: boolean;
7227
7287
 
7228
7288
  - *Type:* boolean
7229
7289
 
7230
- Enables extra-secure behavior.
7290
+ Require explicit, content-bound trust for project config, and re-verify provenance on every install.
7231
7291
 
7232
7292
  ---
7233
7293
 
@@ -7238,9 +7298,8 @@ public readonly pin: boolean;
7238
7298
  ```
7239
7299
 
7240
7300
  - *Type:* boolean
7241
- - *Default:* pinning versions when running `mise use` in mise.toml files.
7242
7301
 
7243
- Default to pinning versions when running `mise use` in mise.toml files.
7302
+ Make `mise use` write the resolved version, such as `24.14.0` for `node@24`, instead of the requested one.
7244
7303
 
7245
7304
  ---
7246
7305
 
@@ -7262,7 +7321,9 @@ public readonly pluginAutoupdateLastCheckDuration: string;
7262
7321
 
7263
7322
  - *Type:* string
7264
7323
 
7265
- How long to wait before updating plugins automatically (note this isn't currently implemented).
7324
+ [deprecated] Has no effect;
7325
+
7326
+ it was never implemented.
7266
7327
 
7267
7328
  ---
7268
7329
 
@@ -7274,7 +7335,7 @@ public readonly preferOffline: boolean;
7274
7335
 
7275
7336
  - *Type:* boolean
7276
7337
 
7277
- Prefer locally cached data over remote fetches when possible.
7338
+ Use cached version lists instead of fetching new ones, and go to the network only when nothing is cached.
7278
7339
 
7279
7340
  ---
7280
7341
 
@@ -7286,7 +7347,7 @@ public readonly prereleases: boolean;
7286
7347
 
7287
7348
  - *Type:* boolean
7288
7349
 
7289
- Include pre-release versions in `ls-remote`, `latest` resolution, and fuzzy matching for all tools.
7350
+ Include prereleases in `mise ls-remote`, `latest` and prefix matching for every tool.
7290
7351
 
7291
7352
  ---
7292
7353
 
@@ -7298,7 +7359,9 @@ public readonly profile: string;
7298
7359
 
7299
7360
  - *Type:* string
7300
7361
 
7301
- Profile to use for mise.${MISE_PROFILE}.toml files.
7362
+ Older name for the `env` setting;
7363
+
7364
+ use `MISE_ENV` instead.
7302
7365
 
7303
7366
  ---
7304
7367
 
@@ -7310,7 +7373,7 @@ public readonly provenanceApiFailuresFatal: boolean;
7310
7373
 
7311
7374
  - *Type:* boolean
7312
7375
 
7313
- Fail when provenance API checks cannot be completed.
7376
+ Fail an install when a provenance API, such as GitHub's attestation API, cannot be reached or queried.
7314
7377
 
7315
7378
  ---
7316
7379
 
@@ -7352,7 +7415,9 @@ public readonly quiet: boolean;
7352
7415
 
7353
7416
  - *Type:* boolean
7354
7417
 
7355
- Suppress all output except errors.
7418
+ Hide mise's own non-error messages, such as progress and task headers;
7419
+
7420
+ same as `--quiet`.
7356
7421
 
7357
7422
  ---
7358
7423
 
@@ -7364,7 +7429,7 @@ public readonly raw: boolean;
7364
7429
 
7365
7430
  - *Type:* boolean
7366
7431
 
7367
- Connect stdin/stdout/stderr to child processes.
7432
+ Connect tasks and install commands directly to the terminal's stdin, stdout and stderr.
7368
7433
 
7369
7434
  ---
7370
7435
 
@@ -7376,7 +7441,7 @@ public readonly registryCacheTtl: string;
7376
7441
 
7377
7442
  - *Type:* string
7378
7443
 
7379
- How long to cache the floating mise registry.
7444
+ How long a downloaded mise registry stays fresh when `registry_floating` is on.
7380
7445
 
7381
7446
  ---
7382
7447
 
@@ -7388,7 +7453,7 @@ public readonly registryFloating: boolean;
7388
7453
 
7389
7454
  - *Type:* boolean
7390
7455
 
7391
- Fetch the latest released mise registry and current aqua registry instead of using only the snapshots baked into this mise release.
7456
+ Use the latest released mise registry and the current aqua registry, not only the copies built into mise.
7392
7457
 
7393
7458
  ---
7394
7459
 
@@ -7420,7 +7485,7 @@ public readonly safe: boolean;
7420
7485
 
7421
7486
  - *Type:* boolean
7422
7487
 
7423
- Prevent project configuration from executing code during config loading and version resolution.
7488
+ Load project config without letting it run code or change the environment, for automation that reads untrusted config.
7424
7489
 
7425
7490
  ---
7426
7491
 
@@ -7452,7 +7517,7 @@ public readonly sharedInstallDirs: string[];
7452
7517
 
7453
7518
  - *Type:* string[]
7454
7519
 
7455
- Additional read-only directories to search for installed tool versions.
7520
+ Extra read-only directories that mise searches for installed tool versions.
7456
7521
 
7457
7522
  ---
7458
7523
 
@@ -7474,7 +7539,7 @@ public readonly shimsDir: string;
7474
7539
 
7475
7540
  - *Type:* string
7476
7541
 
7477
- Directory containing user shims.
7542
+ Directory where mise writes user shims.
7478
7543
 
7479
7544
  ---
7480
7545
 
@@ -7486,7 +7551,9 @@ public readonly shorthandsFile: string;
7486
7551
 
7487
7552
  - *Type:* string
7488
7553
 
7489
- [deprecated] Path to a file containing custom tool shorthands.
7554
+ [deprecated] File of custom tool shorthands;
7555
+
7556
+ use `[plugins]` instead.
7490
7557
 
7491
7558
  ---
7492
7559
 
@@ -7498,7 +7565,9 @@ public readonly silent: boolean;
7498
7565
 
7499
7566
  - *Type:* boolean
7500
7567
 
7501
- Suppress all `mise run|watch` output except errors—including what tasks output.
7568
+ Hide all output from `mise run` and `mise watch`, including what tasks print, except errors;
7569
+
7570
+ same as `--silent`.
7502
7571
 
7503
7572
  ---
7504
7573
 
@@ -7520,7 +7589,7 @@ public readonly slsa: boolean;
7520
7589
 
7521
7590
  - *Type:* boolean
7522
7591
 
7523
- Enable SLSA provenance verification globally.
7592
+ Verify SLSA provenance of downloads whose publisher provides it.
7524
7593
 
7525
7594
  ---
7526
7595
 
@@ -7571,11 +7640,8 @@ public readonly systemConfigFile: string;
7571
7640
  ```
7572
7641
 
7573
7642
  - *Type:* string
7574
- - *Default:* etc/mise/config.toml`. This must be an env var.
7575
7643
 
7576
- Path to the system mise config file.
7577
-
7578
- Default is `/etc/mise/config.toml`. This must be an env var.
7644
+ One file to use as the system config instead of the config files in `/etc/mise`.
7579
7645
 
7580
7646
  ---
7581
7647
 
@@ -7587,7 +7653,7 @@ public readonly systemDeps: SettingsSystemDeps;
7587
7653
 
7588
7654
  - *Type:* <a href="#mise-projen.SettingsSystemDeps">SettingsSystemDeps</a>
7589
7655
 
7590
- How to handle a plugin's declared system dependencies before installing a tool.
7656
+ What mise does when a plugin's declared system dependencies are missing before it installs a tool.
7591
7657
 
7592
7658
  ---
7593
7659
 
@@ -7599,7 +7665,7 @@ public readonly systemInstallsDir: string;
7599
7665
 
7600
7666
  - *Type:* string
7601
7667
 
7602
- Directory containing system tool installs.
7668
+ Directory that `mise install --system` installs into.
7603
7669
 
7604
7670
  ---
7605
7671
 
@@ -7621,7 +7687,7 @@ public readonly systemShimsDir: string;
7621
7687
 
7622
7688
  - *Type:* string
7623
7689
 
7624
- Directory containing system shims.
7690
+ Directory where `mise reshim --system` writes shims for system installs.
7625
7691
 
7626
7692
  ---
7627
7693
 
@@ -7643,7 +7709,7 @@ public readonly taskDisablePaths: string[];
7643
7709
 
7644
7710
  - *Type:* string[]
7645
7711
 
7646
- Paths that mise will not look for tasks in.
7712
+ Deprecated alias for `task.disable_paths`.
7647
7713
 
7648
7714
  ---
7649
7715
 
@@ -7655,7 +7721,7 @@ public readonly taskOutput: string;
7655
7721
 
7656
7722
  - *Type:* string
7657
7723
 
7658
- Change output style when executing tasks.
7724
+ Deprecated alias for `task.output`.
7659
7725
 
7660
7726
  ---
7661
7727
 
@@ -7667,7 +7733,7 @@ public readonly taskRemoteNoCache: boolean;
7667
7733
 
7668
7734
  - *Type:* boolean
7669
7735
 
7670
- Mise will always fetch the latest tasks from the remote, by default the cache is used.
7736
+ Deprecated alias for `task.remote_no_cache`.
7671
7737
 
7672
7738
  ---
7673
7739
 
@@ -7679,7 +7745,7 @@ public readonly taskRunAutoInstall: boolean;
7679
7745
 
7680
7746
  - *Type:* boolean
7681
7747
 
7682
- Automatically install missing tools when executing tasks.
7748
+ Deprecated alias for `task.run_auto_install`.
7683
7749
 
7684
7750
  ---
7685
7751
 
@@ -7691,9 +7757,7 @@ public readonly taskShowFullCmd: boolean;
7691
7757
 
7692
7758
  - *Type:* boolean
7693
7759
 
7694
- Disable truncation of command lines in task execution output.
7695
-
7696
- When true, the full command line will be shown.
7760
+ Deprecated alias for `task.show_full_cmd`.
7697
7761
 
7698
7762
  ---
7699
7763
 
@@ -7705,7 +7769,7 @@ public readonly taskSkip: string[];
7705
7769
 
7706
7770
  - *Type:* string[]
7707
7771
 
7708
- Tasks to skip when running `mise run`.
7772
+ Deprecated alias for `task.skip`.
7709
7773
 
7710
7774
  ---
7711
7775
 
@@ -7717,7 +7781,7 @@ public readonly taskSkipDepends: boolean;
7717
7781
 
7718
7782
  - *Type:* boolean
7719
7783
 
7720
- Run only specified tasks skipping all dependencies.
7784
+ Deprecated alias for `task.skip_depends`.
7721
7785
 
7722
7786
  ---
7723
7787
 
@@ -7729,9 +7793,7 @@ public readonly taskTimeout: string;
7729
7793
 
7730
7794
  - *Type:* string
7731
7795
 
7732
- Default timeout for tasks.
7733
-
7734
- Can be overridden by individual tasks.
7796
+ Deprecated alias for `task.timeout`.
7735
7797
 
7736
7798
  ---
7737
7799
 
@@ -7743,9 +7805,7 @@ public readonly taskTimings: boolean;
7743
7805
 
7744
7806
  - *Type:* boolean
7745
7807
 
7746
- Show completion message with elapsed time for each task on `mise run`.
7747
-
7748
- Default shows when output type is `prefix`.
7808
+ Deprecated alias for `task.timings`.
7749
7809
 
7750
7810
  ---
7751
7811
 
@@ -7757,7 +7817,7 @@ public readonly teraV1: boolean;
7757
7817
 
7758
7818
  - *Type:* boolean
7759
7819
 
7760
- Use Tera v1 instead of Tera v2 for template rendering.
7820
+ [deprecated] Render templates with Tera v1 instead of Tera v2.
7761
7821
 
7762
7822
  ---
7763
7823
 
@@ -7769,7 +7829,7 @@ public readonly terminalProgress: boolean;
7769
7829
 
7770
7830
  - *Type:* boolean
7771
7831
 
7772
- Enable terminal progress indicators (OSC 9;4) for compatible terminals.
7832
+ Show install progress in the terminal window's own progress indicator, with OSC 9;4 escape sequences.
7773
7833
 
7774
7834
  ---
7775
7835
 
@@ -7791,7 +7851,7 @@ public readonly trace: boolean;
7791
7851
 
7792
7852
  - *Type:* boolean
7793
7853
 
7794
- Sets log level to trace.
7854
+ Set the log level to trace.
7795
7855
 
7796
7856
  ---
7797
7857
 
@@ -7815,9 +7875,7 @@ public readonly trustedConfigPaths: string[];
7815
7875
 
7816
7876
  - *Type:* string[]
7817
7877
 
7818
- This is a list of config paths that mise will automatically mark as trusted.
7819
-
7820
- Any config files under these paths will be trusted without prompting. Set to `["/"]` to trust all config files, effectively disabling the trust mechanism. Paths are separated by the OS path separator when using the environment variable, `mise settings set`, or `mise settings add` (`:` on Unix, `;` on Windows).
7878
+ Directories whose config files mise trusts without asking.
7821
7879
 
7822
7880
  ---
7823
7881
 
@@ -7829,9 +7887,7 @@ public readonly unixDefaultFileShellArgs: string;
7829
7887
 
7830
7888
  - *Type:* string
7831
7889
 
7832
- Default shell arguments for Unix to be used for file commands.
7833
-
7834
- For example, `sh` for sh.
7890
+ Shell that runs a file task on Unix when the task sets no `shell` and the file has no shebang or known extension.
7835
7891
 
7836
7892
  ---
7837
7893
 
@@ -7843,9 +7899,7 @@ public readonly unixDefaultInlineShellArgs: string;
7843
7899
 
7844
7900
  - *Type:* string
7845
7901
 
7846
- Default shell arguments for Unix to be used for inline commands.
7847
-
7848
- For example, `sh -c` for sh.
7902
+ Shell and arguments that run inline scripts on Unix, such as a task's `run`, hooks and `postinstall`.
7849
7903
 
7850
7904
  ---
7851
7905
 
@@ -7867,7 +7921,7 @@ public readonly urlReplacements: {[ key: string ]: string};
7867
7921
 
7868
7922
  - *Type:* {[ key: string ]: string}
7869
7923
 
7870
- Map of URL patterns to replacement URLs applied to all requests.
7924
+ URL patterns and replacements that mise's HTTP client applies before sending a request, for mirrors and proxies.
7871
7925
 
7872
7926
  ---
7873
7927
 
@@ -7879,9 +7933,7 @@ public readonly useFileShellForExecutableTasks: boolean;
7879
7933
 
7880
7934
  - *Type:* boolean
7881
7935
 
7882
- Determines whether to use a specified shell for executing tasks in the tasks directory.
7883
-
7884
- 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.
7936
+ Run executable file tasks through a shell instead of executing them directly.
7885
7937
 
7886
7938
  ---
7887
7939
 
@@ -7893,7 +7945,7 @@ public readonly useVersionsHost: boolean;
7893
7945
 
7894
7946
  - *Type:* boolean
7895
7947
 
7896
- Set to false to disable using the mise-versions API for version lists, public GitHub release metadata, and GitHub artifact attestations.
7948
+ Get version lists, public GitHub release metadata and attestations from mise-versions instead of upstream APIs.
7897
7949
 
7898
7950
  ---
7899
7951
 
@@ -7905,7 +7957,7 @@ public readonly useVersionsHostTrack: boolean;
7905
7957
 
7906
7958
  - *Type:* boolean
7907
7959
 
7908
- Send anonymous download statistics when installing tools.
7960
+ Send anonymous download statistics to mise-versions after installing a tool.
7909
7961
 
7910
7962
  ---
7911
7963
 
@@ -7917,7 +7969,9 @@ public readonly verbose: boolean;
7917
7969
 
7918
7970
  - *Type:* boolean
7919
7971
 
7920
- Shows more verbose output such as installation logs when installing tools.
7972
+ Show extra output, such as installation logs, and set the log level to debug;
7973
+
7974
+ same as `--verbose`.
7921
7975
 
7922
7976
  ---
7923
7977
 
@@ -7929,9 +7983,7 @@ public readonly windowsDefaultFileShellArgs: string;
7929
7983
 
7930
7984
  - *Type:* string
7931
7985
 
7932
- Default shell arguments for Windows to be used for file commands.
7933
-
7934
- For example, `cmd /c` for cmd.exe.
7986
+ Shell that runs a file task on Windows when the task sets no `shell` and the file has no shebang or known extension.
7935
7987
 
7936
7988
  ---
7937
7989
 
@@ -7943,9 +7995,7 @@ public readonly windowsDefaultInlineShellArgs: string;
7943
7995
 
7944
7996
  - *Type:* string
7945
7997
 
7946
- Default shell arguments for Windows to be used for inline commands.
7947
-
7948
- For example, `cmd /c` for cmd.exe.
7998
+ Shell and arguments that run inline scripts on Windows, such as a task's `run`, hooks and `postinstall`.
7949
7999
 
7950
8000
  ---
7951
8001
 
@@ -7957,9 +8007,7 @@ public readonly windowsExecutableExtensions: string[];
7957
8007
 
7958
8008
  - *Type:* string[]
7959
8009
 
7960
- List of executable extensions for Windows.
7961
-
7962
- For example, `exe` for .exe files, `bat` for .bat files, and so on.
8010
+ File extensions, without the dot, that mise treats as executable on Windows.
7963
8011
 
7964
8012
  ---
7965
8013
 
@@ -7971,21 +8019,19 @@ public readonly windowsPowershellNoProfile: boolean;
7971
8019
 
7972
8020
  - *Type:* boolean
7973
8021
 
7974
- Pass `-NoProfile` to PowerShell (`pwsh`/`powershell`) shells that mise spawns for tasks and inline commands, so startup profiles are skipped.
8022
+ Pass `-NoProfile` to the PowerShell (`pwsh` or `powershell`) that mise starts, so startup profiles are skipped.
7975
8023
 
7976
8024
  ---
7977
8025
 
7978
8026
  ##### `windowsShimMode`<sup>Optional</sup> <a name="windowsShimMode" id="mise-projen.Settings.property.windowsShimMode"></a>
7979
8027
 
7980
8028
  ```typescript
7981
- public readonly windowsShimMode: string;
8029
+ public readonly windowsShimMode: SettingsWindowsShimMode;
7982
8030
  ```
7983
8031
 
7984
- - *Type:* string
8032
+ - *Type:* <a href="#mise-projen.SettingsWindowsShimMode">SettingsWindowsShimMode</a>
7985
8033
 
7986
- Shim file mode for Windows.
7987
-
7988
- Options: `exe`, `file`, `hardlink`, `symlink`.
8034
+ How mise creates shims on Windows.
7989
8035
 
7990
8036
  ---
7991
8037
 
@@ -8007,9 +8053,7 @@ public readonly yes: boolean;
8007
8053
 
8008
8054
  - *Type:* boolean
8009
8055
 
8010
- This will automatically answer yes or no to prompts.
8011
-
8012
- This is useful for scripting.
8056
+ Answer yes to every confirmation prompt, as `--yes` does.
8013
8057
 
8014
8058
  ---
8015
8059
 
@@ -8037,10 +8081,10 @@ const settingsAge: SettingsAge = { ... }
8037
8081
 
8038
8082
  | **Name** | **Type** | **Description** |
8039
8083
  | --- | --- | --- |
8040
- | <code><a href="#mise-projen.SettingsAge.property.identityFiles">identityFiles</a></code> | <code>string[]</code> | List of age identity files to use for decryption (encrypted shared dotfiles and the experimental `[env]` age directives). |
8041
- | <code><a href="#mise-projen.SettingsAge.property.keyFile">keyFile</a></code> | <code>string</code> | Path to the age private key file to use for encryption/decryption: the default recipient and identity for encrypted shared dotfiles and the key for the experimental `[env]` age directives. |
8042
- | <code><a href="#mise-projen.SettingsAge.property.sshIdentityFiles">sshIdentityFiles</a></code> | <code>string[]</code> | List of SSH identity files to use for age decryption (encrypted shared dotfiles and the experimental `[env]` age directives). |
8043
- | <code><a href="#mise-projen.SettingsAge.property.strict">strict</a></code> | <code>boolean</code> | If true, fail when age decryption fails (including when age is not available, the key is missing, or the key is invalid). |
8084
+ | <code><a href="#mise-projen.SettingsAge.property.identityFiles">identityFiles</a></code> | <code>string[]</code> | Age identity files to try when decrypting. |
8085
+ | <code><a href="#mise-projen.SettingsAge.property.keyFile">keyFile</a></code> | <code>string</code> | Age private key file used to decrypt and as the default recipient when encrypting. |
8086
+ | <code><a href="#mise-projen.SettingsAge.property.sshIdentityFiles">sshIdentityFiles</a></code> | <code>string[]</code> | SSH private keys to try when decrypting age values. |
8087
+ | <code><a href="#mise-projen.SettingsAge.property.strict">strict</a></code> | <code>boolean</code> | Fail when an `[env]` age value cannot be decrypted, instead of skipping it. |
8044
8088
 
8045
8089
  ---
8046
8090
 
@@ -8052,7 +8096,7 @@ public readonly identityFiles: string[];
8052
8096
 
8053
8097
  - *Type:* string[]
8054
8098
 
8055
- List of age identity files to use for decryption (encrypted shared dotfiles and the experimental `[env]` age directives).
8099
+ Age identity files to try when decrypting.
8056
8100
 
8057
8101
  ---
8058
8102
 
@@ -8064,7 +8108,7 @@ public readonly keyFile: string;
8064
8108
 
8065
8109
  - *Type:* string
8066
8110
 
8067
- Path to the age private key file to use for encryption/decryption: the default recipient and identity for encrypted shared dotfiles and the key for the experimental `[env]` age directives.
8111
+ Age private key file used to decrypt and as the default recipient when encrypting.
8068
8112
 
8069
8113
  ---
8070
8114
 
@@ -8076,7 +8120,7 @@ public readonly sshIdentityFiles: string[];
8076
8120
 
8077
8121
  - *Type:* string[]
8078
8122
 
8079
- List of SSH identity files to use for age decryption (encrypted shared dotfiles and the experimental `[env]` age directives).
8123
+ SSH private keys to try when decrypting age values.
8080
8124
 
8081
8125
  ---
8082
8126
 
@@ -8088,9 +8132,7 @@ public readonly strict: boolean;
8088
8132
 
8089
8133
  - *Type:* boolean
8090
8134
 
8091
- If true, fail when age decryption fails (including when age is not available, the key is missing, or the key is invalid).
8092
-
8093
- If false, skip decryption and continue in these cases.
8135
+ Fail when an `[env]` age value cannot be decrypted, instead of skipping it.
8094
8136
 
8095
8137
  ---
8096
8138
 
@@ -8108,14 +8150,14 @@ const settingsAqua: SettingsAqua = { ... }
8108
8150
 
8109
8151
  | **Name** | **Type** | **Description** |
8110
8152
  | --- | --- | --- |
8111
- | <code><a href="#mise-projen.SettingsAqua.property.bakedRegistry">bakedRegistry</a></code> | <code>boolean</code> | Use baked-in aqua registry. |
8112
- | <code><a href="#mise-projen.SettingsAqua.property.cosign">cosign</a></code> | <code>boolean</code> | Use cosign to verify aqua tool signatures. |
8113
- | <code><a href="#mise-projen.SettingsAqua.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Enable GitHub Artifact Attestations verification for aqua tools. |
8114
- | <code><a href="#mise-projen.SettingsAqua.property.minisign">minisign</a></code> | <code>boolean</code> | Use minisign to verify aqua tool signatures. |
8115
- | <code><a href="#mise-projen.SettingsAqua.property.registries">registries</a></code> | <code>string[]</code> | Aqua registry sources to load before the baked-in registry. |
8116
- | <code><a href="#mise-projen.SettingsAqua.property.registryCacheTtl">registryCacheTtl</a></code> | <code>string</code> | How long to cache downloaded aqua registry source files. |
8117
- | <code><a href="#mise-projen.SettingsAqua.property.registryUrl">registryUrl</a></code> | <code>string</code> | [deprecated] URL of an aqua registry repository to fetch. |
8118
- | <code><a href="#mise-projen.SettingsAqua.property.slsa">slsa</a></code> | <code>boolean</code> | Use SLSA to verify aqua tool signatures. |
8153
+ | <code><a href="#mise-projen.SettingsAqua.property.bakedRegistry">bakedRegistry</a></code> | <code>boolean</code> | Use the aqua registry built into mise. |
8154
+ | <code><a href="#mise-projen.SettingsAqua.property.cosign">cosign</a></code> | <code>boolean</code> | Verify Cosign signatures for aqua packages that declare them. |
8155
+ | <code><a href="#mise-projen.SettingsAqua.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Verify GitHub artifact attestations for aqua packages that declare them. |
8156
+ | <code><a href="#mise-projen.SettingsAqua.property.minisign">minisign</a></code> | <code>boolean</code> | Verify Minisign signatures for aqua packages that declare them. |
8157
+ | <code><a href="#mise-projen.SettingsAqua.property.registries">registries</a></code> | <code>string[]</code> | Aqua registries to search, in order, before the baked-in registry. |
8158
+ | <code><a href="#mise-projen.SettingsAqua.property.registryCacheTtl">registryCacheTtl</a></code> | <code>string</code> | How long a downloaded aqua registry stays fresh before mise downloads it again. |
8159
+ | <code><a href="#mise-projen.SettingsAqua.property.registryUrl">registryUrl</a></code> | <code>string</code> | [deprecated] URL of one aqua registry repository to search before the baked-in registry. |
8160
+ | <code><a href="#mise-projen.SettingsAqua.property.slsa">slsa</a></code> | <code>boolean</code> | Verify SLSA provenance for aqua packages that declare it. |
8119
8161
 
8120
8162
  ---
8121
8163
 
@@ -8127,7 +8169,7 @@ public readonly bakedRegistry: boolean;
8127
8169
 
8128
8170
  - *Type:* boolean
8129
8171
 
8130
- Use baked-in aqua registry.
8172
+ Use the aqua registry built into mise.
8131
8173
 
8132
8174
  ---
8133
8175
 
@@ -8139,7 +8181,7 @@ public readonly cosign: boolean;
8139
8181
 
8140
8182
  - *Type:* boolean
8141
8183
 
8142
- Use cosign to verify aqua tool signatures.
8184
+ Verify Cosign signatures for aqua packages that declare them.
8143
8185
 
8144
8186
  ---
8145
8187
 
@@ -8151,7 +8193,7 @@ public readonly githubAttestations: boolean;
8151
8193
 
8152
8194
  - *Type:* boolean
8153
8195
 
8154
- Enable GitHub Artifact Attestations verification for aqua tools.
8196
+ Verify GitHub artifact attestations for aqua packages that declare them.
8155
8197
 
8156
8198
  ---
8157
8199
 
@@ -8163,7 +8205,7 @@ public readonly minisign: boolean;
8163
8205
 
8164
8206
  - *Type:* boolean
8165
8207
 
8166
- Use minisign to verify aqua tool signatures.
8208
+ Verify Minisign signatures for aqua packages that declare them.
8167
8209
 
8168
8210
  ---
8169
8211
 
@@ -8175,7 +8217,7 @@ public readonly registries: string[];
8175
8217
 
8176
8218
  - *Type:* string[]
8177
8219
 
8178
- Aqua registry sources to load before the baked-in registry.
8220
+ Aqua registries to search, in order, before the baked-in registry.
8179
8221
 
8180
8222
  ---
8181
8223
 
@@ -8187,7 +8229,7 @@ public readonly registryCacheTtl: string;
8187
8229
 
8188
8230
  - *Type:* string
8189
8231
 
8190
- How long to cache downloaded aqua registry source files.
8232
+ How long a downloaded aqua registry stays fresh before mise downloads it again.
8191
8233
 
8192
8234
  ---
8193
8235
 
@@ -8199,7 +8241,7 @@ public readonly registryUrl: string;
8199
8241
 
8200
8242
  - *Type:* string
8201
8243
 
8202
- [deprecated] URL of an aqua registry repository to fetch.
8244
+ [deprecated] URL of one aqua registry repository to search before the baked-in registry.
8203
8245
 
8204
8246
  ---
8205
8247
 
@@ -8211,7 +8253,7 @@ public readonly slsa: boolean;
8211
8253
 
8212
8254
  - *Type:* boolean
8213
8255
 
8214
- Use SLSA to verify aqua tool signatures.
8256
+ Verify SLSA provenance for aqua packages that declare it.
8215
8257
 
8216
8258
  ---
8217
8259
 
@@ -8229,11 +8271,11 @@ const settingsCargo: SettingsCargo = { ... }
8229
8271
 
8230
8272
  | **Name** | **Type** | **Description** |
8231
8273
  | --- | --- | --- |
8232
- | <code><a href="#mise-projen.SettingsCargo.property.binstall">binstall</a></code> | <code>boolean</code> | Use cargo-binstall instead of cargo install if available. |
8233
- | <code><a href="#mise-projen.SettingsCargo.property.binstallNative">binstallNative</a></code> | <code>boolean</code> | Use mise's native cargo binary installer when cargo-binstall is unavailable. |
8234
- | <code><a href="#mise-projen.SettingsCargo.property.binstallOnly">binstallOnly</a></code> | <code>boolean</code> | Require cargo-binstall for Cargo tools without an explicit Git source. |
8235
- | <code><a href="#mise-projen.SettingsCargo.property.binstallQuickinstall">binstallQuickinstall</a></code> | <code>boolean</code> | Allow cargo-binstall to use third-party cargo-quickinstall artifacts. |
8236
- | <code><a href="#mise-projen.SettingsCargo.property.registryName">registryName</a></code> | <code>string</code> | Name of the cargo registry to use. |
8274
+ | <code><a href="#mise-projen.SettingsCargo.property.binstall">binstall</a></code> | <code>boolean</code> | Install Cargo tools from cargo-binstall's prebuilt binaries when cargo-binstall is installed. |
8275
+ | <code><a href="#mise-projen.SettingsCargo.property.binstallNative">binstallNative</a></code> | <code>boolean</code> | Use mise's own prebuilt-binary installer for Cargo tools when cargo-binstall is not installed. |
8276
+ | <code><a href="#mise-projen.SettingsCargo.property.binstallOnly">binstallOnly</a></code> | <code>boolean</code> | Require prebuilt binaries from cargo-binstall instead of falling back to `cargo install`. |
8277
+ | <code><a href="#mise-projen.SettingsCargo.property.binstallQuickinstall">binstallQuickinstall</a></code> | <code>boolean</code> | Let cargo-binstall download third-party artifacts from cargo-quickinstall. |
8278
+ | <code><a href="#mise-projen.SettingsCargo.property.registryName">registryName</a></code> | <code>string</code> | Cargo registry to install crates from instead of crates.io. |
8237
8279
 
8238
8280
  ---
8239
8281
 
@@ -8245,7 +8287,7 @@ public readonly binstall: boolean;
8245
8287
 
8246
8288
  - *Type:* boolean
8247
8289
 
8248
- Use cargo-binstall instead of cargo install if available.
8290
+ Install Cargo tools from cargo-binstall's prebuilt binaries when cargo-binstall is installed.
8249
8291
 
8250
8292
  ---
8251
8293
 
@@ -8257,7 +8299,7 @@ public readonly binstallNative: boolean;
8257
8299
 
8258
8300
  - *Type:* boolean
8259
8301
 
8260
- Use mise's native cargo binary installer when cargo-binstall is unavailable.
8302
+ Use mise's own prebuilt-binary installer for Cargo tools when cargo-binstall is not installed.
8261
8303
 
8262
8304
  ---
8263
8305
 
@@ -8269,9 +8311,7 @@ public readonly binstallOnly: boolean;
8269
8311
 
8270
8312
  - *Type:* boolean
8271
8313
 
8272
- Require cargo-binstall for Cargo tools without an explicit Git source.
8273
-
8274
- Fail if no prebuilt binary is available or if tool options require cargo install.
8314
+ Require prebuilt binaries from cargo-binstall instead of falling back to `cargo install`.
8275
8315
 
8276
8316
  ---
8277
8317
 
@@ -8283,7 +8323,7 @@ public readonly binstallQuickinstall: boolean;
8283
8323
 
8284
8324
  - *Type:* boolean
8285
8325
 
8286
- Allow cargo-binstall to use third-party cargo-quickinstall artifacts.
8326
+ Let cargo-binstall download third-party artifacts from cargo-quickinstall.
8287
8327
 
8288
8328
  ---
8289
8329
 
@@ -8295,7 +8335,7 @@ public readonly registryName: string;
8295
8335
 
8296
8336
  - *Type:* string
8297
8337
 
8298
- Name of the cargo registry to use.
8338
+ Cargo registry to install crates from instead of crates.io.
8299
8339
 
8300
8340
  ---
8301
8341
 
@@ -8313,7 +8353,7 @@ const settingsConda: SettingsConda = { ... }
8313
8353
 
8314
8354
  | **Name** | **Type** | **Description** |
8315
8355
  | --- | --- | --- |
8316
- | <code><a href="#mise-projen.SettingsConda.property.channel">channel</a></code> | <code>string</code> | Default channel for conda packages. |
8356
+ | <code><a href="#mise-projen.SettingsConda.property.channel">channel</a></code> | <code>string</code> | Channel for `conda:` tools that do not set their own. |
8317
8357
 
8318
8358
  ---
8319
8359
 
@@ -8325,7 +8365,7 @@ public readonly channel: string;
8325
8365
 
8326
8366
  - *Type:* string
8327
8367
 
8328
- Default channel for conda packages.
8368
+ Channel for `conda:` tools that do not set their own.
8329
8369
 
8330
8370
  ---
8331
8371
 
@@ -8343,23 +8383,21 @@ const settingsDotfiles: SettingsDotfiles = { ... }
8343
8383
 
8344
8384
  | **Name** | **Type** | **Description** |
8345
8385
  | --- | --- | --- |
8346
- | <code><a href="#mise-projen.SettingsDotfiles.property.defaultMode">defaultMode</a></code> | <code>string</code> | Default mode for dotfile entries when mode is omitted. |
8386
+ | <code><a href="#mise-projen.SettingsDotfiles.property.defaultMode">defaultMode</a></code> | <code><a href="#mise-projen.SettingsDotfilesDefaultMode">SettingsDotfilesDefaultMode</a></code> | Mode for `[dotfiles]` entries that do not set `mode`. |
8347
8387
  | <code><a href="#mise-projen.SettingsDotfiles.property.relativeSymlinks">relativeSymlinks</a></code> | <code>boolean</code> | Create dotfile symlinks with relative targets instead of absolute ones. |
8348
- | <code><a href="#mise-projen.SettingsDotfiles.property.root">root</a></code> | <code>string</code> | Root directory used for implied dotfile sources. |
8388
+ | <code><a href="#mise-projen.SettingsDotfiles.property.root">root</a></code> | <code>string</code> | Directory that holds dotfile sources for entries without a `source`. |
8349
8389
 
8350
8390
  ---
8351
8391
 
8352
8392
  ##### `defaultMode`<sup>Optional</sup> <a name="defaultMode" id="mise-projen.SettingsDotfiles.property.defaultMode"></a>
8353
8393
 
8354
8394
  ```typescript
8355
- public readonly defaultMode: string;
8395
+ public readonly defaultMode: SettingsDotfilesDefaultMode;
8356
8396
  ```
8357
8397
 
8358
- - *Type:* string
8359
-
8360
- Default mode for dotfile entries when mode is omitted.
8398
+ - *Type:* <a href="#mise-projen.SettingsDotfilesDefaultMode">SettingsDotfilesDefaultMode</a>
8361
8399
 
8362
- Options: `symlink`, `symlink-each`, `copy`, `template`.
8400
+ Mode for `[dotfiles]` entries that do not set `mode`.
8363
8401
 
8364
8402
  ---
8365
8403
 
@@ -8383,7 +8421,7 @@ public readonly root: string;
8383
8421
 
8384
8422
  - *Type:* string
8385
8423
 
8386
- Root directory used for implied dotfile sources.
8424
+ Directory that holds dotfile sources for entries without a `source`.
8387
8425
 
8388
8426
  ---
8389
8427
 
@@ -8401,10 +8439,10 @@ const settingsDotnet: SettingsDotnet = { ... }
8401
8439
 
8402
8440
  | **Name** | **Type** | **Description** |
8403
8441
  | --- | --- | --- |
8404
- | <code><a href="#mise-projen.SettingsDotnet.property.cliTelemetryOptout">cliTelemetryOptout</a></code> | <code>boolean</code> | Set DOTNET_CLI_TELEMETRY_OPTOUT to opt out of .NET CLI telemetry. |
8405
- | <code><a href="#mise-projen.SettingsDotnet.property.dotnetRoot">dotnetRoot</a></code> | <code>string</code> | Path to the shared .NET SDK root directory. |
8442
+ | <code><a href="#mise-projen.SettingsDotnet.property.cliTelemetryOptout">cliTelemetryOptout</a></code> | <code>boolean</code> | Set `DOTNET_CLI_TELEMETRY_OPTOUT` to opt out of .NET CLI telemetry. |
8443
+ | <code><a href="#mise-projen.SettingsDotnet.property.dotnetRoot">dotnetRoot</a></code> | <code>string</code> | Shared directory that every .NET SDK version installs into. |
8406
8444
  | <code><a href="#mise-projen.SettingsDotnet.property.isolated">isolated</a></code> | <code>boolean</code> | Install each .NET SDK version in its own isolated directory. |
8407
- | <code><a href="#mise-projen.SettingsDotnet.property.packageFlags">packageFlags</a></code> | <code>string[]</code> | [deprecated] Extends dotnet search and install abilities. |
8445
+ | <code><a href="#mise-projen.SettingsDotnet.property.packageFlags">packageFlags</a></code> | <code>string[]</code> | [deprecated] Flags for every `dotnet:` tool; |
8408
8446
  | <code><a href="#mise-projen.SettingsDotnet.property.registryUrl">registryUrl</a></code> | <code>string</code> | NuGet service index used to discover dotnet tool versions. |
8409
8447
 
8410
8448
  ---
@@ -8417,7 +8455,7 @@ public readonly cliTelemetryOptout: boolean;
8417
8455
 
8418
8456
  - *Type:* boolean
8419
8457
 
8420
- Set DOTNET_CLI_TELEMETRY_OPTOUT to opt out of .NET CLI telemetry.
8458
+ Set `DOTNET_CLI_TELEMETRY_OPTOUT` to opt out of .NET CLI telemetry.
8421
8459
 
8422
8460
  ---
8423
8461
 
@@ -8429,7 +8467,7 @@ public readonly dotnetRoot: string;
8429
8467
 
8430
8468
  - *Type:* string
8431
8469
 
8432
- Path to the shared .NET SDK root directory.
8470
+ Shared directory that every .NET SDK version installs into.
8433
8471
 
8434
8472
  ---
8435
8473
 
@@ -8453,7 +8491,9 @@ public readonly packageFlags: string[];
8453
8491
 
8454
8492
  - *Type:* string[]
8455
8493
 
8456
- [deprecated] Extends dotnet search and install abilities.
8494
+ [deprecated] Flags for every `dotnet:` tool;
8495
+
8496
+ the only flag, `prerelease`, includes prereleases.
8457
8497
 
8458
8498
  ---
8459
8499
 
@@ -8483,8 +8523,8 @@ const settingsErlang: SettingsErlang = { ... }
8483
8523
 
8484
8524
  | **Name** | **Type** | **Description** |
8485
8525
  | --- | --- | --- |
8486
- | <code><a href="#mise-projen.SettingsErlang.property.compile">compile</a></code> | <code>boolean</code> | If true, compile erlang from source. |
8487
- | <code><a href="#mise-projen.SettingsErlang.property.precompiledOs">precompiledOs</a></code> | <code>string</code> | Ubuntu release target to use for precompiled Erlang builds from builds.hex.pm. |
8526
+ | <code><a href="#mise-projen.SettingsErlang.property.compile">compile</a></code> | <code>boolean</code> | Compile Erlang from source instead of using a precompiled build. |
8527
+ | <code><a href="#mise-projen.SettingsErlang.property.precompiledOs">precompiledOs</a></code> | <code><a href="#mise-projen.SettingsErlangPrecompiledOs">SettingsErlangPrecompiledOs</a></code> | Ubuntu release whose precompiled Erlang build from builds.hex.pm mise installs on Linux. |
8488
8528
 
8489
8529
  ---
8490
8530
 
@@ -8496,21 +8536,19 @@ public readonly compile: boolean;
8496
8536
 
8497
8537
  - *Type:* boolean
8498
8538
 
8499
- If true, compile erlang from source.
8500
-
8501
- If false, use precompiled binaries. If not set, use precompiled binaries if available.
8539
+ Compile Erlang from source instead of using a precompiled build.
8502
8540
 
8503
8541
  ---
8504
8542
 
8505
8543
  ##### `precompiledOs`<sup>Optional</sup> <a name="precompiledOs" id="mise-projen.SettingsErlang.property.precompiledOs"></a>
8506
8544
 
8507
8545
  ```typescript
8508
- public readonly precompiledOs: string;
8546
+ public readonly precompiledOs: SettingsErlangPrecompiledOs;
8509
8547
  ```
8510
8548
 
8511
- - *Type:* string
8549
+ - *Type:* <a href="#mise-projen.SettingsErlangPrecompiledOs">SettingsErlangPrecompiledOs</a>
8512
8550
 
8513
- Ubuntu release target to use for precompiled Erlang builds from builds.hex.pm.
8551
+ Ubuntu release whose precompiled Erlang build from builds.hex.pm mise installs on Linux.
8514
8552
 
8515
8553
  ---
8516
8554
 
@@ -8528,9 +8566,9 @@ const settingsForgejo: SettingsForgejo = { ... }
8528
8566
 
8529
8567
  | **Name** | **Type** | **Description** |
8530
8568
  | --- | --- | --- |
8531
- | <code><a href="#mise-projen.SettingsForgejo.property.credentialCommand">credentialCommand</a></code> | <code>string</code> | Shell command to run to obtain a Forgejo token for mise. |
8532
- | <code><a href="#mise-projen.SettingsForgejo.property.fjCliTokens">fjCliTokens</a></code> | <code>boolean</code> | Read Forgejo tokens from the fj CLI config. |
8533
- | <code><a href="#mise-projen.SettingsForgejo.property.useGitCredentials">useGitCredentials</a></code> | <code>boolean</code> | Use git credential helpers to obtain Forgejo tokens. |
8569
+ | <code><a href="#mise-projen.SettingsForgejo.property.credentialCommand">credentialCommand</a></code> | <code>string</code> | Command that prints a Forgejo token on stdout. |
8570
+ | <code><a href="#mise-projen.SettingsForgejo.property.fjCliTokens">fjCliTokens</a></code> | <code>boolean</code> | Read Forgejo tokens that the fj CLI stores in its `keys.json` file. |
8571
+ | <code><a href="#mise-projen.SettingsForgejo.property.useGitCredentials">useGitCredentials</a></code> | <code>boolean</code> | Get Forgejo tokens from your Git credential helpers with `git credential fill`. |
8534
8572
 
8535
8573
  ---
8536
8574
 
@@ -8542,7 +8580,7 @@ public readonly credentialCommand: string;
8542
8580
 
8543
8581
  - *Type:* string
8544
8582
 
8545
- Shell command to run to obtain a Forgejo token for mise.
8583
+ Command that prints a Forgejo token on stdout.
8546
8584
 
8547
8585
  ---
8548
8586
 
@@ -8554,7 +8592,7 @@ public readonly fjCliTokens: boolean;
8554
8592
 
8555
8593
  - *Type:* boolean
8556
8594
 
8557
- Read Forgejo tokens from the fj CLI config.
8595
+ Read Forgejo tokens that the fj CLI stores in its `keys.json` file.
8558
8596
 
8559
8597
  ---
8560
8598
 
@@ -8566,7 +8604,7 @@ public readonly useGitCredentials: boolean;
8566
8604
 
8567
8605
  - *Type:* boolean
8568
8606
 
8569
- Use git credential helpers to obtain Forgejo tokens.
8607
+ Get Forgejo tokens from your Git credential helpers with `git credential fill`.
8570
8608
 
8571
8609
  ---
8572
8610
 
@@ -8584,17 +8622,17 @@ const settingsGithub: SettingsGithub = { ... }
8584
8622
 
8585
8623
  | **Name** | **Type** | **Description** |
8586
8624
  | --- | --- | --- |
8587
- | <code><a href="#mise-projen.SettingsGithub.property.credentialCommand">credentialCommand</a></code> | <code>string</code> | Shell command to run to obtain a GitHub token for mise. |
8588
- | <code><a href="#mise-projen.SettingsGithub.property.ghCliTokens">ghCliTokens</a></code> | <code>boolean</code> | Read GitHub tokens from the gh CLI's hosts.yml config. |
8589
- | <code><a href="#mise-projen.SettingsGithub.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Enable GitHub Artifact Attestations verification for github backend tools. |
8590
- | <code><a href="#mise-projen.SettingsGithub.property.oauthApiUrl">oauthApiUrl</a></code> | <code>string</code> | GitHub API base URL for native OAuth token validation. |
8591
- | <code><a href="#mise-projen.SettingsGithub.property.oauthAuthUrl">oauthAuthUrl</a></code> | <code>string</code> | GitHub OAuth endpoint base URL for native device-flow tokens. |
8592
- | <code><a href="#mise-projen.SettingsGithub.property.oauthClientId">oauthClientId</a></code> | <code>string</code> | GitHub App client ID for native OAuth device-flow tokens. |
8593
- | <code><a href="#mise-projen.SettingsGithub.property.oauthExportEnv">oauthExportEnv</a></code> | <code>string</code> | Environment variable name to export the native GitHub OAuth token under (empty disables). |
8594
- | <code><a href="#mise-projen.SettingsGithub.property.oauthOpenBrowser">oauthOpenBrowser</a></code> | <code>boolean</code> | Open the browser during native GitHub OAuth device flow. |
8625
+ | <code><a href="#mise-projen.SettingsGithub.property.credentialCommand">credentialCommand</a></code> | <code>string</code> | Command that prints a GitHub token on stdout. |
8626
+ | <code><a href="#mise-projen.SettingsGithub.property.ghCliTokens">ghCliTokens</a></code> | <code>boolean</code> | Read GitHub tokens that the gh CLI stores in its `hosts.yml` file. |
8627
+ | <code><a href="#mise-projen.SettingsGithub.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Verify GitHub artifact attestations for github backend tools. |
8628
+ | <code><a href="#mise-projen.SettingsGithub.property.oauthApiUrl">oauthApiUrl</a></code> | <code>string</code> | GitHub API base URL mise uses to validate native OAuth tokens. |
8629
+ | <code><a href="#mise-projen.SettingsGithub.property.oauthAuthUrl">oauthAuthUrl</a></code> | <code>string</code> | GitHub OAuth endpoint base URL for the native device flow. |
8630
+ | <code><a href="#mise-projen.SettingsGithub.property.oauthClientId">oauthClientId</a></code> | <code>string</code> | GitHub App client ID that turns on native OAuth device-flow tokens. |
8631
+ | <code><a href="#mise-projen.SettingsGithub.property.oauthExportEnv">oauthExportEnv</a></code> | <code>string</code> | Environment variable that mise exports the native GitHub OAuth token under; |
8632
+ | <code><a href="#mise-projen.SettingsGithub.property.oauthOpenBrowser">oauthOpenBrowser</a></code> | <code>boolean</code> | Open the verification page in your browser during the native GitHub OAuth device flow. |
8595
8633
  | <code><a href="#mise-projen.SettingsGithub.property.oauthScopes">oauthScopes</a></code> | <code>string</code> | OAuth scopes requested for native GitHub device-flow tokens. |
8596
- | <code><a href="#mise-projen.SettingsGithub.property.slsa">slsa</a></code> | <code>boolean</code> | Enable SLSA provenance verification for github backend tools. |
8597
- | <code><a href="#mise-projen.SettingsGithub.property.useGitCredentials">useGitCredentials</a></code> | <code>boolean</code> | Use git credential helpers to obtain GitHub tokens. |
8634
+ | <code><a href="#mise-projen.SettingsGithub.property.slsa">slsa</a></code> | <code>boolean</code> | Verify SLSA provenance for github backend tools that name a signer. |
8635
+ | <code><a href="#mise-projen.SettingsGithub.property.useGitCredentials">useGitCredentials</a></code> | <code>boolean</code> | Get GitHub tokens from your Git credential helpers with `git credential fill`. |
8598
8636
 
8599
8637
  ---
8600
8638
 
@@ -8606,7 +8644,7 @@ public readonly credentialCommand: string;
8606
8644
 
8607
8645
  - *Type:* string
8608
8646
 
8609
- Shell command to run to obtain a GitHub token for mise.
8647
+ Command that prints a GitHub token on stdout.
8610
8648
 
8611
8649
  ---
8612
8650
 
@@ -8618,7 +8656,7 @@ public readonly ghCliTokens: boolean;
8618
8656
 
8619
8657
  - *Type:* boolean
8620
8658
 
8621
- Read GitHub tokens from the gh CLI's hosts.yml config.
8659
+ Read GitHub tokens that the gh CLI stores in its `hosts.yml` file.
8622
8660
 
8623
8661
  ---
8624
8662
 
@@ -8630,7 +8668,7 @@ public readonly githubAttestations: boolean;
8630
8668
 
8631
8669
  - *Type:* boolean
8632
8670
 
8633
- Enable GitHub Artifact Attestations verification for github backend tools.
8671
+ Verify GitHub artifact attestations for github backend tools.
8634
8672
 
8635
8673
  ---
8636
8674
 
@@ -8642,7 +8680,7 @@ public readonly oauthApiUrl: string;
8642
8680
 
8643
8681
  - *Type:* string
8644
8682
 
8645
- GitHub API base URL for native OAuth token validation.
8683
+ GitHub API base URL mise uses to validate native OAuth tokens.
8646
8684
 
8647
8685
  ---
8648
8686
 
@@ -8654,7 +8692,7 @@ public readonly oauthAuthUrl: string;
8654
8692
 
8655
8693
  - *Type:* string
8656
8694
 
8657
- GitHub OAuth endpoint base URL for native device-flow tokens.
8695
+ GitHub OAuth endpoint base URL for the native device flow.
8658
8696
 
8659
8697
  ---
8660
8698
 
@@ -8666,7 +8704,7 @@ public readonly oauthClientId: string;
8666
8704
 
8667
8705
  - *Type:* string
8668
8706
 
8669
- GitHub App client ID for native OAuth device-flow tokens.
8707
+ GitHub App client ID that turns on native OAuth device-flow tokens.
8670
8708
 
8671
8709
  ---
8672
8710
 
@@ -8678,7 +8716,9 @@ public readonly oauthExportEnv: string;
8678
8716
 
8679
8717
  - *Type:* string
8680
8718
 
8681
- Environment variable name to export the native GitHub OAuth token under (empty disables).
8719
+ Environment variable that mise exports the native GitHub OAuth token under;
8720
+
8721
+ empty turns the export off.
8682
8722
 
8683
8723
  ---
8684
8724
 
@@ -8690,7 +8730,7 @@ public readonly oauthOpenBrowser: boolean;
8690
8730
 
8691
8731
  - *Type:* boolean
8692
8732
 
8693
- Open the browser during native GitHub OAuth device flow.
8733
+ Open the verification page in your browser during the native GitHub OAuth device flow.
8694
8734
 
8695
8735
  ---
8696
8736
 
@@ -8714,7 +8754,7 @@ public readonly slsa: boolean;
8714
8754
 
8715
8755
  - *Type:* boolean
8716
8756
 
8717
- Enable SLSA provenance verification for github backend tools.
8757
+ Verify SLSA provenance for github backend tools that name a signer.
8718
8758
 
8719
8759
  ---
8720
8760
 
@@ -8726,7 +8766,7 @@ public readonly useGitCredentials: boolean;
8726
8766
 
8727
8767
  - *Type:* boolean
8728
8768
 
8729
- Use git credential helpers to obtain GitHub tokens.
8769
+ Get GitHub tokens from your Git credential helpers with `git credential fill`.
8730
8770
 
8731
8771
  ---
8732
8772
 
@@ -8744,11 +8784,11 @@ const settingsGithubRelay: SettingsGithubRelay = { ... }
8744
8784
 
8745
8785
  | **Name** | **Type** | **Description** |
8746
8786
  | --- | --- | --- |
8747
- | <code><a href="#mise-projen.SettingsGithubRelay.property.concurrency">concurrency</a></code> | <code>number</code> | Maximum simultaneous GitHub relay requests (1-32); |
8748
- | <code><a href="#mise-projen.SettingsGithubRelay.property.logFormat">logFormat</a></code> | <code>string</code> | GitHub relay request and summary output format: text or jsonl. |
8749
- | <code><a href="#mise-projen.SettingsGithubRelay.property.logRequests">logRequests</a></code> | <code>boolean</code> | Log sanitized GitHub relay requests on the initiating machine's stderr. |
8750
- | <code><a href="#mise-projen.SettingsGithubRelay.property.maxDuration">maxDuration</a></code> | <code>string</code> | Maximum borrowed GitHub access duration; |
8751
- | <code><a href="#mise-projen.SettingsGithubRelay.property.requestTimeout">requestTimeout</a></code> | <code>string</code> | Total time limit for a relayed request, including response streaming. |
8787
+ | <code><a href="#mise-projen.SettingsGithubRelay.property.concurrency">concurrency</a></code> | <code>number</code> | Maximum relayed GitHub requests that run at once, from 1 to 32; |
8788
+ | <code><a href="#mise-projen.SettingsGithubRelay.property.logFormat">logFormat</a></code> | <code><a href="#mise-projen.SettingsGithubRelayLogFormat">SettingsGithubRelayLogFormat</a></code> | Format of GitHub relay request logs and the end-of-session summary. |
8789
+ | <code><a href="#mise-projen.SettingsGithubRelay.property.logRequests">logRequests</a></code> | <code>boolean</code> | Log each relayed GitHub request, without credentials, on this machine's stderr. |
8790
+ | <code><a href="#mise-projen.SettingsGithubRelay.property.maxDuration">maxDuration</a></code> | <code>string</code> | How long a GitHub relay lends access; |
8791
+ | <code><a href="#mise-projen.SettingsGithubRelay.property.requestTimeout">requestTimeout</a></code> | <code>string</code> | Time limit for one relayed GitHub request, including streaming its response. |
8752
8792
 
8753
8793
  ---
8754
8794
 
@@ -8760,21 +8800,21 @@ public readonly concurrency: number;
8760
8800
 
8761
8801
  - *Type:* number
8762
8802
 
8763
- Maximum simultaneous GitHub relay requests (1-32);
8803
+ Maximum relayed GitHub requests that run at once, from 1 to 32;
8764
8804
 
8765
- excess requests fail closed.
8805
+ more requests fail instead of waiting.
8766
8806
 
8767
8807
  ---
8768
8808
 
8769
8809
  ##### `logFormat`<sup>Optional</sup> <a name="logFormat" id="mise-projen.SettingsGithubRelay.property.logFormat"></a>
8770
8810
 
8771
8811
  ```typescript
8772
- public readonly logFormat: string;
8812
+ public readonly logFormat: SettingsGithubRelayLogFormat;
8773
8813
  ```
8774
8814
 
8775
- - *Type:* string
8815
+ - *Type:* <a href="#mise-projen.SettingsGithubRelayLogFormat">SettingsGithubRelayLogFormat</a>
8776
8816
 
8777
- GitHub relay request and summary output format: text or jsonl.
8817
+ Format of GitHub relay request logs and the end-of-session summary.
8778
8818
 
8779
8819
  ---
8780
8820
 
@@ -8786,7 +8826,7 @@ public readonly logRequests: boolean;
8786
8826
 
8787
8827
  - *Type:* boolean
8788
8828
 
8789
- Log sanitized GitHub relay requests on the initiating machine's stderr.
8829
+ Log each relayed GitHub request, without credentials, on this machine's stderr.
8790
8830
 
8791
8831
  ---
8792
8832
 
@@ -8798,9 +8838,9 @@ public readonly maxDuration: string;
8798
8838
 
8799
8839
  - *Type:* string
8800
8840
 
8801
- Maximum borrowed GitHub access duration;
8841
+ How long a GitHub relay lends access;
8802
8842
 
8803
- 0s means until the session ends.
8843
+ `0s` lasts until the session ends.
8804
8844
 
8805
8845
  ---
8806
8846
 
@@ -8812,7 +8852,7 @@ public readonly requestTimeout: string;
8812
8852
 
8813
8853
  - *Type:* string
8814
8854
 
8815
- Total time limit for a relayed request, including response streaming.
8855
+ Time limit for one relayed GitHub request, including streaming its response.
8816
8856
 
8817
8857
  ---
8818
8858
 
@@ -8830,9 +8870,9 @@ const settingsGitlab: SettingsGitlab = { ... }
8830
8870
 
8831
8871
  | **Name** | **Type** | **Description** |
8832
8872
  | --- | --- | --- |
8833
- | <code><a href="#mise-projen.SettingsGitlab.property.credentialCommand">credentialCommand</a></code> | <code>string</code> | Shell command to run to obtain a GitLab token for mise. |
8834
- | <code><a href="#mise-projen.SettingsGitlab.property.glabCliTokens">glabCliTokens</a></code> | <code>boolean</code> | Read GitLab tokens from the glab CLI config. |
8835
- | <code><a href="#mise-projen.SettingsGitlab.property.useGitCredentials">useGitCredentials</a></code> | <code>boolean</code> | Use git credential helpers to obtain GitLab tokens. |
8873
+ | <code><a href="#mise-projen.SettingsGitlab.property.credentialCommand">credentialCommand</a></code> | <code>string</code> | Command that prints a GitLab token on stdout. |
8874
+ | <code><a href="#mise-projen.SettingsGitlab.property.glabCliTokens">glabCliTokens</a></code> | <code>boolean</code> | Read GitLab tokens that the glab CLI stores in its `config.yml` file. |
8875
+ | <code><a href="#mise-projen.SettingsGitlab.property.useGitCredentials">useGitCredentials</a></code> | <code>boolean</code> | Get GitLab tokens from your Git credential helpers with `git credential fill`. |
8836
8876
 
8837
8877
  ---
8838
8878
 
@@ -8844,7 +8884,7 @@ public readonly credentialCommand: string;
8844
8884
 
8845
8885
  - *Type:* string
8846
8886
 
8847
- Shell command to run to obtain a GitLab token for mise.
8887
+ Command that prints a GitLab token on stdout.
8848
8888
 
8849
8889
  ---
8850
8890
 
@@ -8856,7 +8896,7 @@ public readonly glabCliTokens: boolean;
8856
8896
 
8857
8897
  - *Type:* boolean
8858
8898
 
8859
- Read GitLab tokens from the glab CLI config.
8899
+ Read GitLab tokens that the glab CLI stores in its `config.yml` file.
8860
8900
 
8861
8901
  ---
8862
8902
 
@@ -8868,7 +8908,7 @@ public readonly useGitCredentials: boolean;
8868
8908
 
8869
8909
  - *Type:* boolean
8870
8910
 
8871
- Use git credential helpers to obtain GitLab tokens.
8911
+ Get GitLab tokens from your Git credential helpers with `git credential fill`.
8872
8912
 
8873
8913
  ---
8874
8914
 
@@ -8886,13 +8926,13 @@ const settingsGo: SettingsGo = { ... }
8886
8926
 
8887
8927
  | **Name** | **Type** | **Description** |
8888
8928
  | --- | --- | --- |
8889
- | <code><a href="#mise-projen.SettingsGo.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> | Path to a file containing default go packages to install when installing go. |
8890
- | <code><a href="#mise-projen.SettingsGo.property.downloadMirror">downloadMirror</a></code> | <code>string</code> | Mirror to download go sdk tarballs from. |
8891
- | <code><a href="#mise-projen.SettingsGo.property.repo">repo</a></code> | <code>string</code> | URL to fetch go from. |
8892
- | <code><a href="#mise-projen.SettingsGo.property.setGobin">setGobin</a></code> | <code>boolean</code> | Changes where `go install` installs binaries to. |
8893
- | <code><a href="#mise-projen.SettingsGo.property.setGopath">setGopath</a></code> | <code>boolean</code> | [deprecated] Set to true to set GOPATH=~/.local/share/mise/installs/go/.../packages. |
8894
- | <code><a href="#mise-projen.SettingsGo.property.setGoroot">setGoroot</a></code> | <code>boolean</code> | Sets GOROOT=~/.local/share/mise/installs/go/.../. |
8895
- | <code><a href="#mise-projen.SettingsGo.property.skipChecksum">skipChecksum</a></code> | <code>boolean</code> | Set to true to skip checksum verification when downloading go sdk tarballs. |
8929
+ | <code><a href="#mise-projen.SettingsGo.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> | [deprecated] File listing Go packages to install with every Go version. |
8930
+ | <code><a href="#mise-projen.SettingsGo.property.downloadMirror">downloadMirror</a></code> | <code>string</code> | Base URL that mise downloads Go archives and their checksums from. |
8931
+ | <code><a href="#mise-projen.SettingsGo.property.repo">repo</a></code> | <code>string</code> | Git repository mise lists Go versions from. |
8932
+ | <code><a href="#mise-projen.SettingsGo.property.setGobin">setGobin</a></code> | <code>boolean</code> | Set `GOBIN` so `go install` puts binaries in the active Go version's directory. |
8933
+ | <code><a href="#mise-projen.SettingsGo.property.setGopath">setGopath</a></code> | <code>boolean</code> | [deprecated] Set `GOPATH` to the `packages` directory inside the active Go install. |
8934
+ | <code><a href="#mise-projen.SettingsGo.property.setGoroot">setGoroot</a></code> | <code>boolean</code> | Set `GOROOT` to the active Go version's install directory. |
8935
+ | <code><a href="#mise-projen.SettingsGo.property.skipChecksum">skipChecksum</a></code> | <code>boolean</code> | Skip SHA-256 verification of Go downloads. |
8896
8936
 
8897
8937
  ---
8898
8938
 
@@ -8904,7 +8944,7 @@ public readonly defaultPackagesFile: string;
8904
8944
 
8905
8945
  - *Type:* string
8906
8946
 
8907
- Path to a file containing default go packages to install when installing go.
8947
+ [deprecated] File listing Go packages to install with every Go version.
8908
8948
 
8909
8949
  ---
8910
8950
 
@@ -8916,7 +8956,7 @@ public readonly downloadMirror: string;
8916
8956
 
8917
8957
  - *Type:* string
8918
8958
 
8919
- Mirror to download go sdk tarballs from.
8959
+ Base URL that mise downloads Go archives and their checksums from.
8920
8960
 
8921
8961
  ---
8922
8962
 
@@ -8928,7 +8968,7 @@ public readonly repo: string;
8928
8968
 
8929
8969
  - *Type:* string
8930
8970
 
8931
- URL to fetch go from.
8971
+ Git repository mise lists Go versions from.
8932
8972
 
8933
8973
  ---
8934
8974
 
@@ -8940,7 +8980,7 @@ public readonly setGobin: boolean;
8940
8980
 
8941
8981
  - *Type:* boolean
8942
8982
 
8943
- Changes where `go install` installs binaries to.
8983
+ Set `GOBIN` so `go install` puts binaries in the active Go version's directory.
8944
8984
 
8945
8985
  ---
8946
8986
 
@@ -8952,7 +8992,7 @@ public readonly setGopath: boolean;
8952
8992
 
8953
8993
  - *Type:* boolean
8954
8994
 
8955
- [deprecated] Set to true to set GOPATH=~/.local/share/mise/installs/go/.../packages.
8995
+ [deprecated] Set `GOPATH` to the `packages` directory inside the active Go install.
8956
8996
 
8957
8997
  ---
8958
8998
 
@@ -8964,7 +9004,7 @@ public readonly setGoroot: boolean;
8964
9004
 
8965
9005
  - *Type:* boolean
8966
9006
 
8967
- Sets GOROOT=~/.local/share/mise/installs/go/.../.
9007
+ Set `GOROOT` to the active Go version's install directory.
8968
9008
 
8969
9009
  ---
8970
9010
 
@@ -8976,7 +9016,7 @@ public readonly skipChecksum: boolean;
8976
9016
 
8977
9017
  - *Type:* boolean
8978
9018
 
8979
- Set to true to skip checksum verification when downloading go sdk tarballs.
9019
+ Skip SHA-256 verification of Go downloads.
8980
9020
 
8981
9021
  ---
8982
9022
 
@@ -8994,13 +9034,13 @@ const settingsHistory: SettingsHistory = { ... }
8994
9034
 
8995
9035
  | **Name** | **Type** | **Description** |
8996
9036
  | --- | --- | --- |
8997
- | <code><a href="#mise-projen.SettingsHistory.property.allowPlaintextHistory">allowPlaintextHistory</a></code> | <code>boolean</code> | Allow publishing history that contains unencrypted versions of files now marked for encryption. |
8998
- | <code><a href="#mise-projen.SettingsHistory.property.describeCommand">describeCommand</a></code> | <code>string</code> | A command that names commits the watcher saves (an agent, say): it gets one JSON object on stdin (uuid, trigger, the computed description, changed tracked paths, and a unified diff of changed unencrypted files, at most 64 KiB) and prints one line of at most 200 characters, which becomes the description. |
8999
- | <code><a href="#mise-projen.SettingsHistory.property.enabled">enabled</a></code> | <code>boolean</code> | Record ordinary Git commits for explicitly tracked files around bootstrap operations and on explicit saves. |
9000
- | <code><a href="#mise-projen.SettingsHistory.property.fetchInterval">fetchInterval</a></code> | <code>string</code> | How often the history watcher fetches the origin branch. |
9001
- | <code><a href="#mise-projen.SettingsHistory.property.notify">notify</a></code> | <code>boolean</code> | Show a desktop notification when conflicts pause sharing for the setup. |
9002
- | <code><a href="#mise-projen.SettingsHistory.property.sync">sync</a></code> | <code><a href="#mise-projen.SettingsHistorySync">SettingsHistorySync</a></code> | What the history watcher does with a connected setup repository on its own: `sync` publishes after saves, fetches periodically, and applies incoming changes. |
9003
- | <code><a href="#mise-projen.SettingsHistory.property.syncInterval">syncInterval</a></code> | <code>string</code> | How soon after a save the history watcher publishes to the setup repository, at most this often. |
9037
+ | <code><a href="#mise-projen.SettingsHistory.property.allowPlaintextHistory">allowPlaintextHistory</a></code> | <code>boolean</code> | Allow publishing or applying history that holds plaintext copies of files now marked for encryption, or publishing versions that look like they contain secrets. |
9038
+ | <code><a href="#mise-projen.SettingsHistory.property.describeCommand">describeCommand</a></code> | <code>string</code> | Command, such as an AI agent, that writes the description of each checkpoint the history watcher saves. |
9039
+ | <code><a href="#mise-projen.SettingsHistory.property.enabled">enabled</a></code> | <code>boolean</code> | Record Git checkpoints of tracked files around bootstrap operations and on explicit saves. |
9040
+ | <code><a href="#mise-projen.SettingsHistory.property.fetchInterval">fetchInterval</a></code> | <code>string</code> | How often the history watcher fetches from the setup repository. |
9041
+ | <code><a href="#mise-projen.SettingsHistory.property.notify">notify</a></code> | <code>boolean</code> | Show a desktop notification when a sync conflict pauses sharing. |
9042
+ | <code><a href="#mise-projen.SettingsHistory.property.sync">sync</a></code> | <code><a href="#mise-projen.SettingsHistorySync">SettingsHistorySync</a></code> | What the history watcher shares with a connected setup repository on its own. |
9043
+ | <code><a href="#mise-projen.SettingsHistory.property.syncInterval">syncInterval</a></code> | <code>string</code> | Minimum time between automatic publishes to the setup repository after a save. |
9004
9044
  | <code><a href="#mise-projen.SettingsHistory.property.watch">watch</a></code> | <code><a href="#mise-projen.SettingsHistoryWatch">SettingsHistoryWatch</a></code> | *No description.* |
9005
9045
 
9006
9046
  ---
@@ -9013,7 +9053,7 @@ public readonly allowPlaintextHistory: boolean;
9013
9053
 
9014
9054
  - *Type:* boolean
9015
9055
 
9016
- Allow publishing history that contains unencrypted versions of files now marked for encryption.
9056
+ Allow publishing or applying history that holds plaintext copies of files now marked for encryption, or publishing versions that look like they contain secrets.
9017
9057
 
9018
9058
  ---
9019
9059
 
@@ -9025,9 +9065,7 @@ public readonly describeCommand: string;
9025
9065
 
9026
9066
  - *Type:* string
9027
9067
 
9028
- A command that names commits the watcher saves (an agent, say): it gets one JSON object on stdin (uuid, trigger, the computed description, changed tracked paths, and a unified diff of changed unencrypted files, at most 64 KiB) and prints one line of at most 200 characters, which becomes the description.
9029
-
9030
- Empty: computed descriptions only.
9068
+ Command, such as an AI agent, that writes the description of each checkpoint the history watcher saves.
9031
9069
 
9032
9070
  ---
9033
9071
 
@@ -9039,7 +9077,7 @@ public readonly enabled: boolean;
9039
9077
 
9040
9078
  - *Type:* boolean
9041
9079
 
9042
- Record ordinary Git commits for explicitly tracked files around bootstrap operations and on explicit saves.
9080
+ Record Git checkpoints of tracked files around bootstrap operations and on explicit saves.
9043
9081
 
9044
9082
  ---
9045
9083
 
@@ -9051,9 +9089,7 @@ public readonly fetchInterval: string;
9051
9089
 
9052
9090
  - *Type:* string
9053
9091
 
9054
- How often the history watcher fetches the origin branch.
9055
-
9056
- Values below one second use one second; use history.sync = 'manual' to disable automatic synchronization.
9092
+ How often the history watcher fetches from the setup repository.
9057
9093
 
9058
9094
  ---
9059
9095
 
@@ -9065,9 +9101,7 @@ public readonly notify: boolean;
9065
9101
 
9066
9102
  - *Type:* boolean
9067
9103
 
9068
- Show a desktop notification when conflicts pause sharing for the setup.
9069
-
9070
- Enabled by default; retries stay silent until sharing recovers, and a notifier that is missing or failing never holds up history or sync.
9104
+ Show a desktop notification when a sync conflict pauses sharing.
9071
9105
 
9072
9106
  ---
9073
9107
 
@@ -9079,9 +9113,7 @@ public readonly sync: SettingsHistorySync;
9079
9113
 
9080
9114
  - *Type:* <a href="#mise-projen.SettingsHistorySync">SettingsHistorySync</a>
9081
9115
 
9082
- What the history watcher does with a connected setup repository on its own: `sync` publishes after saves, fetches periodically, and applies incoming changes.
9083
-
9084
- Any conflict pauses publication and incoming application for the entire setup; local commits and fetching continue. `fetch-only` only fetches; `manual` does nothing automatically. `mise bootstrap dotfiles sync` and `pull` work on request in every mode.
9116
+ What the history watcher shares with a connected setup repository on its own.
9085
9117
 
9086
9118
  ---
9087
9119
 
@@ -9093,7 +9125,7 @@ public readonly syncInterval: string;
9093
9125
 
9094
9126
  - *Type:* string
9095
9127
 
9096
- How soon after a save the history watcher publishes to the setup repository, at most this often.
9128
+ Minimum time between automatic publishes to the setup repository after a save.
9097
9129
 
9098
9130
  ---
9099
9131
 
@@ -9121,9 +9153,9 @@ const settingsHistoryWatch: SettingsHistoryWatch = { ... }
9121
9153
 
9122
9154
  | **Name** | **Type** | **Description** |
9123
9155
  | --- | --- | --- |
9124
- | <code><a href="#mise-projen.SettingsHistoryWatch.property.debounce">debounce</a></code> | <code>string</code> | How long a changed file must stay quiet before the history watcher saves it (the base autosave interval). |
9125
- | <code><a href="#mise-projen.SettingsHistoryWatch.property.maxInterval">maxInterval</a></code> | <code>string</code> | The longest autosave interval the history watcher stretches a constantly changing file to. |
9126
- | <code><a href="#mise-projen.SettingsHistoryWatch.property.reconcile">reconcile</a></code> | <code>string</code> | How often the history watcher rescans the whole tracked set for changes its watches missed. |
9156
+ | <code><a href="#mise-projen.SettingsHistoryWatch.property.debounce">debounce</a></code> | <code>string</code> | How long a changed file must stay unchanged before the history watcher saves it. |
9157
+ | <code><a href="#mise-projen.SettingsHistoryWatch.property.maxInterval">maxInterval</a></code> | <code>string</code> | Longest save interval the history watcher uses for a file that changes constantly. |
9158
+ | <code><a href="#mise-projen.SettingsHistoryWatch.property.reconcile">reconcile</a></code> | <code>string</code> | How often the history watcher rescans all tracked files for changes it missed. |
9127
9159
 
9128
9160
  ---
9129
9161
 
@@ -9135,9 +9167,7 @@ public readonly debounce: string;
9135
9167
 
9136
9168
  - *Type:* string
9137
9169
 
9138
- How long a changed file must stay quiet before the history watcher saves it (the base autosave interval).
9139
-
9140
- A file that keeps changing is stretched on its own and never delays the others.
9170
+ How long a changed file must stay unchanged before the history watcher saves it.
9141
9171
 
9142
9172
  ---
9143
9173
 
@@ -9149,9 +9179,7 @@ public readonly maxInterval: string;
9149
9179
 
9150
9180
  - *Type:* string
9151
9181
 
9152
- The longest autosave interval the history watcher stretches a constantly changing file to.
9153
-
9154
- Sustained churn doubles a file's own interval up to this; a settled file is saved promptly again, and a sustained quiet period resets it.
9182
+ Longest save interval the history watcher uses for a file that changes constantly.
9155
9183
 
9156
9184
  ---
9157
9185
 
@@ -9163,9 +9191,7 @@ public readonly reconcile: string;
9163
9191
 
9164
9192
  - *Type:* string
9165
9193
 
9166
- How often the history watcher rescans the whole tracked set for changes its watches missed.
9167
-
9168
- `0` disables periodic reconciliation (startup and configuration changes still reconcile).
9194
+ How often the history watcher rescans all tracked files for changes it missed.
9169
9195
 
9170
9196
  ---
9171
9197
 
@@ -9183,8 +9209,8 @@ const settingsHookEnv: SettingsHookEnv = { ... }
9183
9209
 
9184
9210
  | **Name** | **Type** | **Description** |
9185
9211
  | --- | --- | --- |
9186
- | <code><a href="#mise-projen.SettingsHookEnv.property.cacheTtl">cacheTtl</a></code> | <code>string</code> | Cache hook-env directory checks for this duration. |
9187
- | <code><a href="#mise-projen.SettingsHookEnv.property.chpwdOnly">chpwdOnly</a></code> | <code>boolean</code> | Only run hook-env checks on directory change, not on every prompt. |
9212
+ | <code><a href="#mise-projen.SettingsHookEnv.property.cacheTtl">cacheTtl</a></code> | <code>string</code> | How long the shell hook reuses its last config file check, for slow filesystems such as NFS. |
9213
+ | <code><a href="#mise-projen.SettingsHookEnv.property.chpwdOnly">chpwdOnly</a></code> | <code>boolean</code> | Run the shell hook's full config check only when you change directories, not at every prompt. |
9188
9214
 
9189
9215
  ---
9190
9216
 
@@ -9196,9 +9222,7 @@ public readonly cacheTtl: string;
9196
9222
 
9197
9223
  - *Type:* string
9198
9224
 
9199
- Cache hook-env directory checks for this duration.
9200
-
9201
- Useful for slow filesystems like NFS.
9225
+ How long the shell hook reuses its last config file check, for slow filesystems such as NFS.
9202
9226
 
9203
9227
  ---
9204
9228
 
@@ -9210,7 +9234,7 @@ public readonly chpwdOnly: boolean;
9210
9234
 
9211
9235
  - *Type:* boolean
9212
9236
 
9213
- Only run hook-env checks on directory change, not on every prompt.
9237
+ Run the shell hook's full config check only when you change directories, not at every prompt.
9214
9238
 
9215
9239
  ---
9216
9240
 
@@ -9228,7 +9252,7 @@ const settingsJava: SettingsJava = { ... }
9228
9252
 
9229
9253
  | **Name** | **Type** | **Description** |
9230
9254
  | --- | --- | --- |
9231
- | <code><a href="#mise-projen.SettingsJava.property.shorthandVendor">shorthandVendor</a></code> | <code>string</code> | Shorthand for Java. |
9255
+ | <code><a href="#mise-projen.SettingsJava.property.shorthandVendor">shorthandVendor</a></code> | <code>string</code> | Vendor used for a Java version without a vendor prefix, such as `java@21`. |
9232
9256
 
9233
9257
  ---
9234
9258
 
@@ -9240,9 +9264,7 @@ public readonly shorthandVendor: string;
9240
9264
 
9241
9265
  - *Type:* string
9242
9266
 
9243
- Shorthand for Java.
9244
-
9245
- Used when installing Java without a vendor prefix.
9267
+ Vendor used for a Java version without a vendor prefix, such as `java@21`.
9246
9268
 
9247
9269
  ---
9248
9270
 
@@ -9260,24 +9282,24 @@ const settingsNode: SettingsNode = { ... }
9260
9282
 
9261
9283
  | **Name** | **Type** | **Description** |
9262
9284
  | --- | --- | --- |
9263
- | <code><a href="#mise-projen.SettingsNode.property.applyPatches">applyPatches</a></code> | <code>string</code> | A list of patch files or URLs to apply to node source. |
9264
- | <code><a href="#mise-projen.SettingsNode.property.cflags">cflags</a></code> | <code>string</code> | Additional CFLAGS options (e.g., to override -O3). |
9265
- | <code><a href="#mise-projen.SettingsNode.property.compile">compile</a></code> | <code>boolean</code> | Compile node from source. |
9266
- | <code><a href="#mise-projen.SettingsNode.property.concurrency">concurrency</a></code> | <code>number</code> | How many jobs should be used in compilation. |
9267
- | <code><a href="#mise-projen.SettingsNode.property.configureOpts">configureOpts</a></code> | <code>string</code> | Additional ./configure options. |
9268
- | <code><a href="#mise-projen.SettingsNode.property.corepack">corepack</a></code> | <code>boolean</code> | Installs the default corepack shims after installing any node version. |
9269
- | <code><a href="#mise-projen.SettingsNode.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> | Path to a file containing default npm packages to install. |
9270
- | <code><a href="#mise-projen.SettingsNode.property.flavor">flavor</a></code> | <code>string</code> | Install a specific node flavor like glibc-217 or musl. |
9271
- | <code><a href="#mise-projen.SettingsNode.property.gpgVerify">gpgVerify</a></code> | <code>boolean</code> | Verify OpenPGP signatures for node (built-in, no external gpg required). |
9272
- | <code><a href="#mise-projen.SettingsNode.property.make">make</a></code> | <code>string</code> | Make command to use. |
9273
- | <code><a href="#mise-projen.SettingsNode.property.makeInstallOpts">makeInstallOpts</a></code> | <code>string</code> | Additional make install options. |
9274
- | <code><a href="#mise-projen.SettingsNode.property.makeOpts">makeOpts</a></code> | <code>string</code> | Additional make options. |
9275
- | <code><a href="#mise-projen.SettingsNode.property.mirrorUrl">mirrorUrl</a></code> | <code>string</code> | Mirror to download node tarballs from. |
9276
- | <code><a href="#mise-projen.SettingsNode.property.ninja">ninja</a></code> | <code>boolean</code> | Use ninja instead of make to compile node. |
9277
- | <code><a href="#mise-projen.SettingsNode.property.nodenvRoot">nodenvRoot</a></code> | <code>string</code> | Directory for nodenv. |
9278
- | <code><a href="#mise-projen.SettingsNode.property.npmShim">npmShim</a></code> | <code>boolean</code> | Install a bash wrapper at bin/npm that triggers `mise reshim` after `npm install -g`. |
9279
- | <code><a href="#mise-projen.SettingsNode.property.nvmDir">nvmDir</a></code> | <code>string</code> | Directory for nvm. |
9280
- | <code><a href="#mise-projen.SettingsNode.property.verify">verify</a></code> | <code>boolean</code> | Verify the downloaded assets using GPG. |
9285
+ | <code><a href="#mise-projen.SettingsNode.property.applyPatches">applyPatches</a></code> | <code>string</code> | Patch files or URLs to apply to the Node.js source before building it. |
9286
+ | <code><a href="#mise-projen.SettingsNode.property.cflags">cflags</a></code> | <code>string</code> | Extra `CFLAGS` for compiling Node.js, for example to replace `-O3`. |
9287
+ | <code><a href="#mise-projen.SettingsNode.property.compile">compile</a></code> | <code>boolean</code> | Compile Node.js from source instead of using a precompiled build. |
9288
+ | <code><a href="#mise-projen.SettingsNode.property.concurrency">concurrency</a></code> | <code>number</code> | Number of parallel jobs (`make -j`) when compiling Node.js. |
9289
+ | <code><a href="#mise-projen.SettingsNode.property.configureOpts">configureOpts</a></code> | <code>string</code> | Extra arguments for `./configure` when compiling Node.js. |
9290
+ | <code><a href="#mise-projen.SettingsNode.property.corepack">corepack</a></code> | <code>boolean</code> | Run `corepack enable` after installing a Node.js version, so `yarn` and `pnpm` go through Corepack. |
9291
+ | <code><a href="#mise-projen.SettingsNode.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> | [deprecated] File listing npm packages to install globally into each new Node.js version. |
9292
+ | <code><a href="#mise-projen.SettingsNode.property.flavor">flavor</a></code> | <code>string</code> | Linux build flavor of Node.js to download, such as `musl` or `glibc-217`. |
9293
+ | <code><a href="#mise-projen.SettingsNode.property.gpgVerify">gpgVerify</a></code> | <code>boolean</code> | Check the OpenPGP signature of the `SHASUMS256.txt` file that `node.verify` checks downloads against. |
9294
+ | <code><a href="#mise-projen.SettingsNode.property.make">make</a></code> | <code>string</code> | Command to run instead of `make` when compiling Node.js, such as `gmake`. |
9295
+ | <code><a href="#mise-projen.SettingsNode.property.makeInstallOpts">makeInstallOpts</a></code> | <code>string</code> | Extra arguments for `make install` when compiling Node.js. |
9296
+ | <code><a href="#mise-projen.SettingsNode.property.makeOpts">makeOpts</a></code> | <code>string</code> | Extra arguments for `make` when compiling Node.js. |
9297
+ | <code><a href="#mise-projen.SettingsNode.property.mirrorUrl">mirrorUrl</a></code> | <code>string</code> | Base URL that mise downloads Node.js archives and their `SHASUMS256.txt` checksums from. |
9298
+ | <code><a href="#mise-projen.SettingsNode.property.ninja">ninja</a></code> | <code>boolean</code> | Build Node.js with ninja instead of make when compiling from source. |
9299
+ | <code><a href="#mise-projen.SettingsNode.property.nodenvRoot">nodenvRoot</a></code> | <code>string</code> | Root directory of nodenv, which `mise sync node --nodenv` imports Node.js versions from. |
9300
+ | <code><a href="#mise-projen.SettingsNode.property.npmShim">npmShim</a></code> | <code>boolean</code> | Wrap each Node.js version's `npm` so that `npm install -g` runs `mise reshim` afterwards. |
9301
+ | <code><a href="#mise-projen.SettingsNode.property.nvmDir">nvmDir</a></code> | <code>string</code> | Directory of nvm, which `mise sync node --nvm` imports Node.js versions from. |
9302
+ | <code><a href="#mise-projen.SettingsNode.property.verify">verify</a></code> | <code>boolean</code> | Verify downloaded Node.js archives against the SHA-256 checksums in `SHASUMS256.txt`. |
9281
9303
 
9282
9304
  ---
9283
9305
 
@@ -9289,7 +9311,7 @@ public readonly applyPatches: string;
9289
9311
 
9290
9312
  - *Type:* string
9291
9313
 
9292
- A list of patch files or URLs to apply to node source.
9314
+ Patch files or URLs to apply to the Node.js source before building it.
9293
9315
 
9294
9316
  ---
9295
9317
 
@@ -9301,7 +9323,7 @@ public readonly cflags: string;
9301
9323
 
9302
9324
  - *Type:* string
9303
9325
 
9304
- Additional CFLAGS options (e.g., to override -O3).
9326
+ Extra `CFLAGS` for compiling Node.js, for example to replace `-O3`.
9305
9327
 
9306
9328
  ---
9307
9329
 
@@ -9313,7 +9335,7 @@ public readonly compile: boolean;
9313
9335
 
9314
9336
  - *Type:* boolean
9315
9337
 
9316
- Compile node from source.
9338
+ Compile Node.js from source instead of using a precompiled build.
9317
9339
 
9318
9340
  ---
9319
9341
 
@@ -9325,7 +9347,7 @@ public readonly concurrency: number;
9325
9347
 
9326
9348
  - *Type:* number
9327
9349
 
9328
- How many jobs should be used in compilation.
9350
+ Number of parallel jobs (`make -j`) when compiling Node.js.
9329
9351
 
9330
9352
  ---
9331
9353
 
@@ -9337,7 +9359,7 @@ public readonly configureOpts: string;
9337
9359
 
9338
9360
  - *Type:* string
9339
9361
 
9340
- Additional ./configure options.
9362
+ Extra arguments for `./configure` when compiling Node.js.
9341
9363
 
9342
9364
  ---
9343
9365
 
@@ -9349,7 +9371,7 @@ public readonly corepack: boolean;
9349
9371
 
9350
9372
  - *Type:* boolean
9351
9373
 
9352
- Installs the default corepack shims after installing any node version.
9374
+ Run `corepack enable` after installing a Node.js version, so `yarn` and `pnpm` go through Corepack.
9353
9375
 
9354
9376
  ---
9355
9377
 
@@ -9361,7 +9383,7 @@ public readonly defaultPackagesFile: string;
9361
9383
 
9362
9384
  - *Type:* string
9363
9385
 
9364
- Path to a file containing default npm packages to install.
9386
+ [deprecated] File listing npm packages to install globally into each new Node.js version.
9365
9387
 
9366
9388
  ---
9367
9389
 
@@ -9373,9 +9395,7 @@ public readonly flavor: string;
9373
9395
 
9374
9396
  - *Type:* string
9375
9397
 
9376
- Install a specific node flavor like glibc-217 or musl.
9377
-
9378
- Use with unofficial node build repo.
9398
+ Linux build flavor of Node.js to download, such as `musl` or `glibc-217`.
9379
9399
 
9380
9400
  ---
9381
9401
 
@@ -9387,9 +9407,7 @@ public readonly gpgVerify: boolean;
9387
9407
 
9388
9408
  - *Type:* boolean
9389
9409
 
9390
- Verify OpenPGP signatures for node (built-in, no external gpg required).
9391
-
9392
- Set to false to disable.
9410
+ Check the OpenPGP signature of the `SHASUMS256.txt` file that `node.verify` checks downloads against.
9393
9411
 
9394
9412
  ---
9395
9413
 
@@ -9401,7 +9419,7 @@ public readonly make: string;
9401
9419
 
9402
9420
  - *Type:* string
9403
9421
 
9404
- Make command to use.
9422
+ Command to run instead of `make` when compiling Node.js, such as `gmake`.
9405
9423
 
9406
9424
  ---
9407
9425
 
@@ -9413,7 +9431,7 @@ public readonly makeInstallOpts: string;
9413
9431
 
9414
9432
  - *Type:* string
9415
9433
 
9416
- Additional make install options.
9434
+ Extra arguments for `make install` when compiling Node.js.
9417
9435
 
9418
9436
  ---
9419
9437
 
@@ -9425,7 +9443,7 @@ public readonly makeOpts: string;
9425
9443
 
9426
9444
  - *Type:* string
9427
9445
 
9428
- Additional make options.
9446
+ Extra arguments for `make` when compiling Node.js.
9429
9447
 
9430
9448
  ---
9431
9449
 
@@ -9437,7 +9455,7 @@ public readonly mirrorUrl: string;
9437
9455
 
9438
9456
  - *Type:* string
9439
9457
 
9440
- Mirror to download node tarballs from.
9458
+ Base URL that mise downloads Node.js archives and their `SHASUMS256.txt` checksums from.
9441
9459
 
9442
9460
  ---
9443
9461
 
@@ -9449,7 +9467,7 @@ public readonly ninja: boolean;
9449
9467
 
9450
9468
  - *Type:* boolean
9451
9469
 
9452
- Use ninja instead of make to compile node.
9470
+ Build Node.js with ninja instead of make when compiling from source.
9453
9471
 
9454
9472
  ---
9455
9473
 
@@ -9461,7 +9479,7 @@ public readonly nodenvRoot: string;
9461
9479
 
9462
9480
  - *Type:* string
9463
9481
 
9464
- Directory for nodenv.
9482
+ Root directory of nodenv, which `mise sync node --nodenv` imports Node.js versions from.
9465
9483
 
9466
9484
  ---
9467
9485
 
@@ -9473,9 +9491,7 @@ public readonly npmShim: boolean;
9473
9491
 
9474
9492
  - *Type:* boolean
9475
9493
 
9476
- Install a bash wrapper at bin/npm that triggers `mise reshim` after `npm install -g`.
9477
-
9478
- Disable to let corepack or a global `npm install -g npm@...` manage `bin/npm` directly.
9494
+ Wrap each Node.js version's `npm` so that `npm install -g` runs `mise reshim` afterwards.
9479
9495
 
9480
9496
  ---
9481
9497
 
@@ -9487,7 +9503,7 @@ public readonly nvmDir: string;
9487
9503
 
9488
9504
  - *Type:* string
9489
9505
 
9490
- Directory for nvm.
9506
+ Directory of nvm, which `mise sync node --nvm` imports Node.js versions from.
9491
9507
 
9492
9508
  ---
9493
9509
 
@@ -9499,7 +9515,7 @@ public readonly verify: boolean;
9499
9515
 
9500
9516
  - *Type:* boolean
9501
9517
 
9502
- Verify the downloaded assets using GPG.
9518
+ Verify downloaded Node.js archives against the SHA-256 checksums in `SHASUMS256.txt`.
9503
9519
 
9504
9520
  ---
9505
9521
 
@@ -9517,9 +9533,9 @@ const settingsNpm: SettingsNpm = { ... }
9517
9533
 
9518
9534
  | **Name** | **Type** | **Description** |
9519
9535
  | --- | --- | --- |
9520
- | <code><a href="#mise-projen.SettingsNpm.property.bun">bun</a></code> | <code>boolean</code> | Use bun instead of npm if bun is installed and on PATH. |
9521
- | <code><a href="#mise-projen.SettingsNpm.property.packageManager">packageManager</a></code> | <code><a href="#mise-projen.SettingsNpmPackageManager">SettingsNpmPackageManager</a></code> | Package manager to use for installing npm packages. |
9522
- | <code><a href="#mise-projen.SettingsNpm.property.shellOut">shellOut</a></code> | <code>boolean</code> | Shell out to the npm CLI for `npm:` version metadata and installs instead of mise's built-in aube-based implementation. |
9536
+ | <code><a href="#mise-projen.SettingsNpm.property.bun">bun</a></code> | <code>boolean</code> | [deprecated] Install `npm:` tools with bun; |
9537
+ | <code><a href="#mise-projen.SettingsNpm.property.packageManager">packageManager</a></code> | <code><a href="#mise-projen.SettingsNpmPackageManager">SettingsNpmPackageManager</a></code> | Package manager that installs `npm:` tools. |
9538
+ | <code><a href="#mise-projen.SettingsNpm.property.shellOut">shellOut</a></code> | <code>boolean</code> | Use the npm CLI instead of mise's built-in client for `npm:` version metadata and default installs. |
9523
9539
 
9524
9540
  ---
9525
9541
 
@@ -9531,7 +9547,9 @@ public readonly bun: boolean;
9531
9547
 
9532
9548
  - *Type:* boolean
9533
9549
 
9534
- Use bun instead of npm if bun is installed and on PATH.
9550
+ [deprecated] Install `npm:` tools with bun;
9551
+
9552
+ same as `npm.package_manager = "bun"`.
9535
9553
 
9536
9554
  ---
9537
9555
 
@@ -9543,7 +9561,7 @@ public readonly packageManager: SettingsNpmPackageManager;
9543
9561
 
9544
9562
  - *Type:* <a href="#mise-projen.SettingsNpmPackageManager">SettingsNpmPackageManager</a>
9545
9563
 
9546
- Package manager to use for installing npm packages.
9564
+ Package manager that installs `npm:` tools.
9547
9565
 
9548
9566
  ---
9549
9567
 
@@ -9555,7 +9573,7 @@ public readonly shellOut: boolean;
9555
9573
 
9556
9574
  - *Type:* boolean
9557
9575
 
9558
- Shell out to the npm CLI for `npm:` version metadata and installs instead of mise's built-in aube-based implementation.
9576
+ Use the npm CLI instead of mise's built-in client for `npm:` version metadata and default installs.
9559
9577
 
9560
9578
  ---
9561
9579
 
@@ -9573,9 +9591,9 @@ const settingsOci: SettingsOci = { ... }
9573
9591
 
9574
9592
  | **Name** | **Type** | **Description** |
9575
9593
  | --- | --- | --- |
9576
- | <code><a href="#mise-projen.SettingsOci.property.defaultFrom">defaultFrom</a></code> | <code>string</code> | Default base image for `mise oci build` when [oci].from is not set. |
9577
- | <code><a href="#mise-projen.SettingsOci.property.defaultMountPoint">defaultMountPoint</a></code> | <code>string</code> | Path inside OCI images where mise tools are installed. |
9578
- | <code><a href="#mise-projen.SettingsOci.property.insecureRegistries">insecureRegistries</a></code> | <code>string[]</code> | Registries (host or host:port) contacted over plain HTTP instead of HTTPS. |
9594
+ | <code><a href="#mise-projen.SettingsOci.property.defaultFrom">defaultFrom</a></code> | <code>string</code> | [experimental] Base image for `mise oci` builds when neither `[oci].from` nor `--from` sets one. |
9595
+ | <code><a href="#mise-projen.SettingsOci.property.defaultMountPoint">defaultMountPoint</a></code> | <code>string</code> | [experimental] Directory inside `mise oci` images that holds tool installs, unless `[oci].mount_point` sets one. |
9596
+ | <code><a href="#mise-projen.SettingsOci.property.insecureRegistries">insecureRegistries</a></code> | <code>string[]</code> | Registries, as `host` or `host:port`, that mise contacts over plain HTTP instead of HTTPS. |
9579
9597
 
9580
9598
  ---
9581
9599
 
@@ -9587,7 +9605,7 @@ public readonly defaultFrom: string;
9587
9605
 
9588
9606
  - *Type:* string
9589
9607
 
9590
- Default base image for `mise oci build` when [oci].from is not set.
9608
+ [experimental] Base image for `mise oci` builds when neither `[oci].from` nor `--from` sets one.
9591
9609
 
9592
9610
  ---
9593
9611
 
@@ -9599,7 +9617,7 @@ public readonly defaultMountPoint: string;
9599
9617
 
9600
9618
  - *Type:* string
9601
9619
 
9602
- Path inside OCI images where mise tools are installed.
9620
+ [experimental] Directory inside `mise oci` images that holds tool installs, unless `[oci].mount_point` sets one.
9603
9621
 
9604
9622
  ---
9605
9623
 
@@ -9611,7 +9629,7 @@ public readonly insecureRegistries: string[];
9611
9629
 
9612
9630
  - *Type:* string[]
9613
9631
 
9614
- Registries (host or host:port) contacted over plain HTTP instead of HTTPS.
9632
+ Registries, as `host` or `host:port`, that mise contacts over plain HTTP instead of HTTPS.
9615
9633
 
9616
9634
  ---
9617
9635
 
@@ -9629,8 +9647,8 @@ const settingsOtel: SettingsOtel = { ... }
9629
9647
 
9630
9648
  | **Name** | **Type** | **Description** |
9631
9649
  | --- | --- | --- |
9632
- | <code><a href="#mise-projen.SettingsOtel.property.enabled">enabled</a></code> | <code>boolean</code> | [experimental] Enable OpenTelemetry trace export for task executions. |
9633
- | <code><a href="#mise-projen.SettingsOtel.property.logs">logs</a></code> | <code>boolean</code> | [experimental] Enable OpenTelemetry log export for task stdout/stderr. |
9650
+ | <code><a href="#mise-projen.SettingsOtel.property.enabled">enabled</a></code> | <code>boolean</code> | [experimental] Export OpenTelemetry traces of `mise run`. |
9651
+ | <code><a href="#mise-projen.SettingsOtel.property.logs">logs</a></code> | <code>boolean</code> | [experimental] Export each line of task stdout and stderr as an OpenTelemetry log record. |
9634
9652
 
9635
9653
  ---
9636
9654
 
@@ -9642,7 +9660,7 @@ public readonly enabled: boolean;
9642
9660
 
9643
9661
  - *Type:* boolean
9644
9662
 
9645
- [experimental] Enable OpenTelemetry trace export for task executions.
9663
+ [experimental] Export OpenTelemetry traces of `mise run`.
9646
9664
 
9647
9665
  ---
9648
9666
 
@@ -9654,7 +9672,7 @@ public readonly logs: boolean;
9654
9672
 
9655
9673
  - *Type:* boolean
9656
9674
 
9657
- [experimental] Enable OpenTelemetry log export for task stdout/stderr.
9675
+ [experimental] Export each line of task stdout and stderr as an OpenTelemetry log record.
9658
9676
 
9659
9677
  ---
9660
9678
 
@@ -9672,8 +9690,8 @@ const settingsPackslip: SettingsPackslip = { ... }
9672
9690
 
9673
9691
  | **Name** | **Type** | **Description** |
9674
9692
  | --- | --- | --- |
9675
- | <code><a href="#mise-projen.SettingsPackslip.property.exec">exec</a></code> | <code>boolean</code> | Run a tool's own command at install time to produce a resource its packslip offers only as an exec entry, such as an agent skill. |
9676
- | <code><a href="#mise-projen.SettingsPackslip.property.stampers">stampers</a></code> | <code>string[]</code> | Hosts whose signed stamp lists say which packslip releases may be installed, each with its pin. |
9693
+ | <code><a href="#mise-projen.SettingsPackslip.property.exec">exec</a></code> | <code>boolean</code> | Let packslip tools run their own executable at install time to generate resources, such as an agent skill. |
9694
+ | <code><a href="#mise-projen.SettingsPackslip.property.stampers">stampers</a></code> | <code>string[]</code> | Hosts that must approve a packslip release before mise lists or installs it, each as `host=PIN`. |
9677
9695
 
9678
9696
  ---
9679
9697
 
@@ -9685,7 +9703,7 @@ public readonly exec: boolean;
9685
9703
 
9686
9704
  - *Type:* boolean
9687
9705
 
9688
- Run a tool's own command at install time to produce a resource its packslip offers only as an exec entry, such as an agent skill.
9706
+ Let packslip tools run their own executable at install time to generate resources, such as an agent skill.
9689
9707
 
9690
9708
  ---
9691
9709
 
@@ -9697,7 +9715,7 @@ public readonly stampers: string[];
9697
9715
 
9698
9716
  - *Type:* string[]
9699
9717
 
9700
- Hosts whose signed stamp lists say which packslip releases may be installed, each with its pin.
9718
+ Hosts that must approve a packslip release before mise lists or installs it, each as `host=PIN`.
9701
9719
 
9702
9720
  ---
9703
9721
 
@@ -9715,8 +9733,8 @@ const settingsPipx: SettingsPipx = { ... }
9715
9733
 
9716
9734
  | **Name** | **Type** | **Description** |
9717
9735
  | --- | --- | --- |
9718
- | <code><a href="#mise-projen.SettingsPipx.property.registryUrl">registryUrl</a></code> | <code>string</code> | URL to use for pipx registry. |
9719
- | <code><a href="#mise-projen.SettingsPipx.property.uvx">uvx</a></code> | <code>boolean</code> | Use uvx instead of pipx if uv is installed and on PATH. |
9736
+ | <code><a href="#mise-projen.SettingsPipx.property.registryUrl">registryUrl</a></code> | <code>string</code> | Older name for `pypi.registry_url`. |
9737
+ | <code><a href="#mise-projen.SettingsPipx.property.uvx">uvx</a></code> | <code>boolean</code> | Older name for `pypi.uvx`. |
9720
9738
 
9721
9739
  ---
9722
9740
 
@@ -9728,7 +9746,7 @@ public readonly registryUrl: string;
9728
9746
 
9729
9747
  - *Type:* string
9730
9748
 
9731
- URL to use for pipx registry.
9749
+ Older name for `pypi.registry_url`.
9732
9750
 
9733
9751
  ---
9734
9752
 
@@ -9740,7 +9758,7 @@ public readonly uvx: boolean;
9740
9758
 
9741
9759
  - *Type:* boolean
9742
9760
 
9743
- Use uvx instead of pipx if uv is installed and on PATH.
9761
+ Older name for `pypi.uvx`.
9744
9762
 
9745
9763
  ---
9746
9764
 
@@ -9788,8 +9806,8 @@ const settingsPypi: SettingsPypi = { ... }
9788
9806
 
9789
9807
  | **Name** | **Type** | **Description** |
9790
9808
  | --- | --- | --- |
9791
- | <code><a href="#mise-projen.SettingsPypi.property.registryUrl">registryUrl</a></code> | <code>string</code> | Package registry URL for Python tools (pipx.registry_url is a compatibility alias). |
9792
- | <code><a href="#mise-projen.SettingsPypi.property.uvx">uvx</a></code> | <code>boolean</code> | Use uv for Python tools when available (pipx.uvx is a compatibility alias). |
9809
+ | <code><a href="#mise-projen.SettingsPypi.property.registryUrl">registryUrl</a></code> | <code>string</code> | Package index URL that `pypi:` tools list versions from, with `{}` in place of the package name. |
9810
+ | <code><a href="#mise-projen.SettingsPypi.property.uvx">uvx</a></code> | <code>boolean</code> | Install `pypi:` tools with uv when uv is available, and with pipx otherwise. |
9793
9811
 
9794
9812
  ---
9795
9813
 
@@ -9801,7 +9819,7 @@ public readonly registryUrl: string;
9801
9819
 
9802
9820
  - *Type:* string
9803
9821
 
9804
- Package registry URL for Python tools (pipx.registry_url is a compatibility alias).
9822
+ Package index URL that `pypi:` tools list versions from, with `{}` in place of the package name.
9805
9823
 
9806
9824
  ---
9807
9825
 
@@ -9813,7 +9831,7 @@ public readonly uvx: boolean;
9813
9831
 
9814
9832
  - *Type:* boolean
9815
9833
 
9816
- Use uv for Python tools when available (pipx.uvx is a compatibility alias).
9834
+ Install `pypi:` tools with uv when uv is available, and with pipx otherwise.
9817
9835
 
9818
9836
  ---
9819
9837
 
@@ -9831,19 +9849,19 @@ const settingsPython: SettingsPython = { ... }
9831
9849
 
9832
9850
  | **Name** | **Type** | **Description** |
9833
9851
  | --- | --- | --- |
9834
- | <code><a href="#mise-projen.SettingsPython.property.compile">compile</a></code> | <code>boolean</code> | If true, compile python from source. |
9835
- | <code><a href="#mise-projen.SettingsPython.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> | Path to a file containing default python packages to install when installing a python version. |
9836
- | <code><a href="#mise-projen.SettingsPython.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Enable GitHub Artifact Attestations verification for precompiled Python binaries. |
9837
- | <code><a href="#mise-projen.SettingsPython.property.patchesDirectory">patchesDirectory</a></code> | <code>string</code> | Directory to fetch python patches from. |
9838
- | <code><a href="#mise-projen.SettingsPython.property.patchUrl">patchUrl</a></code> | <code>string</code> | URL to fetch python patches from to pass to python-build. |
9839
- | <code><a href="#mise-projen.SettingsPython.property.precompiledArch">precompiledArch</a></code> | <code>string</code> | Specify the architecture to use for precompiled binaries. |
9840
- | <code><a href="#mise-projen.SettingsPython.property.precompiledFlavor">precompiledFlavor</a></code> | <code>string</code> | Specify the flavor to use for precompiled binaries. |
9841
- | <code><a href="#mise-projen.SettingsPython.property.precompiledOs">precompiledOs</a></code> | <code>string</code> | Specify the OS to use for precompiled binaries. |
9842
- | <code><a href="#mise-projen.SettingsPython.property.pyenvRepo">pyenvRepo</a></code> | <code>string</code> | URL to fetch pyenv from for compiling python with python-build. |
9843
- | <code><a href="#mise-projen.SettingsPython.property.uvVenvAuto">uvVenvAuto</a></code> | <code><a href="#mise-projen.SettingsPythonUvVenvAuto">SettingsPythonUvVenvAuto</a></code> | Integrate with uv to manage project venvs when uv.lock is present. |
9844
- | <code><a href="#mise-projen.SettingsPython.property.uvVenvCreateArgs">uvVenvCreateArgs</a></code> | <code>string[]</code> | Arguments to pass to uv when creating a venv. |
9845
- | <code><a href="#mise-projen.SettingsPython.property.venvCreateArgs">venvCreateArgs</a></code> | <code>string[]</code> | Arguments to pass to python when creating a venv. |
9846
- | <code><a href="#mise-projen.SettingsPython.property.venvStdlib">venvStdlib</a></code> | <code>boolean</code> | Prefer to use venv from Python's standard library. |
9852
+ | <code><a href="#mise-projen.SettingsPython.property.compile">compile</a></code> | <code>boolean</code> | Compile Python from source with python-build instead of using a precompiled build. |
9853
+ | <code><a href="#mise-projen.SettingsPython.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> | [deprecated] Requirements file that mise installs with pip into each new Python version. |
9854
+ | <code><a href="#mise-projen.SettingsPython.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Verify GitHub artifact attestations of precompiled Python builds from python-build-standalone. |
9855
+ | <code><a href="#mise-projen.SettingsPython.property.patchesDirectory">patchesDirectory</a></code> | <code>string</code> | Directory of per-version patches for the Python versions that python-build compiles. |
9856
+ | <code><a href="#mise-projen.SettingsPython.property.patchUrl">patchUrl</a></code> | <code>string</code> | URL of a patch that python-build applies to every Python version it compiles. |
9857
+ | <code><a href="#mise-projen.SettingsPython.property.precompiledArch">precompiledArch</a></code> | <code>string</code> | Architecture of the python-build-standalone build that mise downloads, such as `x86_64_v3` or `aarch64`. |
9858
+ | <code><a href="#mise-projen.SettingsPython.property.precompiledFlavor">precompiledFlavor</a></code> | <code>string</code> | Build flavor of python-build-standalone to download, such as `install_only` or `freethreaded-install_only_stripped`. |
9859
+ | <code><a href="#mise-projen.SettingsPython.property.precompiledOs">precompiledOs</a></code> | <code>string</code> | OS part of the python-build-standalone build name that mise downloads, such as `unknown-linux-musl`. |
9860
+ | <code><a href="#mise-projen.SettingsPython.property.pyenvRepo">pyenvRepo</a></code> | <code>string</code> | Git repository that mise clones pyenv from to get python-build. |
9861
+ | <code><a href="#mise-projen.SettingsPython.property.uvVenvAuto">uvVenvAuto</a></code> | <code><a href="#mise-projen.SettingsPythonUvVenvAuto">SettingsPythonUvVenvAuto</a></code> | Activate, and optionally create, the virtualenv of the uv project around the current directory. |
9862
+ | <code><a href="#mise-projen.SettingsPython.property.uvVenvCreateArgs">uvVenvCreateArgs</a></code> | <code>string[]</code> | Arguments for `uv venv` when mise creates a virtualenv with uv. |
9863
+ | <code><a href="#mise-projen.SettingsPython.property.venvCreateArgs">venvCreateArgs</a></code> | <code>string[]</code> | Arguments for `python -m venv` when `_.python.venv` creates a virtualenv without uv. |
9864
+ | <code><a href="#mise-projen.SettingsPython.property.venvStdlib">venvStdlib</a></code> | <code>boolean</code> | Create `_.python.venv` virtualenvs with `python -m venv` even when uv is installed. |
9847
9865
 
9848
9866
  ---
9849
9867
 
@@ -9855,9 +9873,7 @@ public readonly compile: boolean;
9855
9873
 
9856
9874
  - *Type:* boolean
9857
9875
 
9858
- If true, compile python from source.
9859
-
9860
- If false, use precompiled binaries. If not set, use precompiled binaries if available.
9876
+ Compile Python from source with python-build instead of using a precompiled build.
9861
9877
 
9862
9878
  ---
9863
9879
 
@@ -9869,7 +9885,7 @@ public readonly defaultPackagesFile: string;
9869
9885
 
9870
9886
  - *Type:* string
9871
9887
 
9872
- Path to a file containing default python packages to install when installing a python version.
9888
+ [deprecated] Requirements file that mise installs with pip into each new Python version.
9873
9889
 
9874
9890
  ---
9875
9891
 
@@ -9881,7 +9897,7 @@ public readonly githubAttestations: boolean;
9881
9897
 
9882
9898
  - *Type:* boolean
9883
9899
 
9884
- Enable GitHub Artifact Attestations verification for precompiled Python binaries.
9900
+ Verify GitHub artifact attestations of precompiled Python builds from python-build-standalone.
9885
9901
 
9886
9902
  ---
9887
9903
 
@@ -9893,7 +9909,7 @@ public readonly patchesDirectory: string;
9893
9909
 
9894
9910
  - *Type:* string
9895
9911
 
9896
- Directory to fetch python patches from.
9912
+ Directory of per-version patches for the Python versions that python-build compiles.
9897
9913
 
9898
9914
  ---
9899
9915
 
@@ -9905,7 +9921,7 @@ public readonly patchUrl: string;
9905
9921
 
9906
9922
  - *Type:* string
9907
9923
 
9908
- URL to fetch python patches from to pass to python-build.
9924
+ URL of a patch that python-build applies to every Python version it compiles.
9909
9925
 
9910
9926
  ---
9911
9927
 
@@ -9917,7 +9933,7 @@ public readonly precompiledArch: string;
9917
9933
 
9918
9934
  - *Type:* string
9919
9935
 
9920
- Specify the architecture to use for precompiled binaries.
9936
+ Architecture of the python-build-standalone build that mise downloads, such as `x86_64_v3` or `aarch64`.
9921
9937
 
9922
9938
  ---
9923
9939
 
@@ -9929,7 +9945,7 @@ public readonly precompiledFlavor: string;
9929
9945
 
9930
9946
  - *Type:* string
9931
9947
 
9932
- Specify the flavor to use for precompiled binaries.
9948
+ Build flavor of python-build-standalone to download, such as `install_only` or `freethreaded-install_only_stripped`.
9933
9949
 
9934
9950
  ---
9935
9951
 
@@ -9941,7 +9957,7 @@ public readonly precompiledOs: string;
9941
9957
 
9942
9958
  - *Type:* string
9943
9959
 
9944
- Specify the OS to use for precompiled binaries.
9960
+ OS part of the python-build-standalone build name that mise downloads, such as `unknown-linux-musl`.
9945
9961
 
9946
9962
  ---
9947
9963
 
@@ -9953,7 +9969,7 @@ public readonly pyenvRepo: string;
9953
9969
 
9954
9970
  - *Type:* string
9955
9971
 
9956
- URL to fetch pyenv from for compiling python with python-build.
9972
+ Git repository that mise clones pyenv from to get python-build.
9957
9973
 
9958
9974
  ---
9959
9975
 
@@ -9965,7 +9981,7 @@ public readonly uvVenvAuto: SettingsPythonUvVenvAuto;
9965
9981
 
9966
9982
  - *Type:* <a href="#mise-projen.SettingsPythonUvVenvAuto">SettingsPythonUvVenvAuto</a>
9967
9983
 
9968
- Integrate with uv to manage project venvs when uv.lock is present.
9984
+ Activate, and optionally create, the virtualenv of the uv project around the current directory.
9969
9985
 
9970
9986
  ---
9971
9987
 
@@ -9977,7 +9993,7 @@ public readonly uvVenvCreateArgs: string[];
9977
9993
 
9978
9994
  - *Type:* string[]
9979
9995
 
9980
- Arguments to pass to uv when creating a venv.
9996
+ Arguments for `uv venv` when mise creates a virtualenv with uv.
9981
9997
 
9982
9998
  ---
9983
9999
 
@@ -9989,9 +10005,7 @@ public readonly venvCreateArgs: string[];
9989
10005
 
9990
10006
  - *Type:* string[]
9991
10007
 
9992
- Arguments to pass to python when creating a venv.
9993
-
9994
- (not used for uv venv creation)
10008
+ Arguments for `python -m venv` when `_.python.venv` creates a virtualenv without uv.
9995
10009
 
9996
10010
  ---
9997
10011
 
@@ -10003,7 +10017,7 @@ public readonly venvStdlib: boolean;
10003
10017
 
10004
10018
  - *Type:* boolean
10005
10019
 
10006
- Prefer to use venv from Python's standard library.
10020
+ Create `_.python.venv` virtualenvs with `python -m venv` even when uv is installed.
10007
10021
 
10008
10022
  ---
10009
10023
 
@@ -10021,20 +10035,20 @@ const settingsRuby: SettingsRuby = { ... }
10021
10035
 
10022
10036
  | **Name** | **Type** | **Description** |
10023
10037
  | --- | --- | --- |
10024
- | <code><a href="#mise-projen.SettingsRuby.property.applyPatches">applyPatches</a></code> | <code>string</code> | A list of patch files or URLs to apply to ruby source. |
10025
- | <code><a href="#mise-projen.SettingsRuby.property.compile">compile</a></code> | <code>boolean</code> | If true, compile ruby from source. |
10026
- | <code><a href="#mise-projen.SettingsRuby.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> | Path to a file containing default ruby gems to install when installing ruby. |
10027
- | <code><a href="#mise-projen.SettingsRuby.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Enable GitHub Artifact Attestations verification for precompiled Ruby binaries. |
10028
- | <code><a href="#mise-projen.SettingsRuby.property.precompiledArch">precompiledArch</a></code> | <code>string</code> | Override architecture identifier for precompiled Ruby binaries. |
10029
- | <code><a href="#mise-projen.SettingsRuby.property.precompiledOs">precompiledOs</a></code> | <code>string</code> | Override OS identifier for precompiled Ruby binaries. |
10030
- | <code><a href="#mise-projen.SettingsRuby.property.precompiledUrl">precompiledUrl</a></code> | <code>string</code> | URL template or GitHub repo for precompiled Ruby binaries. |
10031
- | <code><a href="#mise-projen.SettingsRuby.property.rubyBuildCliOpts">rubyBuildCliOpts</a></code> | <code>string</code> | CLI options passed directly to ruby-build before the version and install prefix. |
10032
- | <code><a href="#mise-projen.SettingsRuby.property.rubyBuildOpts">rubyBuildOpts</a></code> | <code>string</code> | Configure arguments passed through ruby-build after `--`. |
10033
- | <code><a href="#mise-projen.SettingsRuby.property.rubyBuildRepo">rubyBuildRepo</a></code> | <code>string</code> | The URL used to fetch ruby-build. |
10034
- | <code><a href="#mise-projen.SettingsRuby.property.rubyInstall">rubyInstall</a></code> | <code>boolean</code> | Use ruby-install instead of ruby-build. |
10035
- | <code><a href="#mise-projen.SettingsRuby.property.rubyInstallOpts">rubyInstallOpts</a></code> | <code>string</code> | Options to pass to ruby-install. |
10036
- | <code><a href="#mise-projen.SettingsRuby.property.rubyInstallRepo">rubyInstallRepo</a></code> | <code>string</code> | The URL used to fetch ruby-install. |
10037
- | <code><a href="#mise-projen.SettingsRuby.property.verboseInstall">verboseInstall</a></code> | <code>boolean</code> | Set to true to enable verbose output during ruby installation. |
10038
+ | <code><a href="#mise-projen.SettingsRuby.property.applyPatches">applyPatches</a></code> | <code>string</code> | Patch files or URLs to apply to the Ruby source before compiling it, one per line. |
10039
+ | <code><a href="#mise-projen.SettingsRuby.property.compile">compile</a></code> | <code>boolean</code> | Compile Ruby from source instead of using a precompiled build. |
10040
+ | <code><a href="#mise-projen.SettingsRuby.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> | [deprecated] File listing gems to install into each new Ruby version. |
10041
+ | <code><a href="#mise-projen.SettingsRuby.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Verify GitHub artifact attestations of precompiled Ruby builds. |
10042
+ | <code><a href="#mise-projen.SettingsRuby.property.precompiledArch">precompiledArch</a></code> | <code>string</code> | Architecture name of precompiled Ruby builds, such as `x86_64` or `arm64`, used with `ruby.precompiled_os`. |
10043
+ | <code><a href="#mise-projen.SettingsRuby.property.precompiledOs">precompiledOs</a></code> | <code>string</code> | OS name of precompiled Ruby builds, such as `linux`, used with `ruby.precompiled_arch`. |
10044
+ | <code><a href="#mise-projen.SettingsRuby.property.precompiledUrl">precompiledUrl</a></code> | <code>string</code> | GitHub repository, as `owner/repo`, or URL template that mise downloads precompiled Ruby builds from. |
10045
+ | <code><a href="#mise-projen.SettingsRuby.property.rubyBuildCliOpts">rubyBuildCliOpts</a></code> | <code>string</code> | Options for ruby-build itself, such as `--keep`, passed before the version and install directory. |
10046
+ | <code><a href="#mise-projen.SettingsRuby.property.rubyBuildOpts">rubyBuildOpts</a></code> | <code>string</code> | Arguments for Ruby's `configure`, such as `--enable-yjit`, passed through ruby-build. |
10047
+ | <code><a href="#mise-projen.SettingsRuby.property.rubyBuildRepo">rubyBuildRepo</a></code> | <code>string</code> | Git repository or ZIP archive URL that mise gets ruby-build from. |
10048
+ | <code><a href="#mise-projen.SettingsRuby.property.rubyInstall">rubyInstall</a></code> | <code>boolean</code> | Compile Ruby with ruby-install instead of ruby-build. |
10049
+ | <code><a href="#mise-projen.SettingsRuby.property.rubyInstallOpts">rubyInstallOpts</a></code> | <code>string</code> | Arguments for Ruby's `configure`, passed through ruby-install. |
10050
+ | <code><a href="#mise-projen.SettingsRuby.property.rubyInstallRepo">rubyInstallRepo</a></code> | <code>string</code> | Git repository or ZIP archive URL that mise gets ruby-install from. |
10051
+ | <code><a href="#mise-projen.SettingsRuby.property.verboseInstall">verboseInstall</a></code> | <code>boolean</code> | Show ruby-build's full output while compiling Ruby. |
10038
10052
 
10039
10053
  ---
10040
10054
 
@@ -10046,7 +10060,7 @@ public readonly applyPatches: string;
10046
10060
 
10047
10061
  - *Type:* string
10048
10062
 
10049
- A list of patch files or URLs to apply to ruby source.
10063
+ Patch files or URLs to apply to the Ruby source before compiling it, one per line.
10050
10064
 
10051
10065
  ---
10052
10066
 
@@ -10058,9 +10072,7 @@ public readonly compile: boolean;
10058
10072
 
10059
10073
  - *Type:* boolean
10060
10074
 
10061
- If true, compile ruby from source.
10062
-
10063
- If false, require precompiled binaries. If not set, use precompiled binaries if available.
10075
+ Compile Ruby from source instead of using a precompiled build.
10064
10076
 
10065
10077
  ---
10066
10078
 
@@ -10072,7 +10084,7 @@ public readonly defaultPackagesFile: string;
10072
10084
 
10073
10085
  - *Type:* string
10074
10086
 
10075
- Path to a file containing default ruby gems to install when installing ruby.
10087
+ [deprecated] File listing gems to install into each new Ruby version.
10076
10088
 
10077
10089
  ---
10078
10090
 
@@ -10084,7 +10096,7 @@ public readonly githubAttestations: boolean;
10084
10096
 
10085
10097
  - *Type:* boolean
10086
10098
 
10087
- Enable GitHub Artifact Attestations verification for precompiled Ruby binaries.
10099
+ Verify GitHub artifact attestations of precompiled Ruby builds.
10088
10100
 
10089
10101
  ---
10090
10102
 
@@ -10096,7 +10108,7 @@ public readonly precompiledArch: string;
10096
10108
 
10097
10109
  - *Type:* string
10098
10110
 
10099
- Override architecture identifier for precompiled Ruby binaries.
10111
+ Architecture name of precompiled Ruby builds, such as `x86_64` or `arm64`, used with `ruby.precompiled_os`.
10100
10112
 
10101
10113
  ---
10102
10114
 
@@ -10108,7 +10120,7 @@ public readonly precompiledOs: string;
10108
10120
 
10109
10121
  - *Type:* string
10110
10122
 
10111
- Override OS identifier for precompiled Ruby binaries.
10123
+ OS name of precompiled Ruby builds, such as `linux`, used with `ruby.precompiled_arch`.
10112
10124
 
10113
10125
  ---
10114
10126
 
@@ -10120,7 +10132,7 @@ public readonly precompiledUrl: string;
10120
10132
 
10121
10133
  - *Type:* string
10122
10134
 
10123
- URL template or GitHub repo for precompiled Ruby binaries.
10135
+ GitHub repository, as `owner/repo`, or URL template that mise downloads precompiled Ruby builds from.
10124
10136
 
10125
10137
  ---
10126
10138
 
@@ -10132,7 +10144,7 @@ public readonly rubyBuildCliOpts: string;
10132
10144
 
10133
10145
  - *Type:* string
10134
10146
 
10135
- CLI options passed directly to ruby-build before the version and install prefix.
10147
+ Options for ruby-build itself, such as `--keep`, passed before the version and install directory.
10136
10148
 
10137
10149
  ---
10138
10150
 
@@ -10144,7 +10156,7 @@ public readonly rubyBuildOpts: string;
10144
10156
 
10145
10157
  - *Type:* string
10146
10158
 
10147
- Configure arguments passed through ruby-build after `--`.
10159
+ Arguments for Ruby's `configure`, such as `--enable-yjit`, passed through ruby-build.
10148
10160
 
10149
10161
  ---
10150
10162
 
@@ -10156,9 +10168,7 @@ public readonly rubyBuildRepo: string;
10156
10168
 
10157
10169
  - *Type:* string
10158
10170
 
10159
- The URL used to fetch ruby-build.
10160
-
10161
- This accepts either a Git repository or a ZIP archive.
10171
+ Git repository or ZIP archive URL that mise gets ruby-build from.
10162
10172
 
10163
10173
  ---
10164
10174
 
@@ -10170,7 +10180,7 @@ public readonly rubyInstall: boolean;
10170
10180
 
10171
10181
  - *Type:* boolean
10172
10182
 
10173
- Use ruby-install instead of ruby-build.
10183
+ Compile Ruby with ruby-install instead of ruby-build.
10174
10184
 
10175
10185
  ---
10176
10186
 
@@ -10182,7 +10192,7 @@ public readonly rubyInstallOpts: string;
10182
10192
 
10183
10193
  - *Type:* string
10184
10194
 
10185
- Options to pass to ruby-install.
10195
+ Arguments for Ruby's `configure`, passed through ruby-install.
10186
10196
 
10187
10197
  ---
10188
10198
 
@@ -10194,9 +10204,7 @@ public readonly rubyInstallRepo: string;
10194
10204
 
10195
10205
  - *Type:* string
10196
10206
 
10197
- The URL used to fetch ruby-install.
10198
-
10199
- This accepts either a Git repository or a ZIP archive.
10207
+ Git repository or ZIP archive URL that mise gets ruby-install from.
10200
10208
 
10201
10209
  ---
10202
10210
 
@@ -10208,7 +10216,7 @@ public readonly verboseInstall: boolean;
10208
10216
 
10209
10217
  - *Type:* boolean
10210
10218
 
10211
- Set to true to enable verbose output during ruby installation.
10219
+ Show ruby-build's full output while compiling Ruby.
10212
10220
 
10213
10221
  ---
10214
10222
 
@@ -10226,9 +10234,9 @@ const settingsRust: SettingsRust = { ... }
10226
10234
 
10227
10235
  | **Name** | **Type** | **Description** |
10228
10236
  | --- | --- | --- |
10229
- | <code><a href="#mise-projen.SettingsRust.property.cargoHome">cargoHome</a></code> | <code>string</code> | Path to the cargo home directory. |
10230
- | <code><a href="#mise-projen.SettingsRust.property.defaultHost">defaultHost</a></code> | <code>string</code> | Default host triple to pass to `rustup init` via `--default-host`. |
10231
- | <code><a href="#mise-projen.SettingsRust.property.rustupHome">rustupHome</a></code> | <code>string</code> | Path to the rustup home directory. |
10237
+ | <code><a href="#mise-projen.SettingsRust.property.cargoHome">cargoHome</a></code> | <code>string</code> | Directory used as `CARGO_HOME` for the Rust toolchains that mise manages. |
10238
+ | <code><a href="#mise-projen.SettingsRust.property.defaultHost">defaultHost</a></code> | <code>string</code> | Host triple that mise passes to `rustup init` as `--default-host`. |
10239
+ | <code><a href="#mise-projen.SettingsRust.property.rustupHome">rustupHome</a></code> | <code>string</code> | Directory used as `RUSTUP_HOME` for the Rust toolchains that mise manages. |
10232
10240
 
10233
10241
  ---
10234
10242
 
@@ -10239,11 +10247,8 @@ public readonly cargoHome: string;
10239
10247
  ```
10240
10248
 
10241
10249
  - *Type:* string
10242
- - *Default:* cargo` or `%USERPROFILE%\.cargo`
10243
-
10244
- Path to the cargo home directory.
10245
10250
 
10246
- Defaults to `~/.cargo` or `%USERPROFILE%\.cargo`
10251
+ Directory used as `CARGO_HOME` for the Rust toolchains that mise manages.
10247
10252
 
10248
10253
  ---
10249
10254
 
@@ -10255,7 +10260,7 @@ public readonly defaultHost: string;
10255
10260
 
10256
10261
  - *Type:* string
10257
10262
 
10258
- Default host triple to pass to `rustup init` via `--default-host`.
10263
+ Host triple that mise passes to `rustup init` as `--default-host`.
10259
10264
 
10260
10265
  ---
10261
10266
 
@@ -10266,11 +10271,8 @@ public readonly rustupHome: string;
10266
10271
  ```
10267
10272
 
10268
10273
  - *Type:* string
10269
- - *Default:* rustup` or `%USERPROFILE%\.rustup`
10270
10274
 
10271
- Path to the rustup home directory.
10272
-
10273
- Defaults to `~/.rustup` or `%USERPROFILE%\.rustup`
10275
+ Directory used as `RUSTUP_HOME` for the Rust toolchains that mise manages.
10274
10276
 
10275
10277
  ---
10276
10278
 
@@ -10288,7 +10290,7 @@ const settingsSandbox: SettingsSandbox = { ... }
10288
10290
 
10289
10291
  | **Name** | **Type** | **Description** |
10290
10292
  | --- | --- | --- |
10291
- | <code><a href="#mise-projen.SettingsSandbox.property.denyAll">denyAll</a></code> | <code>boolean</code> | Deny filesystem reads and writes, network access, and environment variable inheritance by default for `mise run` and `mise exec`. |
10293
+ | <code><a href="#mise-projen.SettingsSandbox.property.denyAll">denyAll</a></code> | <code>boolean</code> | Deny filesystem access, network access and inherited environment variables by default for `mise run` and `mise exec`. |
10292
10294
  | <code><a href="#mise-projen.SettingsSandbox.property.denyEnv">denyEnv</a></code> | <code>boolean</code> | Deny environment variable inheritance by default for `mise run` and `mise exec`. |
10293
10295
  | <code><a href="#mise-projen.SettingsSandbox.property.denyNet">denyNet</a></code> | <code>boolean</code> | Deny network access by default for `mise run` and `mise exec`. |
10294
10296
  | <code><a href="#mise-projen.SettingsSandbox.property.denyRead">denyRead</a></code> | <code>boolean</code> | Deny filesystem reads by default for `mise run` and `mise exec`. |
@@ -10304,7 +10306,7 @@ public readonly denyAll: boolean;
10304
10306
 
10305
10307
  - *Type:* boolean
10306
10308
 
10307
- Deny filesystem reads and writes, network access, and environment variable inheritance by default for `mise run` and `mise exec`.
10309
+ Deny filesystem access, network access and inherited environment variables by default for `mise run` and `mise exec`.
10308
10310
 
10309
10311
  ---
10310
10312
 
@@ -10370,11 +10372,11 @@ const settingsSelfUpdate: SettingsSelfUpdate = { ... }
10370
10372
 
10371
10373
  | **Name** | **Type** | **Description** |
10372
10374
  | --- | --- | --- |
10373
- | <code><a href="#mise-projen.SettingsSelfUpdate.property.apiUrl">apiUrl</a></code> | <code>string</code> | GitHub API base URL used by `mise self-update`. |
10374
- | <code><a href="#mise-projen.SettingsSelfUpdate.property.auto">auto</a></code> | <code>boolean</code> | Automatically update mise before running eligible commands. |
10375
- | <code><a href="#mise-projen.SettingsSelfUpdate.property.checkDuration">checkDuration</a></code> | <code>string</code> | How often to check for a new mise release when `self_update.auto` is enabled. |
10376
- | <code><a href="#mise-projen.SettingsSelfUpdate.property.minimumReleaseAge">minimumReleaseAge</a></code> | <code>string</code> | Minimum release age for mise itself; |
10377
- | <code><a href="#mise-projen.SettingsSelfUpdate.property.repository">repository</a></code> | <code>string</code> | GitHub repository used by `mise self-update`. |
10375
+ | <code><a href="#mise-projen.SettingsSelfUpdate.property.apiUrl">apiUrl</a></code> | <code>string</code> | GitHub API base URL that `mise self-update` gets mise releases from. |
10376
+ | <code><a href="#mise-projen.SettingsSelfUpdate.property.auto">auto</a></code> | <code>boolean</code> | Update mise automatically before running eligible commands. |
10377
+ | <code><a href="#mise-projen.SettingsSelfUpdate.property.checkDuration">checkDuration</a></code> | <code>string</code> | How often automatic updates check for a new mise release when `self_update.auto` is on. |
10378
+ | <code><a href="#mise-projen.SettingsSelfUpdate.property.minimumReleaseAge">minimumReleaseAge</a></code> | <code>string</code> | Skip mise releases published more recently than this, for `mise self-update` and automatic updates. |
10379
+ | <code><a href="#mise-projen.SettingsSelfUpdate.property.repository">repository</a></code> | <code>string</code> | GitHub repository, as `owner/repo`, that mise gets its own releases from. |
10378
10380
 
10379
10381
  ---
10380
10382
 
@@ -10386,7 +10388,7 @@ public readonly apiUrl: string;
10386
10388
 
10387
10389
  - *Type:* string
10388
10390
 
10389
- GitHub API base URL used by `mise self-update`.
10391
+ GitHub API base URL that `mise self-update` gets mise releases from.
10390
10392
 
10391
10393
  ---
10392
10394
 
@@ -10398,7 +10400,7 @@ public readonly auto: boolean;
10398
10400
 
10399
10401
  - *Type:* boolean
10400
10402
 
10401
- Automatically update mise before running eligible commands.
10403
+ Update mise automatically before running eligible commands.
10402
10404
 
10403
10405
  ---
10404
10406
 
@@ -10410,7 +10412,7 @@ public readonly checkDuration: string;
10410
10412
 
10411
10413
  - *Type:* string
10412
10414
 
10413
- How often to check for a new mise release when `self_update.auto` is enabled.
10415
+ How often automatic updates check for a new mise release when `self_update.auto` is on.
10414
10416
 
10415
10417
  ---
10416
10418
 
@@ -10422,9 +10424,7 @@ public readonly minimumReleaseAge: string;
10422
10424
 
10423
10425
  - *Type:* string
10424
10426
 
10425
- Minimum release age for mise itself;
10426
-
10427
- inherits minimum_release_age (24h by default).
10427
+ Skip mise releases published more recently than this, for `mise self-update` and automatic updates.
10428
10428
 
10429
10429
  ---
10430
10430
 
@@ -10436,7 +10436,7 @@ public readonly repository: string;
10436
10436
 
10437
10437
  - *Type:* string
10438
10438
 
10439
- GitHub repository used by `mise self-update`.
10439
+ GitHub repository, as `owner/repo`, that mise gets its own releases from.
10440
10440
 
10441
10441
  ---
10442
10442
 
@@ -10454,7 +10454,7 @@ const settingsShims: SettingsShims = { ... }
10454
10454
 
10455
10455
  | **Name** | **Type** | **Description** |
10456
10456
  | --- | --- | --- |
10457
- | <code><a href="#mise-projen.SettingsShims.property.exclude">exclude</a></code> | <code>string[]</code> | Command names mise should never create shims for, leaving them to the system. |
10457
+ | <code><a href="#mise-projen.SettingsShims.property.exclude">exclude</a></code> | <code>string[]</code> | Command names that mise never creates shims for, so they resolve to whatever else is on `PATH`. |
10458
10458
 
10459
10459
  ---
10460
10460
 
@@ -10466,7 +10466,7 @@ public readonly exclude: string[];
10466
10466
 
10467
10467
  - *Type:* string[]
10468
10468
 
10469
- Command names mise should never create shims for, leaving them to the system.
10469
+ Command names that mise never creates shims for, so they resolve to whatever else is on `PATH`.
10470
10470
 
10471
10471
  ---
10472
10472
 
@@ -10487,7 +10487,7 @@ const settingsSkills: SettingsSkills = { ... }
10487
10487
  | <code><a href="#mise-projen.SettingsSkills.property.autoSync">autoSync</a></code> | <code>boolean</code> | Link the active tools' agent skills into the project after `mise install` and `mise use`. |
10488
10488
  | <code><a href="#mise-projen.SettingsSkills.property.dir">dir</a></code> | <code>string</code> | Where `mise skills sync` links skills: a path under the project root, or under the home directory with `--global`. |
10489
10489
  | <code><a href="#mise-projen.SettingsSkills.property.fetch">fetch</a></code> | <code>boolean</code> | Fetch the agent skills a tool's packslip declares when installing it. |
10490
- | <code><a href="#mise-projen.SettingsSkills.property.prune">prune</a></code> | <code>boolean</code> | Remove links mise made for skills that are no longer active when syncing. |
10490
+ | <code><a href="#mise-projen.SettingsSkills.property.prune">prune</a></code> | <code>boolean</code> | Remove links mise made for skills that are no longer active, on every `mise skills sync`. |
10491
10491
 
10492
10492
  ---
10493
10493
 
@@ -10535,7 +10535,7 @@ public readonly prune: boolean;
10535
10535
 
10536
10536
  - *Type:* boolean
10537
10537
 
10538
- Remove links mise made for skills that are no longer active when syncing.
10538
+ Remove links mise made for skills that are no longer active, on every `mise skills sync`.
10539
10539
 
10540
10540
  ---
10541
10541
 
@@ -10553,11 +10553,11 @@ const settingsSops: SettingsSops = { ... }
10553
10553
 
10554
10554
  | **Name** | **Type** | **Description** |
10555
10555
  | --- | --- | --- |
10556
- | <code><a href="#mise-projen.SettingsSops.property.ageKey">ageKey</a></code> | <code>string</code> | The age private key to use for sops secret decryption. |
10557
- | <code><a href="#mise-projen.SettingsSops.property.ageKeyFile">ageKeyFile</a></code> | <code>string</code> | Path to the age private key file for sops secret decryption. |
10558
- | <code><a href="#mise-projen.SettingsSops.property.ageRecipients">ageRecipients</a></code> | <code>string</code> | The age public keys to use for sops secret encryption. |
10559
- | <code><a href="#mise-projen.SettingsSops.property.rops">rops</a></code> | <code>boolean</code> | Use rops to decrypt sops files. |
10560
- | <code><a href="#mise-projen.SettingsSops.property.strict">strict</a></code> | <code>boolean</code> | If true, fail when sops decryption fails (including when sops is not available, the key is missing, or the key is invalid). |
10556
+ | <code><a href="#mise-projen.SettingsSops.property.ageKey">ageKey</a></code> | <code>string</code> | Private age key for decrypting SOPS files, used before any other key source. |
10557
+ | <code><a href="#mise-projen.SettingsSops.property.ageKeyFile">ageKeyFile</a></code> | <code>string</code> | Path of an age key file for decrypting SOPS files, used after `sops.age_key` and before `SOPS_AGE_KEY_FILE`. |
10558
+ | <code><a href="#mise-projen.SettingsSops.property.ageRecipients">ageRecipients</a></code> | <code>string</code> | [deprecated] Has no effect; |
10559
+ | <code><a href="#mise-projen.SettingsSops.property.rops">rops</a></code> | <code>boolean</code> | Decrypt SOPS files with mise's built-in rops library instead of the `sops` CLI. |
10560
+ | <code><a href="#mise-projen.SettingsSops.property.strict">strict</a></code> | <code>boolean</code> | Fail when a SOPS file cannot be decrypted, instead of skipping it. |
10561
10561
 
10562
10562
  ---
10563
10563
 
@@ -10569,9 +10569,7 @@ public readonly ageKey: string;
10569
10569
 
10570
10570
  - *Type:* string
10571
10571
 
10572
- The age private key to use for sops secret decryption.
10573
-
10574
- Takes precedence over standard SOPS_AGE_KEY environment variable.
10572
+ Private age key for decrypting SOPS files, used before any other key source.
10575
10573
 
10576
10574
  ---
10577
10575
 
@@ -10583,9 +10581,7 @@ public readonly ageKeyFile: string;
10583
10581
 
10584
10582
  - *Type:* string
10585
10583
 
10586
- Path to the age private key file for sops secret decryption.
10587
-
10588
- Takes precedence over standard SOPS_AGE_KEY_FILE environment variable.
10584
+ Path of an age key file for decrypting SOPS files, used after `sops.age_key` and before `SOPS_AGE_KEY_FILE`.
10589
10585
 
10590
10586
  ---
10591
10587
 
@@ -10597,7 +10593,9 @@ public readonly ageRecipients: string;
10597
10593
 
10598
10594
  - *Type:* string
10599
10595
 
10600
- The age public keys to use for sops secret encryption.
10596
+ [deprecated] Has no effect;
10597
+
10598
+ mise does not encrypt sops files.
10601
10599
 
10602
10600
  ---
10603
10601
 
@@ -10609,9 +10607,7 @@ public readonly rops: boolean;
10609
10607
 
10610
10608
  - *Type:* boolean
10611
10609
 
10612
- Use rops to decrypt sops files.
10613
-
10614
- Disable to shell out to `sops` which will slow down mise but sops may offer features not available in rops. Required for TOML SOPS files because the sops CLI does not support TOML.
10610
+ Decrypt SOPS files with mise's built-in rops library instead of the `sops` CLI.
10615
10611
 
10616
10612
  ---
10617
10613
 
@@ -10623,9 +10619,7 @@ public readonly strict: boolean;
10623
10619
 
10624
10620
  - *Type:* boolean
10625
10621
 
10626
- If true, fail when sops decryption fails (including when sops is not available, the key is missing, or the key is invalid).
10627
-
10628
- If false, skip decryption and continue in these cases.
10622
+ Fail when a SOPS file cannot be decrypted, instead of skipping it.
10629
10623
 
10630
10624
  ---
10631
10625
 
@@ -10643,7 +10637,7 @@ const settingsSpm: SettingsSpm = { ... }
10643
10637
 
10644
10638
  | **Name** | **Type** | **Description** |
10645
10639
  | --- | --- | --- |
10646
- | <code><a href="#mise-projen.SettingsSpm.property.artifactbundleOnly">artifactbundleOnly</a></code> | <code>boolean</code> | Only use SwiftPM artifact bundles for installation, fail if no matching bundle is available. |
10640
+ | <code><a href="#mise-projen.SettingsSpm.property.artifactbundleOnly">artifactbundleOnly</a></code> | <code>boolean</code> | Install `spm:` tools only from prebuilt artifact bundles, and fail instead of building from source. |
10647
10641
 
10648
10642
  ---
10649
10643
 
@@ -10655,7 +10649,7 @@ public readonly artifactbundleOnly: boolean;
10655
10649
 
10656
10650
  - *Type:* boolean
10657
10651
 
10658
- Only use SwiftPM artifact bundles for installation, fail if no matching bundle is available.
10652
+ Install `spm:` tools only from prebuilt artifact bundles, and fail instead of building from source.
10659
10653
 
10660
10654
  ---
10661
10655
 
@@ -10673,23 +10667,23 @@ const settingsStatus: SettingsStatus = { ... }
10673
10667
 
10674
10668
  | **Name** | **Type** | **Description** |
10675
10669
  | --- | --- | --- |
10676
- | <code><a href="#mise-projen.SettingsStatus.property.missingTools">missingTools</a></code> | <code>string</code> | Show a warning if tools are not installed when entering a directory with a mise.toml file. |
10677
- | <code><a href="#mise-projen.SettingsStatus.property.showDepsStale">showDepsStale</a></code> | <code>boolean</code> | Show warning when deps providers have stale dependencies. |
10678
- | <code><a href="#mise-projen.SettingsStatus.property.showEnv">showEnv</a></code> | <code>boolean</code> | Show configured env vars when entering a directory with a mise.toml file. |
10679
- | <code><a href="#mise-projen.SettingsStatus.property.showTools">showTools</a></code> | <code>boolean</code> | Show configured tools when entering a directory with a mise.toml file. |
10680
- | <code><a href="#mise-projen.SettingsStatus.property.truncate">truncate</a></code> | <code>boolean</code> | Truncate status messages. |
10670
+ | <code><a href="#mise-projen.SettingsStatus.property.missingTools">missingTools</a></code> | <code><a href="#mise-projen.SettingsStatusMissingTools">SettingsStatusMissingTools</a></code> | When to warn that tools requested by config are not installed. |
10671
+ | <code><a href="#mise-projen.SettingsStatus.property.showDepsStale">showDepsStale</a></code> | <code>boolean</code> | Warn in an activated shell when a `[deps]` provider with `auto = true` is out of date. |
10672
+ | <code><a href="#mise-projen.SettingsStatus.property.showEnv">showEnv</a></code> | <code>boolean</code> | When you change directories in an activated shell, list the environment variables that mise adds, changes or removes. |
10673
+ | <code><a href="#mise-projen.SettingsStatus.property.showTools">showTools</a></code> | <code>boolean</code> | When you change directories in an activated shell, list the tool versions that become active or inactive. |
10674
+ | <code><a href="#mise-projen.SettingsStatus.property.truncate">truncate</a></code> | <code>boolean</code> | Cut the lines from `status.show_env` and `status.show_tools` to the terminal width. |
10681
10675
 
10682
10676
  ---
10683
10677
 
10684
10678
  ##### `missingTools`<sup>Optional</sup> <a name="missingTools" id="mise-projen.SettingsStatus.property.missingTools"></a>
10685
10679
 
10686
10680
  ```typescript
10687
- public readonly missingTools: string;
10681
+ public readonly missingTools: SettingsStatusMissingTools;
10688
10682
  ```
10689
10683
 
10690
- - *Type:* string
10684
+ - *Type:* <a href="#mise-projen.SettingsStatusMissingTools">SettingsStatusMissingTools</a>
10691
10685
 
10692
- Show a warning if tools are not installed when entering a directory with a mise.toml file.
10686
+ When to warn that tools requested by config are not installed.
10693
10687
 
10694
10688
  ---
10695
10689
 
@@ -10701,7 +10695,7 @@ public readonly showDepsStale: boolean;
10701
10695
 
10702
10696
  - *Type:* boolean
10703
10697
 
10704
- Show warning when deps providers have stale dependencies.
10698
+ Warn in an activated shell when a `[deps]` provider with `auto = true` is out of date.
10705
10699
 
10706
10700
  ---
10707
10701
 
@@ -10713,7 +10707,7 @@ public readonly showEnv: boolean;
10713
10707
 
10714
10708
  - *Type:* boolean
10715
10709
 
10716
- Show configured env vars when entering a directory with a mise.toml file.
10710
+ When you change directories in an activated shell, list the environment variables that mise adds, changes or removes.
10717
10711
 
10718
10712
  ---
10719
10713
 
@@ -10725,7 +10719,7 @@ public readonly showTools: boolean;
10725
10719
 
10726
10720
  - *Type:* boolean
10727
10721
 
10728
- Show configured tools when entering a directory with a mise.toml file.
10722
+ When you change directories in an activated shell, list the tool versions that become active or inactive.
10729
10723
 
10730
10724
  ---
10731
10725
 
@@ -10737,7 +10731,7 @@ public readonly truncate: boolean;
10737
10731
 
10738
10732
  - *Type:* boolean
10739
10733
 
10740
- Truncate status messages.
10734
+ Cut the lines from `status.show_env` and `status.show_tools` to the terminal width.
10741
10735
 
10742
10736
  ---
10743
10737
 
@@ -10755,8 +10749,8 @@ const settingsSwift: SettingsSwift = { ... }
10755
10749
 
10756
10750
  | **Name** | **Type** | **Description** |
10757
10751
  | --- | --- | --- |
10758
- | <code><a href="#mise-projen.SettingsSwift.property.gpgVerify">gpgVerify</a></code> | <code>boolean</code> | Verify OpenPGP signatures for swift (built-in, no external gpg required). |
10759
- | <code><a href="#mise-projen.SettingsSwift.property.platform">platform</a></code> | <code>string</code> | Override the distro build to use for precompiled binaries. |
10752
+ | <code><a href="#mise-projen.SettingsSwift.property.gpgVerify">gpgVerify</a></code> | <code>boolean</code> | Verify the OpenPGP signature of Swift downloads on Linux. |
10753
+ | <code><a href="#mise-projen.SettingsSwift.property.platform">platform</a></code> | <code>string</code> | Linux distribution build of Swift to download, such as `ubuntu24.04` or `fedora41`. |
10760
10754
 
10761
10755
  ---
10762
10756
 
@@ -10768,9 +10762,7 @@ public readonly gpgVerify: boolean;
10768
10762
 
10769
10763
  - *Type:* boolean
10770
10764
 
10771
- Verify OpenPGP signatures for swift (built-in, no external gpg required).
10772
-
10773
- Set to false to disable.
10765
+ Verify the OpenPGP signature of Swift downloads on Linux.
10774
10766
 
10775
10767
  ---
10776
10768
 
@@ -10782,9 +10774,7 @@ public readonly platform: string;
10782
10774
 
10783
10775
  - *Type:* string
10784
10776
 
10785
- Override the distro build to use for precompiled binaries.
10786
-
10787
- By default the distro is detected and matched against what the Swift release actually publishes, which changes from release to release. Set this to force a specific build, or to install without reaching swift.org's release index.
10777
+ Linux distribution build of Swift to download, such as `ubuntu24.04` or `fedora41`.
10788
10778
 
10789
10779
  ---
10790
10780
 
@@ -10802,8 +10792,8 @@ const settingsSystemPackages: SettingsSystemPackages = { ... }
10802
10792
 
10803
10793
  | **Name** | **Type** | **Description** |
10804
10794
  | --- | --- | --- |
10805
- | <code><a href="#mise-projen.SettingsSystemPackages.property.managers">managers</a></code> | <code>string[]</code> | Restrict which system package managers mise will use. |
10806
- | <code><a href="#mise-projen.SettingsSystemPackages.property.sudo">sudo</a></code> | <code>boolean</code> | Allow `mise bootstrap` and `mise install --system` to elevate with sudo when not running as root. |
10795
+ | <code><a href="#mise-projen.SettingsSystemPackages.property.managers">managers</a></code> | <code>string[]</code> | Package managers that mise may use for `[bootstrap.packages]` and missing plugin dependencies. |
10796
+ | <code><a href="#mise-projen.SettingsSystemPackages.property.sudo">sudo</a></code> | <code>boolean</code> | Let mise run `sudo` for steps that need root, such as system packages and `mise install --system`. |
10807
10797
 
10808
10798
  ---
10809
10799
 
@@ -10815,7 +10805,7 @@ public readonly managers: string[];
10815
10805
 
10816
10806
  - *Type:* string[]
10817
10807
 
10818
- Restrict which system package managers mise will use.
10808
+ Package managers that mise may use for `[bootstrap.packages]` and missing plugin dependencies.
10819
10809
 
10820
10810
  ---
10821
10811
 
@@ -10827,7 +10817,7 @@ public readonly sudo: boolean;
10827
10817
 
10828
10818
  - *Type:* boolean
10829
10819
 
10830
- Allow `mise bootstrap` and `mise install --system` to elevate with sudo when not running as root.
10820
+ Let mise run `sudo` for steps that need root, such as system packages and `mise install --system`.
10831
10821
 
10832
10822
  ---
10833
10823
 
@@ -10845,33 +10835,33 @@ const settingsTask: SettingsTask = { ... }
10845
10835
 
10846
10836
  | **Name** | **Type** | **Description** |
10847
10837
  | --- | --- | --- |
10848
- | <code><a href="#mise-projen.SettingsTask.property.autoInfer">autoInfer</a></code> | <code>string[]</code> | [experimental] Workspace providers from which to automatically infer tasks. |
10838
+ | <code><a href="#mise-projen.SettingsTask.property.autoInfer">autoInfer</a></code> | <code>string[]</code> | [experimental] Workspace providers whose package scripts mise imports as tasks, such as `node`. |
10849
10839
  | <code><a href="#mise-projen.SettingsTask.property.cache">cache</a></code> | <code><a href="#mise-projen.SettingsTaskCache">SettingsTaskCache</a></code> | *No description.* |
10850
- | <code><a href="#mise-projen.SettingsTask.property.cacheDir">cacheDir</a></code> | <code>string</code> | [experimental] Directory for task output cache artifacts. |
10851
- | <code><a href="#mise-projen.SettingsTask.property.cacheMaxAge">cacheMaxAge</a></code> | <code>string</code> | [experimental] Maximum age of task output cache entries since their last access. |
10852
- | <code><a href="#mise-projen.SettingsTask.property.cacheMaxSize">cacheMaxSize</a></code> | <code>string</code> | [experimental] Maximum total size of task output cache entries. |
10853
- | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteMode">cacheRemoteMode</a></code> | <code><a href="#mise-projen.SettingsTaskCacheRemoteMode">SettingsTaskCacheRemoteMode</a></code> | Compatibility alias for task.cache.remote_mode. |
10854
- | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteNamespace">cacheRemoteNamespace</a></code> | <code>string</code> | Compatibility alias for task.cache.remote_namespace. |
10855
- | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteOidcAudience">cacheRemoteOidcAudience</a></code> | <code>string</code> | Compatibility alias for task.cache.remote_oidc_audience. |
10856
- | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteToken">cacheRemoteToken</a></code> | <code>string</code> | Compatibility alias for task.cache.remote_token. |
10857
- | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteTokenFile">cacheRemoteTokenFile</a></code> | <code>string</code> | Compatibility alias for task.cache.remote_token_file. |
10858
- | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteUrl">cacheRemoteUrl</a></code> | <code>string</code> | Compatibility alias for task.cache.remote_url. |
10859
- | <code><a href="#mise-projen.SettingsTask.property.disablePaths">disablePaths</a></code> | <code>string[]</code> | Paths that mise will not look for tasks in. |
10860
- | <code><a href="#mise-projen.SettingsTask.property.disableSpecFromRunScripts">disableSpecFromRunScripts</a></code> | <code>boolean</code> | Opt out of parsing task run scripts to infer the usage spec (arguments and flags). |
10861
- | <code><a href="#mise-projen.SettingsTask.property.monorepoDepth">monorepoDepth</a></code> | <code>number</code> | Maximum depth to search for task files in monorepo subdirectories. |
10862
- | <code><a href="#mise-projen.SettingsTask.property.monorepoExcludeDirs">monorepoExcludeDirs</a></code> | <code>string[]</code> | Directory patterns to exclude when discovering monorepo subdirectories. |
10863
- | <code><a href="#mise-projen.SettingsTask.property.monorepoRespectGitignore">monorepoRespectGitignore</a></code> | <code>boolean</code> | Whether to respect .gitignore files when discovering monorepo subdirectories. |
10864
- | <code><a href="#mise-projen.SettingsTask.property.output">output</a></code> | <code><a href="#mise-projen.SettingsTaskOutput">SettingsTaskOutput</a></code> | Change output style when executing tasks. |
10865
- | <code><a href="#mise-projen.SettingsTask.property.quiet">quiet</a></code> | <code>boolean</code> | Suppress mise's own output while executing tasks. |
10866
- | <code><a href="#mise-projen.SettingsTask.property.remoteNoCache">remoteNoCache</a></code> | <code>boolean</code> | Mise will always fetch the latest tasks from the remote, by default the cache is used. |
10867
- | <code><a href="#mise-projen.SettingsTask.property.runAutoInstall">runAutoInstall</a></code> | <code>boolean</code> | Automatically install missing tools when executing tasks. |
10868
- | <code><a href="#mise-projen.SettingsTask.property.showFullCmd">showFullCmd</a></code> | <code>boolean</code> | Disable truncation of command lines in task execution output. |
10869
- | <code><a href="#mise-projen.SettingsTask.property.skip">skip</a></code> | <code>string[]</code> | Tasks to skip when running `mise run`. |
10870
- | <code><a href="#mise-projen.SettingsTask.property.skipDepends">skipDepends</a></code> | <code>boolean</code> | Run only specified tasks skipping all dependencies. |
10871
- | <code><a href="#mise-projen.SettingsTask.property.sourceFreshnessEqualMtimeIsFresh">sourceFreshnessEqualMtimeIsFresh</a></code> | <code>boolean</code> | When source mtime equals output mtime, consider sources fresh (use <=). |
10872
- | <code><a href="#mise-projen.SettingsTask.property.sourceFreshnessHashContents">sourceFreshnessHashContents</a></code> | <code>boolean</code> | Use content hashing (blake3) instead of metadata for source freshness. |
10873
- | <code><a href="#mise-projen.SettingsTask.property.timeout">timeout</a></code> | <code>string</code> | Default timeout for tasks. |
10874
- | <code><a href="#mise-projen.SettingsTask.property.timings">timings</a></code> | <code>boolean</code> | Show completion message with elapsed time for each task on `mise run`. |
10840
+ | <code><a href="#mise-projen.SettingsTask.property.cacheDir">cacheDir</a></code> | <code>string</code> | [experimental] Directory for the task artifact cache. |
10841
+ | <code><a href="#mise-projen.SettingsTask.property.cacheMaxAge">cacheMaxAge</a></code> | <code>string</code> | [experimental] Remove task artifact cache entries that have not been used for this long. |
10842
+ | <code><a href="#mise-projen.SettingsTask.property.cacheMaxSize">cacheMaxSize</a></code> | <code>string</code> | [experimental] Maximum total size of the task artifact cache, such as `500MB` or `2GiB`. |
10843
+ | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteMode">cacheRemoteMode</a></code> | <code><a href="#mise-projen.SettingsTaskCacheRemoteMode">SettingsTaskCacheRemoteMode</a></code> | Deprecated alias for `task.cache.remote_mode`. |
10844
+ | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteNamespace">cacheRemoteNamespace</a></code> | <code>string</code> | Deprecated alias for `task.cache.remote_namespace`. |
10845
+ | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteOidcAudience">cacheRemoteOidcAudience</a></code> | <code>string</code> | Deprecated alias for `task.cache.remote_oidc_audience`. |
10846
+ | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteToken">cacheRemoteToken</a></code> | <code>string</code> | Deprecated alias for `task.cache.remote_token`. |
10847
+ | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteTokenFile">cacheRemoteTokenFile</a></code> | <code>string</code> | Deprecated alias for `task.cache.remote_token_file`. |
10848
+ | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteUrl">cacheRemoteUrl</a></code> | <code>string</code> | Deprecated alias for `task.cache.remote_url`. |
10849
+ | <code><a href="#mise-projen.SettingsTask.property.disablePaths">disablePaths</a></code> | <code>string[]</code> | Paths that mise does not look for tasks in. |
10850
+ | <code><a href="#mise-projen.SettingsTask.property.disableSpecFromRunScripts">disableSpecFromRunScripts</a></code> | <code>boolean</code> | Build task usage specs only from the `usage` field, ignoring deprecated `arg()`, `option()` and `flag()` in run scripts. |
10851
+ | <code><a href="#mise-projen.SettingsTask.property.monorepoDepth">monorepoDepth</a></code> | <code>number</code> | Maximum directory depth for automatic monorepo discovery, which is deprecated. |
10852
+ | <code><a href="#mise-projen.SettingsTask.property.monorepoExcludeDirs">monorepoExcludeDirs</a></code> | <code>string[]</code> | Directory names that automatic monorepo discovery skips. |
10853
+ | <code><a href="#mise-projen.SettingsTask.property.monorepoRespectGitignore">monorepoRespectGitignore</a></code> | <code>boolean</code> | Skip directories that `.gitignore` files ignore during automatic monorepo discovery. |
10854
+ | <code><a href="#mise-projen.SettingsTask.property.output">output</a></code> | <code><a href="#mise-projen.SettingsTaskOutput">SettingsTaskOutput</a></code> | Default output style for `mise run`. |
10855
+ | <code><a href="#mise-projen.SettingsTask.property.quiet">quiet</a></code> | <code>boolean</code> | Hide mise's own messages while tasks run, without changing other mise commands. |
10856
+ | <code><a href="#mise-projen.SettingsTask.property.remoteNoCache">remoteNoCache</a></code> | <code>boolean</code> | Download remote task files and task includes on every run instead of using the cached copy. |
10857
+ | <code><a href="#mise-projen.SettingsTask.property.runAutoInstall">runAutoInstall</a></code> | <code>boolean</code> | Install missing tools automatically before tasks run. |
10858
+ | <code><a href="#mise-projen.SettingsTask.property.showFullCmd">showFullCmd</a></code> | <code>boolean</code> | Print each task's full command line instead of truncating it to the terminal width. |
10859
+ | <code><a href="#mise-projen.SettingsTask.property.skip">skip</a></code> | <code>string[]</code> | Names of tasks that `mise run` skips. |
10860
+ | <code><a href="#mise-projen.SettingsTask.property.skipDepends">skipDepends</a></code> | <code>boolean</code> | Run only the tasks named on the command line, skipping their dependencies; |
10861
+ | <code><a href="#mise-projen.SettingsTask.property.sourceFreshnessEqualMtimeIsFresh">sourceFreshnessEqualMtimeIsFresh</a></code> | <code>boolean</code> | Treat a task as up to date when its newest source and its outputs have the same modification time. |
10862
+ | <code><a href="#mise-projen.SettingsTask.property.sourceFreshnessHashContents">sourceFreshnessHashContents</a></code> | <code>boolean</code> | Decide whether a task's sources changed by hashing their contents instead of comparing modification times. |
10863
+ | <code><a href="#mise-projen.SettingsTask.property.timeout">timeout</a></code> | <code>string</code> | Time limit for a whole `mise run` invocation, across every task it runs. |
10864
+ | <code><a href="#mise-projen.SettingsTask.property.timings">timings</a></code> | <code>boolean</code> | Print each task's elapsed time when it finishes. |
10875
10865
 
10876
10866
  ---
10877
10867
 
@@ -10883,7 +10873,7 @@ public readonly autoInfer: string[];
10883
10873
 
10884
10874
  - *Type:* string[]
10885
10875
 
10886
- [experimental] Workspace providers from which to automatically infer tasks.
10876
+ [experimental] Workspace providers whose package scripts mise imports as tasks, such as `node`.
10887
10877
 
10888
10878
  ---
10889
10879
 
@@ -10905,7 +10895,7 @@ public readonly cacheDir: string;
10905
10895
 
10906
10896
  - *Type:* string
10907
10897
 
10908
- [experimental] Directory for task output cache artifacts.
10898
+ [experimental] Directory for the task artifact cache.
10909
10899
 
10910
10900
  ---
10911
10901
 
@@ -10917,7 +10907,7 @@ public readonly cacheMaxAge: string;
10917
10907
 
10918
10908
  - *Type:* string
10919
10909
 
10920
- [experimental] Maximum age of task output cache entries since their last access.
10910
+ [experimental] Remove task artifact cache entries that have not been used for this long.
10921
10911
 
10922
10912
  ---
10923
10913
 
@@ -10929,7 +10919,7 @@ public readonly cacheMaxSize: string;
10929
10919
 
10930
10920
  - *Type:* string
10931
10921
 
10932
- [experimental] Maximum total size of task output cache entries.
10922
+ [experimental] Maximum total size of the task artifact cache, such as `500MB` or `2GiB`.
10933
10923
 
10934
10924
  ---
10935
10925
 
@@ -10941,7 +10931,7 @@ public readonly cacheRemoteMode: SettingsTaskCacheRemoteMode;
10941
10931
 
10942
10932
  - *Type:* <a href="#mise-projen.SettingsTaskCacheRemoteMode">SettingsTaskCacheRemoteMode</a>
10943
10933
 
10944
- Compatibility alias for task.cache.remote_mode.
10934
+ Deprecated alias for `task.cache.remote_mode`.
10945
10935
 
10946
10936
  ---
10947
10937
 
@@ -10953,7 +10943,7 @@ public readonly cacheRemoteNamespace: string;
10953
10943
 
10954
10944
  - *Type:* string
10955
10945
 
10956
- Compatibility alias for task.cache.remote_namespace.
10946
+ Deprecated alias for `task.cache.remote_namespace`.
10957
10947
 
10958
10948
  ---
10959
10949
 
@@ -10965,7 +10955,7 @@ public readonly cacheRemoteOidcAudience: string;
10965
10955
 
10966
10956
  - *Type:* string
10967
10957
 
10968
- Compatibility alias for task.cache.remote_oidc_audience.
10958
+ Deprecated alias for `task.cache.remote_oidc_audience`.
10969
10959
 
10970
10960
  ---
10971
10961
 
@@ -10977,7 +10967,7 @@ public readonly cacheRemoteToken: string;
10977
10967
 
10978
10968
  - *Type:* string
10979
10969
 
10980
- Compatibility alias for task.cache.remote_token.
10970
+ Deprecated alias for `task.cache.remote_token`.
10981
10971
 
10982
10972
  ---
10983
10973
 
@@ -10989,7 +10979,7 @@ public readonly cacheRemoteTokenFile: string;
10989
10979
 
10990
10980
  - *Type:* string
10991
10981
 
10992
- Compatibility alias for task.cache.remote_token_file.
10982
+ Deprecated alias for `task.cache.remote_token_file`.
10993
10983
 
10994
10984
  ---
10995
10985
 
@@ -11001,7 +10991,7 @@ public readonly cacheRemoteUrl: string;
11001
10991
 
11002
10992
  - *Type:* string
11003
10993
 
11004
- Compatibility alias for task.cache.remote_url.
10994
+ Deprecated alias for `task.cache.remote_url`.
11005
10995
 
11006
10996
  ---
11007
10997
 
@@ -11013,7 +11003,7 @@ public readonly disablePaths: string[];
11013
11003
 
11014
11004
  - *Type:* string[]
11015
11005
 
11016
- Paths that mise will not look for tasks in.
11006
+ Paths that mise does not look for tasks in.
11017
11007
 
11018
11008
  ---
11019
11009
 
@@ -11025,9 +11015,7 @@ public readonly disableSpecFromRunScripts: boolean;
11025
11015
 
11026
11016
  - *Type:* boolean
11027
11017
 
11028
- Opt out of parsing task run scripts to infer the usage spec (arguments and flags).
11029
-
11030
- When enabled, mise will derive the usage spec only from the `usage` field, ignoring any `arg()`, `option()`, or `flag()` templates used in run scripts. This can restore previous behavior and avoid the extra template pass over run scripts when collecting specs.
11018
+ Build task usage specs only from the `usage` field, ignoring deprecated `arg()`, `option()` and `flag()` in run scripts.
11031
11019
 
11032
11020
  ---
11033
11021
 
@@ -11039,7 +11027,7 @@ public readonly monorepoDepth: number;
11039
11027
 
11040
11028
  - *Type:* number
11041
11029
 
11042
- Maximum depth to search for task files in monorepo subdirectories.
11030
+ Maximum directory depth for automatic monorepo discovery, which is deprecated.
11043
11031
 
11044
11032
  ---
11045
11033
 
@@ -11051,7 +11039,7 @@ public readonly monorepoExcludeDirs: string[];
11051
11039
 
11052
11040
  - *Type:* string[]
11053
11041
 
11054
- Directory patterns to exclude when discovering monorepo subdirectories.
11042
+ Directory names that automatic monorepo discovery skips.
11055
11043
 
11056
11044
  ---
11057
11045
 
@@ -11063,7 +11051,7 @@ public readonly monorepoRespectGitignore: boolean;
11063
11051
 
11064
11052
  - *Type:* boolean
11065
11053
 
11066
- Whether to respect .gitignore files when discovering monorepo subdirectories.
11054
+ Skip directories that `.gitignore` files ignore during automatic monorepo discovery.
11067
11055
 
11068
11056
  ---
11069
11057
 
@@ -11075,7 +11063,7 @@ public readonly output: SettingsTaskOutput;
11075
11063
 
11076
11064
  - *Type:* <a href="#mise-projen.SettingsTaskOutput">SettingsTaskOutput</a>
11077
11065
 
11078
- Change output style when executing tasks.
11066
+ Default output style for `mise run`.
11079
11067
 
11080
11068
  ---
11081
11069
 
@@ -11087,7 +11075,7 @@ public readonly quiet: boolean;
11087
11075
 
11088
11076
  - *Type:* boolean
11089
11077
 
11090
- Suppress mise's own output while executing tasks.
11078
+ Hide mise's own messages while tasks run, without changing other mise commands.
11091
11079
 
11092
11080
  ---
11093
11081
 
@@ -11099,7 +11087,7 @@ public readonly remoteNoCache: boolean;
11099
11087
 
11100
11088
  - *Type:* boolean
11101
11089
 
11102
- Mise will always fetch the latest tasks from the remote, by default the cache is used.
11090
+ Download remote task files and task includes on every run instead of using the cached copy.
11103
11091
 
11104
11092
  ---
11105
11093
 
@@ -11111,7 +11099,7 @@ public readonly runAutoInstall: boolean;
11111
11099
 
11112
11100
  - *Type:* boolean
11113
11101
 
11114
- Automatically install missing tools when executing tasks.
11102
+ Install missing tools automatically before tasks run.
11115
11103
 
11116
11104
  ---
11117
11105
 
@@ -11123,9 +11111,7 @@ public readonly showFullCmd: boolean;
11123
11111
 
11124
11112
  - *Type:* boolean
11125
11113
 
11126
- Disable truncation of command lines in task execution output.
11127
-
11128
- When true, the full command line will be shown.
11114
+ Print each task's full command line instead of truncating it to the terminal width.
11129
11115
 
11130
11116
  ---
11131
11117
 
@@ -11137,7 +11123,7 @@ public readonly skip: string[];
11137
11123
 
11138
11124
  - *Type:* string[]
11139
11125
 
11140
- Tasks to skip when running `mise run`.
11126
+ Names of tasks that `mise run` skips.
11141
11127
 
11142
11128
  ---
11143
11129
 
@@ -11149,7 +11135,9 @@ public readonly skipDepends: boolean;
11149
11135
 
11150
11136
  - *Type:* boolean
11151
11137
 
11152
- Run only specified tasks skipping all dependencies.
11138
+ Run only the tasks named on the command line, skipping their dependencies;
11139
+
11140
+ same as `mise run --skip-deps`.
11153
11141
 
11154
11142
  ---
11155
11143
 
@@ -11161,9 +11149,7 @@ public readonly sourceFreshnessEqualMtimeIsFresh: boolean;
11161
11149
 
11162
11150
  - *Type:* boolean
11163
11151
 
11164
- When source mtime equals output mtime, consider sources fresh (use <=).
11165
-
11166
- Default false uses strict < comparison.
11152
+ Treat a task as up to date when its newest source and its outputs have the same modification time.
11167
11153
 
11168
11154
  ---
11169
11155
 
@@ -11175,9 +11161,7 @@ public readonly sourceFreshnessHashContents: boolean;
11175
11161
 
11176
11162
  - *Type:* boolean
11177
11163
 
11178
- Use content hashing (blake3) instead of metadata for source freshness.
11179
-
11180
- More accurate but slower.
11164
+ Decide whether a task's sources changed by hashing their contents instead of comparing modification times.
11181
11165
 
11182
11166
  ---
11183
11167
 
@@ -11189,7 +11173,7 @@ public readonly timeout: string;
11189
11173
 
11190
11174
  - *Type:* string
11191
11175
 
11192
- Default timeout for tasks.
11176
+ Time limit for a whole `mise run` invocation, across every task it runs.
11193
11177
 
11194
11178
  ---
11195
11179
 
@@ -11201,9 +11185,7 @@ public readonly timings: boolean;
11201
11185
 
11202
11186
  - *Type:* boolean
11203
11187
 
11204
- Show completion message with elapsed time for each task on `mise run`.
11205
-
11206
- Default shows when output type is `prefix`.
11188
+ Print each task's elapsed time when it finishes.
11207
11189
 
11208
11190
  ---
11209
11191
 
@@ -11221,14 +11203,14 @@ const settingsTaskCache: SettingsTaskCache = { ... }
11221
11203
 
11222
11204
  | **Name** | **Type** | **Description** |
11223
11205
  | --- | --- | --- |
11224
- | <code><a href="#mise-projen.SettingsTaskCache.property.auditReport">auditReport</a></code> | <code>string</code> | [experimental] File to write the complete task cache audit report to. |
11225
- | <code><a href="#mise-projen.SettingsTaskCache.property.remoteMode">remoteMode</a></code> | <code><a href="#mise-projen.SettingsTaskCacheRemoteMode">SettingsTaskCacheRemoteMode</a></code> | [experimental] Remote task and action cache access mode. |
11226
- | <code><a href="#mise-projen.SettingsTaskCache.property.remoteNamespace">remoteNamespace</a></code> | <code>string</code> | [experimental] Namespace sent to the remote build cache. |
11227
- | <code><a href="#mise-projen.SettingsTaskCache.property.remoteOidcAudience">remoteOidcAudience</a></code> | <code>string</code> | [experimental] Audience for an automatically acquired remote cache OIDC token. |
11228
- | <code><a href="#mise-projen.SettingsTaskCache.property.remoteToken">remoteToken</a></code> | <code>string</code> | [experimental] Bearer token for remote build-cache authentication. |
11229
- | <code><a href="#mise-projen.SettingsTaskCache.property.remoteTokenFile">remoteTokenFile</a></code> | <code>string</code> | [experimental] File containing a remote build-cache bearer token. |
11230
- | <code><a href="#mise-projen.SettingsTaskCache.property.remoteUrl">remoteUrl</a></code> | <code>string</code> | [experimental] Base URL for the remote build-cache service. |
11231
- | <code><a href="#mise-projen.SettingsTaskCache.property.statsReport">statsReport</a></code> | <code>string</code> | [experimental] File to write action-cache session statistics to. |
11206
+ | <code><a href="#mise-projen.SettingsTaskCache.property.auditReport">auditReport</a></code> | <code>string</code> | [experimental] File that receives every undeclared path found by the `cache.audit` task option. |
11207
+ | <code><a href="#mise-projen.SettingsTaskCache.property.remoteMode">remoteMode</a></code> | <code><a href="#mise-projen.SettingsTaskCacheRemoteMode">SettingsTaskCacheRemoteMode</a></code> | [experimental] How mise uses the remote task cache server. |
11208
+ | <code><a href="#mise-projen.SettingsTaskCache.property.remoteNamespace">remoteNamespace</a></code> | <code>string</code> | [experimental] Namespace that keeps this project's entries apart on the remote task cache server. |
11209
+ | <code><a href="#mise-projen.SettingsTaskCache.property.remoteOidcAudience">remoteOidcAudience</a></code> | <code>string</code> | [experimental] Audience of the GitHub Actions OIDC token that mise requests for the remote task cache. |
11210
+ | <code><a href="#mise-projen.SettingsTaskCache.property.remoteToken">remoteToken</a></code> | <code>string</code> | [experimental] Bearer token that mise sends to the remote task cache server. |
11211
+ | <code><a href="#mise-projen.SettingsTaskCache.property.remoteTokenFile">remoteTokenFile</a></code> | <code>string</code> | [experimental] File that mise reads the remote task cache token from before each request. |
11212
+ | <code><a href="#mise-projen.SettingsTaskCache.property.remoteUrl">remoteUrl</a></code> | <code>string</code> | [experimental] Base URL of the remote task cache server. |
11213
+ | <code><a href="#mise-projen.SettingsTaskCache.property.statsReport">statsReport</a></code> | <code>string</code> | [deprecated] Has no effect since the built-in action cache was removed. |
11232
11214
 
11233
11215
  ---
11234
11216
 
@@ -11240,7 +11222,7 @@ public readonly auditReport: string;
11240
11222
 
11241
11223
  - *Type:* string
11242
11224
 
11243
- [experimental] File to write the complete task cache audit report to.
11225
+ [experimental] File that receives every undeclared path found by the `cache.audit` task option.
11244
11226
 
11245
11227
  ---
11246
11228
 
@@ -11252,7 +11234,7 @@ public readonly remoteMode: SettingsTaskCacheRemoteMode;
11252
11234
 
11253
11235
  - *Type:* <a href="#mise-projen.SettingsTaskCacheRemoteMode">SettingsTaskCacheRemoteMode</a>
11254
11236
 
11255
- [experimental] Remote task and action cache access mode.
11237
+ [experimental] How mise uses the remote task cache server.
11256
11238
 
11257
11239
  ---
11258
11240
 
@@ -11264,7 +11246,7 @@ public readonly remoteNamespace: string;
11264
11246
 
11265
11247
  - *Type:* string
11266
11248
 
11267
- [experimental] Namespace sent to the remote build cache.
11249
+ [experimental] Namespace that keeps this project's entries apart on the remote task cache server.
11268
11250
 
11269
11251
  ---
11270
11252
 
@@ -11276,7 +11258,7 @@ public readonly remoteOidcAudience: string;
11276
11258
 
11277
11259
  - *Type:* string
11278
11260
 
11279
- [experimental] Audience for an automatically acquired remote cache OIDC token.
11261
+ [experimental] Audience of the GitHub Actions OIDC token that mise requests for the remote task cache.
11280
11262
 
11281
11263
  ---
11282
11264
 
@@ -11288,7 +11270,7 @@ public readonly remoteToken: string;
11288
11270
 
11289
11271
  - *Type:* string
11290
11272
 
11291
- [experimental] Bearer token for remote build-cache authentication.
11273
+ [experimental] Bearer token that mise sends to the remote task cache server.
11292
11274
 
11293
11275
  ---
11294
11276
 
@@ -11300,7 +11282,7 @@ public readonly remoteTokenFile: string;
11300
11282
 
11301
11283
  - *Type:* string
11302
11284
 
11303
- [experimental] File containing a remote build-cache bearer token.
11285
+ [experimental] File that mise reads the remote task cache token from before each request.
11304
11286
 
11305
11287
  ---
11306
11288
 
@@ -11312,7 +11294,7 @@ public readonly remoteUrl: string;
11312
11294
 
11313
11295
  - *Type:* string
11314
11296
 
11315
- [experimental] Base URL for the remote build-cache service.
11297
+ [experimental] Base URL of the remote task cache server.
11316
11298
 
11317
11299
  ---
11318
11300
 
@@ -11324,7 +11306,7 @@ public readonly statsReport: string;
11324
11306
 
11325
11307
  - *Type:* string
11326
11308
 
11327
- [experimental] File to write action-cache session statistics to.
11309
+ [deprecated] Has no effect since the built-in action cache was removed.
11328
11310
 
11329
11311
  ---
11330
11312
 
@@ -11342,7 +11324,7 @@ const settingsToolUpdate: SettingsToolUpdate = { ... }
11342
11324
 
11343
11325
  | **Name** | **Type** | **Description** |
11344
11326
  | --- | --- | --- |
11345
- | <code><a href="#mise-projen.SettingsToolUpdate.property.checkDuration">checkDuration</a></code> | <code>string</code> | How often to check for updates to a global tool with `auto_update = true`. |
11327
+ | <code><a href="#mise-projen.SettingsToolUpdate.property.checkDuration">checkDuration</a></code> | <code>string</code> | How often mise checks for a newer version of a global tool that sets `auto_update = true`. |
11346
11328
 
11347
11329
  ---
11348
11330
 
@@ -11354,7 +11336,7 @@ public readonly checkDuration: string;
11354
11336
 
11355
11337
  - *Type:* string
11356
11338
 
11357
- How often to check for updates to a global tool with `auto_update = true`.
11339
+ How often mise checks for a newer version of a global tool that sets `auto_update = true`.
11358
11340
 
11359
11341
  ---
11360
11342
 
@@ -11372,8 +11354,8 @@ const settingsUpgrade: SettingsUpgrade = { ... }
11372
11354
 
11373
11355
  | **Name** | **Type** | **Description** |
11374
11356
  | --- | --- | --- |
11375
- | <code><a href="#mise-projen.SettingsUpgrade.property.autoPrune">autoPrune</a></code> | <code>boolean</code> | Schedule the version `mise upgrade` replaced for pruning once the new one has installed. |
11376
- | <code><a href="#mise-projen.SettingsUpgrade.property.pruneAfter">pruneAfter</a></code> | <code>string</code> | Grace period before versions replaced by `mise upgrade` are automatically pruned. |
11357
+ | <code><a href="#mise-projen.SettingsUpgrade.property.autoPrune">autoPrune</a></code> | <code>boolean</code> | Remove the version that `mise upgrade` replaced once `upgrade.prune_after` has passed. |
11358
+ | <code><a href="#mise-projen.SettingsUpgrade.property.pruneAfter">pruneAfter</a></code> | <code>string</code> | Grace period before mise removes a version that `mise upgrade` replaced. |
11377
11359
 
11378
11360
  ---
11379
11361
 
@@ -11385,7 +11367,7 @@ public readonly autoPrune: boolean;
11385
11367
 
11386
11368
  - *Type:* boolean
11387
11369
 
11388
- Schedule the version `mise upgrade` replaced for pruning once the new one has installed.
11370
+ Remove the version that `mise upgrade` replaced once `upgrade.prune_after` has passed.
11389
11371
 
11390
11372
  ---
11391
11373
 
@@ -11397,7 +11379,7 @@ public readonly pruneAfter: string;
11397
11379
 
11398
11380
  - *Type:* string
11399
11381
 
11400
- Grace period before versions replaced by `mise upgrade` are automatically pruned.
11382
+ Grace period before mise removes a version that `mise upgrade` replaced.
11401
11383
 
11402
11384
  ---
11403
11385
 
@@ -11415,9 +11397,9 @@ const settingsWriteTargets: SettingsWriteTargets = { ... }
11415
11397
 
11416
11398
  | **Name** | **Type** | **Description** |
11417
11399
  | --- | --- | --- |
11418
- | <code><a href="#mise-projen.SettingsWriteTargets.property.dotfiles">dotfiles</a></code> | <code>string</code> | Global config file to create new [dotfiles] entries in. |
11419
- | <code><a href="#mise-projen.SettingsWriteTargets.property.packages">packages</a></code> | <code>string</code> | Global config file to create new [bootstrap.packages] entries in. Existing entries stay in the config file that already declares them. |
11420
- | <code><a href="#mise-projen.SettingsWriteTargets.property.tools">tools</a></code> | <code>string</code> | Global config file to create new [tools] entries in. |
11400
+ | <code><a href="#mise-projen.SettingsWriteTargets.property.dotfiles">dotfiles</a></code> | <code>string</code> | Global config file where `mise dot add` creates new `[dotfiles]` entries. |
11401
+ | <code><a href="#mise-projen.SettingsWriteTargets.property.packages">packages</a></code> | <code>string</code> | Global config file where `--global` package commands create new `[bootstrap.packages]` entries. |
11402
+ | <code><a href="#mise-projen.SettingsWriteTargets.property.tools">tools</a></code> | <code>string</code> | Global config file where `mise use --global` creates new `[tools]` entries. |
11421
11403
 
11422
11404
  ---
11423
11405
 
@@ -11429,9 +11411,7 @@ public readonly dotfiles: string;
11429
11411
 
11430
11412
  - *Type:* string
11431
11413
 
11432
- Global config file to create new [dotfiles] entries in.
11433
-
11434
- Existing entries stay in the config file that already declares them.
11414
+ Global config file where `mise dot add` creates new `[dotfiles]` entries.
11435
11415
 
11436
11416
  ---
11437
11417
 
@@ -11443,7 +11423,7 @@ public readonly packages: string;
11443
11423
 
11444
11424
  - *Type:* string
11445
11425
 
11446
- Global config file to create new [bootstrap.packages] entries in. Existing entries stay in the config file that already declares them.
11426
+ Global config file where `--global` package commands create new `[bootstrap.packages]` entries.
11447
11427
 
11448
11428
  ---
11449
11429
 
@@ -11455,9 +11435,7 @@ public readonly tools: string;
11455
11435
 
11456
11436
  - *Type:* string
11457
11437
 
11458
- Global config file to create new [tools] entries in.
11459
-
11460
- Existing entries stay in the config file that already declares them.
11438
+ Global config file where `mise use --global` creates new `[tools]` entries.
11461
11439
 
11462
11440
  ---
11463
11441
 
@@ -11475,7 +11453,7 @@ const settingsZig: SettingsZig = { ... }
11475
11453
 
11476
11454
  | **Name** | **Type** | **Description** |
11477
11455
  | --- | --- | --- |
11478
- | <code><a href="#mise-projen.SettingsZig.property.useCommunityMirrors">useCommunityMirrors</a></code> | <code>boolean</code> | Download Zig from community-maintained mirrors. |
11456
+ | <code><a href="#mise-projen.SettingsZig.property.useCommunityMirrors">useCommunityMirrors</a></code> | <code>boolean</code> | Download Zig from the community mirrors that ziglang.org recommends before trying ziglang.org itself. |
11479
11457
 
11480
11458
  ---
11481
11459
 
@@ -11487,7 +11465,7 @@ public readonly useCommunityMirrors: boolean;
11487
11465
 
11488
11466
  - *Type:* boolean
11489
11467
 
11490
- Download Zig from community-maintained mirrors.
11468
+ Download Zig from the community mirrors that ziglang.org recommends before trying ziglang.org itself.
11491
11469
 
11492
11470
  ---
11493
11471
 
@@ -12111,7 +12089,7 @@ public readonly value: string | number | boolean;
12111
12089
 
12112
12090
  ### SettingsPythonUvVenvAuto <a name="SettingsPythonUvVenvAuto" id="mise-projen.SettingsPythonUvVenvAuto"></a>
12113
12091
 
12114
- Integrate with uv to manage project venvs when uv.lock is present.
12092
+ Activate, and optionally create, the virtualenv of the uv project around the current directory.
12115
12093
 
12116
12094
 
12117
12095
  #### Static Functions <a name="Static Functions" id="Static Functions"></a>
@@ -12691,6 +12669,35 @@ absent.
12691
12669
  ---
12692
12670
 
12693
12671
 
12672
+ ### MiseTomlSchemaBootstrapLinuxSystemdUnitsState <a name="MiseTomlSchemaBootstrapLinuxSystemdUnitsState" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState"></a>
12673
+
12674
+ present writes and manages the unit;
12675
+
12676
+ absent stops, disables, and removes both dev.mise.<name>.service and dev.mise.<name>.timer
12677
+
12678
+ #### Members <a name="Members" id="Members"></a>
12679
+
12680
+ | **Name** | **Description** |
12681
+ | --- | --- |
12682
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState.PRESENT">PRESENT</a></code> | present. |
12683
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState.ABSENT">ABSENT</a></code> | absent. |
12684
+
12685
+ ---
12686
+
12687
+ ##### `PRESENT` <a name="PRESENT" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState.PRESENT"></a>
12688
+
12689
+ present.
12690
+
12691
+ ---
12692
+
12693
+
12694
+ ##### `ABSENT` <a name="ABSENT" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState.ABSENT"></a>
12695
+
12696
+ absent.
12697
+
12698
+ ---
12699
+
12700
+
12694
12701
  ### MiseTomlSchemaBootstrapLinuxSystemdUnitsType <a name="MiseTomlSchemaBootstrapLinuxSystemdUnitsType" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsType"></a>
12695
12702
 
12696
12703
  write Type in the [Service] section.
@@ -13166,7 +13173,7 @@ symlink.
13166
13173
 
13167
13174
  ### SettingsColorTheme <a name="SettingsColorTheme" id="mise-projen.SettingsColorTheme"></a>
13168
13175
 
13169
- Theme for interactive prompts (auto/default, charm, base16, catppuccin, dracula).
13176
+ Color theme for interactive prompts, such as the task picker in `mise run`.
13170
13177
 
13171
13178
  #### Members <a name="Members" id="Members"></a>
13172
13179
 
@@ -13223,11 +13230,122 @@ dracula.
13223
13230
  ---
13224
13231
 
13225
13232
 
13226
- ### SettingsHistorySync <a name="SettingsHistorySync" id="mise-projen.SettingsHistorySync"></a>
13233
+ ### SettingsDotfilesDefaultMode <a name="SettingsDotfilesDefaultMode" id="mise-projen.SettingsDotfilesDefaultMode"></a>
13234
+
13235
+ Mode for `[dotfiles]` entries that do not set `mode`.
13236
+
13237
+ #### Members <a name="Members" id="Members"></a>
13238
+
13239
+ | **Name** | **Description** |
13240
+ | --- | --- |
13241
+ | <code><a href="#mise-projen.SettingsDotfilesDefaultMode.SYMLINK">SYMLINK</a></code> | symlink. |
13242
+ | <code><a href="#mise-projen.SettingsDotfilesDefaultMode.SYMLINK_HYPHEN_EACH">SYMLINK_HYPHEN_EACH</a></code> | symlink-each. |
13243
+ | <code><a href="#mise-projen.SettingsDotfilesDefaultMode.COPY">COPY</a></code> | copy. |
13244
+ | <code><a href="#mise-projen.SettingsDotfilesDefaultMode.TEMPLATE">TEMPLATE</a></code> | template. |
13245
+
13246
+ ---
13247
+
13248
+ ##### `SYMLINK` <a name="SYMLINK" id="mise-projen.SettingsDotfilesDefaultMode.SYMLINK"></a>
13249
+
13250
+ symlink.
13251
+
13252
+ ---
13253
+
13254
+
13255
+ ##### `SYMLINK_HYPHEN_EACH` <a name="SYMLINK_HYPHEN_EACH" id="mise-projen.SettingsDotfilesDefaultMode.SYMLINK_HYPHEN_EACH"></a>
13256
+
13257
+ symlink-each.
13258
+
13259
+ ---
13260
+
13261
+
13262
+ ##### `COPY` <a name="COPY" id="mise-projen.SettingsDotfilesDefaultMode.COPY"></a>
13263
+
13264
+ copy.
13265
+
13266
+ ---
13267
+
13268
+
13269
+ ##### `TEMPLATE` <a name="TEMPLATE" id="mise-projen.SettingsDotfilesDefaultMode.TEMPLATE"></a>
13270
+
13271
+ template.
13272
+
13273
+ ---
13274
+
13275
+
13276
+ ### SettingsErlangPrecompiledOs <a name="SettingsErlangPrecompiledOs" id="mise-projen.SettingsErlangPrecompiledOs"></a>
13277
+
13278
+ Ubuntu release whose precompiled Erlang build from builds.hex.pm mise installs on Linux.
13279
+
13280
+ #### Members <a name="Members" id="Members"></a>
13281
+
13282
+ | **Name** | **Description** |
13283
+ | --- | --- |
13284
+ | <code><a href="#mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_20_04">UBUNTU_HYPHEN_20_04</a></code> | ubuntu-20.04. |
13285
+ | <code><a href="#mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_22_04">UBUNTU_HYPHEN_22_04</a></code> | ubuntu-22.04. |
13286
+ | <code><a href="#mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_24_04">UBUNTU_HYPHEN_24_04</a></code> | ubuntu-24.04. |
13287
+ | <code><a href="#mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_26_04">UBUNTU_HYPHEN_26_04</a></code> | ubuntu-26.04. |
13288
+
13289
+ ---
13290
+
13291
+ ##### `UBUNTU_HYPHEN_20_04` <a name="UBUNTU_HYPHEN_20_04" id="mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_20_04"></a>
13292
+
13293
+ ubuntu-20.04.
13294
+
13295
+ ---
13296
+
13297
+
13298
+ ##### `UBUNTU_HYPHEN_22_04` <a name="UBUNTU_HYPHEN_22_04" id="mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_22_04"></a>
13299
+
13300
+ ubuntu-22.04.
13301
+
13302
+ ---
13303
+
13304
+
13305
+ ##### `UBUNTU_HYPHEN_24_04` <a name="UBUNTU_HYPHEN_24_04" id="mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_24_04"></a>
13306
+
13307
+ ubuntu-24.04.
13308
+
13309
+ ---
13310
+
13311
+
13312
+ ##### `UBUNTU_HYPHEN_26_04` <a name="UBUNTU_HYPHEN_26_04" id="mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_26_04"></a>
13313
+
13314
+ ubuntu-26.04.
13315
+
13316
+ ---
13317
+
13318
+
13319
+ ### SettingsGithubRelayLogFormat <a name="SettingsGithubRelayLogFormat" id="mise-projen.SettingsGithubRelayLogFormat"></a>
13320
+
13321
+ Format of GitHub relay request logs and the end-of-session summary.
13322
+
13323
+ #### Members <a name="Members" id="Members"></a>
13324
+
13325
+ | **Name** | **Description** |
13326
+ | --- | --- |
13327
+ | <code><a href="#mise-projen.SettingsGithubRelayLogFormat.TEXT">TEXT</a></code> | text. |
13328
+ | <code><a href="#mise-projen.SettingsGithubRelayLogFormat.JSONL">JSONL</a></code> | jsonl. |
13329
+
13330
+ ---
13331
+
13332
+ ##### `TEXT` <a name="TEXT" id="mise-projen.SettingsGithubRelayLogFormat.TEXT"></a>
13333
+
13334
+ text.
13335
+
13336
+ ---
13337
+
13227
13338
 
13228
- What the history watcher does with a connected setup repository on its own: `sync` publishes after saves, fetches periodically, and applies incoming changes.
13339
+ ##### `JSONL` <a name="JSONL" id="mise-projen.SettingsGithubRelayLogFormat.JSONL"></a>
13229
13340
 
13230
- Any conflict pauses publication and incoming application for the entire setup; local commits and fetching continue. `fetch-only` only fetches; `manual` does nothing automatically. `mise bootstrap dotfiles sync` and `pull` work on request in every mode.
13341
+ jsonl.
13342
+
13343
+ ---
13344
+
13345
+
13346
+ ### SettingsHistorySync <a name="SettingsHistorySync" id="mise-projen.SettingsHistorySync"></a>
13347
+
13348
+ What the history watcher shares with a connected setup repository on its own.
13231
13349
 
13232
13350
  #### Members <a name="Members" id="Members"></a>
13233
13351
 
@@ -13289,7 +13407,7 @@ identity.
13289
13407
 
13290
13408
  ### SettingsLibc <a name="SettingsLibc" id="mise-projen.SettingsLibc"></a>
13291
13409
 
13292
- Libc implementation to use for precompiled Linux binaries.
13410
+ Libc build to install on Linux when a tool publishes both glibc and musl builds.
13293
13411
 
13294
13412
  #### Members <a name="Members" id="Members"></a>
13295
13413
 
@@ -13357,7 +13475,7 @@ system.
13357
13475
 
13358
13476
  ### SettingsLockfileMode <a name="SettingsLockfileMode" id="mise-projen.SettingsLockfileMode"></a>
13359
13477
 
13360
- Choose incremental merging or complete lockfile generation.
13478
+ How lockfiles are written: entry by entry, or rebuilt from the current requests.
13361
13479
 
13362
13480
  #### Members <a name="Members" id="Members"></a>
13363
13481
 
@@ -13384,7 +13502,7 @@ generate.
13384
13502
 
13385
13503
  ### SettingsLogLevel <a name="SettingsLogLevel" id="mise-projen.SettingsLogLevel"></a>
13386
13504
 
13387
- Show more/less output.
13505
+ Log level for mise's own output.
13388
13506
 
13389
13507
  #### Members <a name="Members" id="Members"></a>
13390
13508
 
@@ -13435,7 +13553,7 @@ error.
13435
13553
 
13436
13554
  ### SettingsNpmPackageManager <a name="SettingsNpmPackageManager" id="mise-projen.SettingsNpmPackageManager"></a>
13437
13555
 
13438
- Package manager to use for installing npm packages.
13556
+ Package manager that installs `npm:` tools.
13439
13557
 
13440
13558
  #### Members <a name="Members" id="Members"></a>
13441
13559
 
@@ -13492,9 +13610,44 @@ pnpm.
13492
13610
  ---
13493
13611
 
13494
13612
 
13613
+ ### SettingsStatusMissingTools <a name="SettingsStatusMissingTools" id="mise-projen.SettingsStatusMissingTools"></a>
13614
+
13615
+ When to warn that tools requested by config are not installed.
13616
+
13617
+ #### Members <a name="Members" id="Members"></a>
13618
+
13619
+ | **Name** | **Description** |
13620
+ | --- | --- |
13621
+ | <code><a href="#mise-projen.SettingsStatusMissingTools.NEVER">NEVER</a></code> | never. |
13622
+ | <code><a href="#mise-projen.SettingsStatusMissingTools.IF_UNDERSCORE_OTHER_UNDERSCORE_VERSIONS_UNDERSCORE_INSTALLED">IF_UNDERSCORE_OTHER_UNDERSCORE_VERSIONS_UNDERSCORE_INSTALLED</a></code> | if_other_versions_installed. |
13623
+ | <code><a href="#mise-projen.SettingsStatusMissingTools.ALWAYS">ALWAYS</a></code> | always. |
13624
+
13625
+ ---
13626
+
13627
+ ##### `NEVER` <a name="NEVER" id="mise-projen.SettingsStatusMissingTools.NEVER"></a>
13628
+
13629
+ never.
13630
+
13631
+ ---
13632
+
13633
+
13634
+ ##### `IF_UNDERSCORE_OTHER_UNDERSCORE_VERSIONS_UNDERSCORE_INSTALLED` <a name="IF_UNDERSCORE_OTHER_UNDERSCORE_VERSIONS_UNDERSCORE_INSTALLED" id="mise-projen.SettingsStatusMissingTools.IF_UNDERSCORE_OTHER_UNDERSCORE_VERSIONS_UNDERSCORE_INSTALLED"></a>
13635
+
13636
+ if_other_versions_installed.
13637
+
13638
+ ---
13639
+
13640
+
13641
+ ##### `ALWAYS` <a name="ALWAYS" id="mise-projen.SettingsStatusMissingTools.ALWAYS"></a>
13642
+
13643
+ always.
13644
+
13645
+ ---
13646
+
13647
+
13495
13648
  ### SettingsSystemDeps <a name="SettingsSystemDeps" id="mise-projen.SettingsSystemDeps"></a>
13496
13649
 
13497
- How to handle a plugin's declared system dependencies before installing a tool.
13650
+ What mise does when a plugin's declared system dependencies are missing before it installs a tool.
13498
13651
 
13499
13652
  #### Members <a name="Members" id="Members"></a>
13500
13653
 
@@ -13537,7 +13690,7 @@ ignore.
13537
13690
 
13538
13691
  ### SettingsTaskCacheRemoteMode <a name="SettingsTaskCacheRemoteMode" id="mise-projen.SettingsTaskCacheRemoteMode"></a>
13539
13692
 
13540
- [experimental] Remote task and action cache access mode.
13693
+ [experimental] How mise uses the remote task cache server.
13541
13694
 
13542
13695
  #### Members <a name="Members" id="Members"></a>
13543
13696
 
@@ -13572,7 +13725,7 @@ write-only.
13572
13725
 
13573
13726
  ### SettingsTaskOutput <a name="SettingsTaskOutput" id="mise-projen.SettingsTaskOutput"></a>
13574
13727
 
13575
- Change output style when executing tasks.
13728
+ Default output style for `mise run`.
13576
13729
 
13577
13730
  #### Members <a name="Members" id="Members"></a>
13578
13731
 
@@ -13636,3 +13789,46 @@ silent.
13636
13789
 
13637
13790
  ---
13638
13791
 
13792
+
13793
+ ### SettingsWindowsShimMode <a name="SettingsWindowsShimMode" id="mise-projen.SettingsWindowsShimMode"></a>
13794
+
13795
+ How mise creates shims on Windows.
13796
+
13797
+ #### Members <a name="Members" id="Members"></a>
13798
+
13799
+ | **Name** | **Description** |
13800
+ | --- | --- |
13801
+ | <code><a href="#mise-projen.SettingsWindowsShimMode.EXE">EXE</a></code> | exe. |
13802
+ | <code><a href="#mise-projen.SettingsWindowsShimMode.FILE">FILE</a></code> | file. |
13803
+ | <code><a href="#mise-projen.SettingsWindowsShimMode.HARDLINK">HARDLINK</a></code> | hardlink. |
13804
+ | <code><a href="#mise-projen.SettingsWindowsShimMode.SYMLINK">SYMLINK</a></code> | symlink. |
13805
+
13806
+ ---
13807
+
13808
+ ##### `EXE` <a name="EXE" id="mise-projen.SettingsWindowsShimMode.EXE"></a>
13809
+
13810
+ exe.
13811
+
13812
+ ---
13813
+
13814
+
13815
+ ##### `FILE` <a name="FILE" id="mise-projen.SettingsWindowsShimMode.FILE"></a>
13816
+
13817
+ file.
13818
+
13819
+ ---
13820
+
13821
+
13822
+ ##### `HARDLINK` <a name="HARDLINK" id="mise-projen.SettingsWindowsShimMode.HARDLINK"></a>
13823
+
13824
+ hardlink.
13825
+
13826
+ ---
13827
+
13828
+
13829
+ ##### `SYMLINK` <a name="SYMLINK" id="mise-projen.SettingsWindowsShimMode.SYMLINK"></a>
13830
+
13831
+ symlink.
13832
+
13833
+ ---
13834
+