mise-projen 0.0.8 → 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
@@ -929,6 +929,7 @@ const miseTomlSchema: MiseTomlSchema = { ... }
929
929
  | <code><a href="#mise-projen.MiseTomlSchema.property.oci">oci</a></code> | <code><a href="#mise-projen.MiseTomlSchemaOci">MiseTomlSchemaOci</a></code> | configuration for `mise oci build`. |
930
930
  | <code><a href="#mise-projen.MiseTomlSchema.property.plugins">plugins</a></code> | <code>{[ key: string ]: string}</code> | plugins to use. |
931
931
  | <code><a href="#mise-projen.MiseTomlSchema.property.redactions">redactions</a></code> | <code>string[]</code> | env or vars keys to redact from logs. |
932
+ | <code><a href="#mise-projen.MiseTomlSchema.property.secrets">secrets</a></code> | <code><a href="#mise-projen.MiseTomlSchemaSecrets">MiseTomlSchemaSecrets</a></code> | [experimental] Sources for mise secrets: values resolved only when mise starts a task or `mise x` command that was granted them. |
932
933
  | <code><a href="#mise-projen.MiseTomlSchema.property.settings">settings</a></code> | <code><a href="#mise-projen.Settings">Settings</a></code> | mise settings. |
933
934
  | <code><a href="#mise-projen.MiseTomlSchema.property.shellAlias">shellAlias</a></code> | <code>{[ key: string ]: string}</code> | shell aliases. |
934
935
  | <code><a href="#mise-projen.MiseTomlSchema.property.taskConfig">taskConfig</a></code> | <code><a href="#mise-projen.TaskConfig">TaskConfig</a></code> | configuration for task execution and management. |
@@ -1241,6 +1242,20 @@ env or vars keys to redact from logs.
1241
1242
 
1242
1243
  ---
1243
1244
 
1245
+ ##### `secrets`<sup>Optional</sup> <a name="secrets" id="mise-projen.MiseTomlSchema.property.secrets"></a>
1246
+
1247
+ ```typescript
1248
+ public readonly secrets: MiseTomlSchemaSecrets;
1249
+ ```
1250
+
1251
+ - *Type:* <a href="#mise-projen.MiseTomlSchemaSecrets">MiseTomlSchemaSecrets</a>
1252
+
1253
+ [experimental] Sources for mise secrets: values resolved only when mise starts a task or `mise x` command that was granted them.
1254
+
1255
+ Project config only.
1256
+
1257
+ ---
1258
+
1244
1259
  ##### `settings`<sup>Optional</sup> <a name="settings" id="mise-projen.MiseTomlSchema.property.settings"></a>
1245
1260
 
1246
1261
  ```typescript
@@ -1943,6 +1958,7 @@ const miseTomlSchemaBootstrapDirectories: MiseTomlSchemaBootstrapDirectories = {
1943
1958
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.group">group</a></code> | <code>string</code> | *No description.* |
1944
1959
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.mode">mode</a></code> | <code>string</code> | *No description.* |
1945
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; |
1946
1962
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.owner">owner</a></code> | <code>string</code> | *No description.* |
1947
1963
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.phase">phase</a></code> | <code><a href="#mise-projen.BootstrapFilePhase">BootstrapFilePhase</a></code> | *No description.* |
1948
1964
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.recursive">recursive</a></code> | <code>boolean</code> | *No description.* |
@@ -1981,6 +1997,20 @@ public readonly notify: string[];
1981
1997
 
1982
1998
  ---
1983
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
+
1984
2014
  ##### `owner`<sup>Optional</sup> <a name="owner" id="mise-projen.MiseTomlSchemaBootstrapDirectories.property.owner"></a>
1985
2015
 
1986
2016
  ```typescript
@@ -2049,6 +2079,7 @@ const miseTomlSchemaBootstrapFiles: MiseTomlSchemaBootstrapFiles = { ... }
2049
2079
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.group">group</a></code> | <code>string</code> | *No description.* |
2050
2080
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.mode">mode</a></code> | <code>string</code> | *No description.* |
2051
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; |
2052
2083
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.owner">owner</a></code> | <code>string</code> | *No description.* |
2053
2084
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.phase">phase</a></code> | <code><a href="#mise-projen.BootstrapFilePhase">BootstrapFilePhase</a></code> | *No description.* |
2054
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; |
@@ -2099,6 +2130,20 @@ public readonly notify: string[];
2099
2130
 
2100
2131
  ---
2101
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
+
2102
2147
  ##### `owner`<sup>Optional</sup> <a name="owner" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.owner"></a>
2103
2148
 
2104
2149
  ```typescript
@@ -2696,6 +2741,7 @@ const miseTomlSchemaBootstrapLinuxSystemdUnits: MiseTomlSchemaBootstrapLinuxSyst
2696
2741
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.standardError">standardError</a></code> | <code>string</code> | write StandardError in the [Service] section. |
2697
2742
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.standardOutput">standardOutput</a></code> | <code>string</code> | write StandardOutput in the [Service] section. |
2698
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; |
2699
2745
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.timeoutStartSec">timeoutStartSec</a></code> | <code>string</code> | write TimeoutStartSec in the [Service] section. |
2700
2746
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.timeoutStopSec">timeoutStopSec</a></code> | <code>string</code> | write TimeoutStopSec in the [Service] section. |
2701
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. |
@@ -3069,6 +3115,20 @@ when false, stop the unit after writing it
3069
3115
 
3070
3116
  ---
3071
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
+
3072
3132
  ##### `timeoutStartSec`<sup>Optional</sup> <a name="timeoutStartSec" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.timeoutStartSec"></a>
3073
3133
 
3074
3134
  ```typescript
@@ -5143,6 +5203,7 @@ const miseTomlSchemaHistory: MiseTomlSchemaHistory = { ... }
5143
5203
  | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.encryption">encryption</a></code> | <code><a href="#mise-projen.MiseTomlSchemaHistoryEncryption">MiseTomlSchemaHistoryEncryption</a></code> | *No description.* |
5144
5204
  | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.exclude">exclude</a></code> | <code>string[]</code> | globs never captured by dotfiles history; |
5145
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. |
5146
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; |
5147
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). |
5148
5209
 
@@ -5186,6 +5247,18 @@ email used for history commit authors and committers;
5186
5247
 
5187
5248
  ---
5188
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
+
5189
5262
  ##### `origin`<sup>Optional</sup> <a name="origin" id="mise-projen.MiseTomlSchemaHistory.property.origin"></a>
5190
5263
 
5191
5264
  ```typescript
@@ -5510,6 +5583,74 @@ absolute non-root image path without `.` or `..` components.
5510
5583
 
5511
5584
  ---
5512
5585
 
5586
+ ### MiseTomlSchemaSecrets <a name="MiseTomlSchemaSecrets" id="mise-projen.MiseTomlSchemaSecrets"></a>
5587
+
5588
+ [experimental] Sources for mise secrets: values resolved only when mise starts a task or `mise x` command that was granted them.
5589
+
5590
+ Project config only.
5591
+
5592
+ #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaSecrets.Initializer"></a>
5593
+
5594
+ ```typescript
5595
+ import { MiseTomlSchemaSecrets } from 'mise-projen'
5596
+
5597
+ const miseTomlSchemaSecrets: MiseTomlSchemaSecrets = { ... }
5598
+ ```
5599
+
5600
+ #### Properties <a name="Properties" id="Properties"></a>
5601
+
5602
+ | **Name** | **Type** | **Description** |
5603
+ | --- | --- | --- |
5604
+ | <code><a href="#mise-projen.MiseTomlSchemaSecrets.property.fnox">fnox</a></code> | <code><a href="#mise-projen.MiseTomlSchemaSecretsFnox">MiseTomlSchemaSecretsFnox</a></code> | Use fnox (fnox.toml discovered from this config's directory). https://mise.jdx.dev/environments/secrets/fnox.html. |
5605
+
5606
+ ---
5607
+
5608
+ ##### `fnox`<sup>Optional</sup> <a name="fnox" id="mise-projen.MiseTomlSchemaSecrets.property.fnox"></a>
5609
+
5610
+ ```typescript
5611
+ public readonly fnox: MiseTomlSchemaSecretsFnox;
5612
+ ```
5613
+
5614
+ - *Type:* <a href="#mise-projen.MiseTomlSchemaSecretsFnox">MiseTomlSchemaSecretsFnox</a>
5615
+
5616
+ Use fnox (fnox.toml discovered from this config's directory). https://mise.jdx.dev/environments/secrets/fnox.html.
5617
+
5618
+ ---
5619
+
5620
+ ### MiseTomlSchemaSecretsFnox <a name="MiseTomlSchemaSecretsFnox" id="mise-projen.MiseTomlSchemaSecretsFnox"></a>
5621
+
5622
+ Use fnox (fnox.toml discovered from this config's directory). https://mise.jdx.dev/environments/secrets/fnox.html.
5623
+
5624
+ #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaSecretsFnox.Initializer"></a>
5625
+
5626
+ ```typescript
5627
+ import { MiseTomlSchemaSecretsFnox } from 'mise-projen'
5628
+
5629
+ const miseTomlSchemaSecretsFnox: MiseTomlSchemaSecretsFnox = { ... }
5630
+ ```
5631
+
5632
+ #### Properties <a name="Properties" id="Properties"></a>
5633
+
5634
+ | **Name** | **Type** | **Description** |
5635
+ | --- | --- | --- |
5636
+ | <code><a href="#mise-projen.MiseTomlSchemaSecretsFnox.property.profile">profile</a></code> | <code>string</code> | fnox profile (fnox -P); |
5637
+
5638
+ ---
5639
+
5640
+ ##### `profile`<sup>Optional</sup> <a name="profile" id="mise-projen.MiseTomlSchemaSecretsFnox.property.profile"></a>
5641
+
5642
+ ```typescript
5643
+ public readonly profile: string;
5644
+ ```
5645
+
5646
+ - *Type:* string
5647
+
5648
+ fnox profile (fnox -P);
5649
+
5650
+ defaults to FNOX_PROFILE, then "default"
5651
+
5652
+ ---
5653
+
5513
5654
  ### Monorepo <a name="Monorepo" id="mise-projen.Monorepo"></a>
5514
5655
 
5515
5656
  Configuration for monorepo task discovery.
@@ -5709,174 +5850,179 @@ const settings: Settings = { ... }
5709
5850
 
5710
5851
  | **Name** | **Type** | **Description** |
5711
5852
  | --- | --- | --- |
5712
- | <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. |
5713
- | <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. |
5714
5855
  | <code><a href="#mise-projen.Settings.property.age">age</a></code> | <code><a href="#mise-projen.SettingsAge">SettingsAge</a></code> | *No description.* |
5715
- | <code><a href="#mise-projen.Settings.property.allCompile">allCompile</a></code> | <code>boolean</code> | do not use precompiled binaries for any tool. |
5716
- | <code><a href="#mise-projen.Settings.property.alwaysKeepDownload">alwaysKeepDownload</a></code> | <code>boolean</code> | keep downloaded files after installation for debugging. |
5717
- | <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. |
5718
5859
  | <code><a href="#mise-projen.Settings.property.aqua">aqua</a></code> | <code><a href="#mise-projen.SettingsAqua">SettingsAqua</a></code> | *No description.* |
5719
- | <code><a href="#mise-projen.Settings.property.arch">arch</a></code> | <code>string</code> | Architecture to use for precompiled binaries. |
5720
- | <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. |
5721
5862
  | <code><a href="#mise-projen.Settings.property.autoEnv">autoEnv</a></code> | <code>boolean</code> | Automatically enable platform config environments (unix, {os}, {os}-{arch}). |
5722
- | <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. |
5723
- | <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. |
5724
- | <code><a href="#mise-projen.Settings.property.autoUpdate">autoUpdate</a></code> | <code>boolean</code> | Automatically update mise before running eligible commands. |
5725
- | <code><a href="#mise-projen.Settings.property.autoUpdateCheckDuration">autoUpdateCheckDuration</a></code> | <code>string</code> | How often to check for a new mise release when auto-update is enabled. |
5726
- | <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. |
5727
5868
  | <code><a href="#mise-projen.Settings.property.cargo">cargo</a></code> | <code><a href="#mise-projen.SettingsCargo">SettingsCargo</a></code> | *No description.* |
5728
- | <code><a href="#mise-projen.Settings.property.cd">cd</a></code> | <code>string</code> | Path to change to after launching mise. |
5729
- | <code><a href="#mise-projen.Settings.property.ceilingPaths">ceilingPaths</a></code> | <code>string[]</code> | Directories where mise stops searching for config files. |
5730
- | <code><a href="#mise-projen.Settings.property.ci">ci</a></code> | <code>boolean</code> | Set to true if running in a CI environment. |
5731
- | <code><a href="#mise-projen.Settings.property.color">color</a></code> | <code>boolean</code> | Use color in mise terminal output. |
5732
- | <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`. |
5733
5874
  | <code><a href="#mise-projen.Settings.property.conda">conda</a></code> | <code><a href="#mise-projen.SettingsConda">SettingsConda</a></code> | *No description.* |
5734
- | <code><a href="#mise-projen.Settings.property.debug">debug</a></code> | <code>boolean</code> | Sets log level to debug. |
5735
- | <code><a href="#mise-projen.Settings.property.defaultConfigFilename">defaultConfigFilename</a></code> | <code>string</code> | The default config filename read. |
5736
- | <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. |
5737
- | <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. |
5738
- | <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`. |
5739
- | <code><a href="#mise-projen.Settings.property.disableHints">disableHints</a></code> | <code>string[]</code> | Turns off helpful hints when using different mise features. |
5740
- | <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. |
5741
5882
  | <code><a href="#mise-projen.Settings.property.disableUpdateWarning">disableUpdateWarning</a></code> | <code>boolean</code> | Suppress warnings when a newer mise version is available. |
5742
5883
  | <code><a href="#mise-projen.Settings.property.dotfiles">dotfiles</a></code> | <code><a href="#mise-projen.SettingsDotfiles">SettingsDotfiles</a></code> | *No description.* |
5743
5884
  | <code><a href="#mise-projen.Settings.property.dotnet">dotnet</a></code> | <code><a href="#mise-projen.SettingsDotnet">SettingsDotnet</a></code> | *No description.* |
5744
- | <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. |
5745
- | <code><a href="#mise-projen.Settings.property.env">env</a></code> | <code>string[]</code> | Env to use for mise.<MISE_ENV>.toml files. |
5746
- | <code><a href="#mise-projen.Settings.property.envCache">envCache</a></code> | <code>boolean</code> | [experimental] Enable environment caching for nested mise invocations. |
5747
- | <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. |
5748
5889
  | <code><a href="#mise-projen.Settings.property.envConfD">envConfD</a></code> | <code>boolean</code> | Enable environment-specific filenames in conf.d directories. |
5749
- | <code><a href="#mise-projen.Settings.property.envFile">envFile</a></code> | <code>string</code> | Path to a file containing environment variables to automatically load. |
5750
- | <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. |
5751
5892
  | <code><a href="#mise-projen.Settings.property.erlang">erlang</a></code> | <code><a href="#mise-projen.SettingsErlang">SettingsErlang</a></code> | *No description.* |
5752
- | <code><a href="#mise-projen.Settings.property.execAutoInstall">execAutoInstall</a></code> | <code>boolean</code> | Automatically install missing tools when running `mise x`. |
5753
- | <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. |
5754
- | <code><a href="#mise-projen.Settings.property.fetchRemoteVersionsCache">fetchRemoteVersionsCache</a></code> | <code>string</code> | How long to cache remote versions for tools. |
5755
- | <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. |
5756
5897
  | <code><a href="#mise-projen.Settings.property.forgejo">forgejo</a></code> | <code><a href="#mise-projen.SettingsForgejo">SettingsForgejo</a></code> | *No description.* |
5757
5898
  | <code><a href="#mise-projen.Settings.property.github">github</a></code> | <code><a href="#mise-projen.SettingsGithub">SettingsGithub</a></code> | *No description.* |
5758
- | <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. |
5759
5900
  | <code><a href="#mise-projen.Settings.property.githubRelay">githubRelay</a></code> | <code><a href="#mise-projen.SettingsGithubRelay">SettingsGithubRelay</a></code> | *No description.* |
5760
5901
  | <code><a href="#mise-projen.Settings.property.gitlab">gitlab</a></code> | <code><a href="#mise-projen.SettingsGitlab">SettingsGitlab</a></code> | *No description.* |
5761
- | <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. |
5762
- | <code><a href="#mise-projen.Settings.property.globalConfigFile">globalConfigFile</a></code> | <code>string</code> | Path to the global mise config file. |
5763
- | <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. |
5764
5905
  | <code><a href="#mise-projen.Settings.property.go">go</a></code> | <code><a href="#mise-projen.SettingsGo">SettingsGo</a></code> | *No description.* |
5765
- | <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. |
5766
- | <code><a href="#mise-projen.Settings.property.goDownloadMirror">goDownloadMirror</a></code> | <code>string</code> | Mirror to download go sdk tarballs from. |
5767
- | <code><a href="#mise-projen.Settings.property.goRepo">goRepo</a></code> | <code>string</code> | URL to fetch go from. |
5768
- | <code><a href="#mise-projen.Settings.property.goSetGobin">goSetGobin</a></code> | <code>boolean</code> | Changes where `go install` installs binaries to. |
5769
- | <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. |
5770
- | <code><a href="#mise-projen.Settings.property.goSetGoroot">goSetGoroot</a></code> | <code>boolean</code> | Sets GOROOT=~/.local/share/mise/installs/go/.../. |
5771
- | <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. |
5772
- | <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. |
5773
5914
  | <code><a href="#mise-projen.Settings.property.history">history</a></code> | <code><a href="#mise-projen.SettingsHistory">SettingsHistory</a></code> | *No description.* |
5774
5915
  | <code><a href="#mise-projen.Settings.property.hookEnv">hookEnv</a></code> | <code><a href="#mise-projen.SettingsHookEnv">SettingsHookEnv</a></code> | *No description.* |
5775
- | <code><a href="#mise-projen.Settings.property.httpDownloadTimeout">httpDownloadTimeout</a></code> | <code>string</code> | Total time allowed for an HTTP download, including retries. |
5776
- | <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. |
5777
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. |
5778
- | <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. |
5779
- | <code><a href="#mise-projen.Settings.property.idiomaticVersionFileDisableFiles">idiomaticVersionFileDisableFiles</a></code> | <code>string[]</code> | Specific idiomatic version files to disable for a tool. |
5780
- | <code><a href="#mise-projen.Settings.property.idiomaticVersionFileDisableTools">idiomaticVersionFileDisableTools</a></code> | <code>string[]</code> | Specific tools to disable idiomatic version files for. |
5781
- | <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`. |
5782
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. |
5783
- | <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. |
5784
- | <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; |
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`). |
5785
5927
  | <code><a href="#mise-projen.Settings.property.java">java</a></code> | <code><a href="#mise-projen.SettingsJava">SettingsJava</a></code> | *No description.* |
5786
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. |
5787
- | <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. |
5788
- | <code><a href="#mise-projen.Settings.property.legacyVersionFileDisableTools">legacyVersionFileDisableTools</a></code> | <code>string[]</code> | Specific tools to disable idiomatic version files for. |
5789
- | <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. |
5790
- | <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. |
5791
- | <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. |
5792
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. |
5793
- | <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. |
5794
- | <code><a href="#mise-projen.Settings.property.lockfile">lockfile</a></code> | <code>boolean</code> | Create and read lockfiles for tool versions. |
5795
- | <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. |
5796
- | <code><a href="#mise-projen.Settings.property.lockfilePlatforms">lockfilePlatforms</a></code> | <code>string[]</code> | Platforms to target in lockfile operations. |
5797
- | <code><a href="#mise-projen.Settings.property.logLevel">logLevel</a></code> | <code><a href="#mise-projen.SettingsLogLevel">SettingsLogLevel</a></code> | Show more/less output. |
5798
- | <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. |
5799
- | <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. |
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. |
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. |
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. |
5800
5943
  | <code><a href="#mise-projen.Settings.property.netrc">netrc</a></code> | <code>boolean</code> | Use a netrc file for HTTP Basic authentication. |
5801
- | <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). |
5802
5945
  | <code><a href="#mise-projen.Settings.property.node">node</a></code> | <code><a href="#mise-projen.SettingsNode">SettingsNode</a></code> | *No description.* |
5803
5946
  | <code><a href="#mise-projen.Settings.property.noEnv">noEnv</a></code> | <code>boolean</code> | Do not load environment variables from config files. |
5804
5947
  | <code><a href="#mise-projen.Settings.property.noHooks">noHooks</a></code> | <code>boolean</code> | Do not execute hooks from config files. |
5805
- | <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. |
5806
- | <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. |
5807
- | <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. |
5808
5951
  | <code><a href="#mise-projen.Settings.property.npm">npm</a></code> | <code><a href="#mise-projen.SettingsNpm">SettingsNpm</a></code> | *No description.* |
5809
5952
  | <code><a href="#mise-projen.Settings.property.oci">oci</a></code> | <code><a href="#mise-projen.SettingsOci">SettingsOci</a></code> | *No description.* |
5810
- | <code><a href="#mise-projen.Settings.property.offline">offline</a></code> | <code>boolean</code> | Disable all HTTP requests. |
5811
- | <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. |
5812
5955
  | <code><a href="#mise-projen.Settings.property.otel">otel</a></code> | <code><a href="#mise-projen.SettingsOtel">SettingsOtel</a></code> | *No description.* |
5813
- | <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. |
5814
- | <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`. |
5815
5958
  | <code><a href="#mise-projen.Settings.property.packslip">packslip</a></code> | <code><a href="#mise-projen.SettingsPackslip">SettingsPackslip</a></code> | *No description.* |
5816
- | <code><a href="#mise-projen.Settings.property.paranoid">paranoid</a></code> | <code>boolean</code> | Enables extra-secure behavior. |
5817
- | <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. |
5818
5961
  | <code><a href="#mise-projen.Settings.property.pipx">pipx</a></code> | <code><a href="#mise-projen.SettingsPipx">SettingsPipx</a></code> | *No description.* |
5819
- | <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). |
5820
- | <code><a href="#mise-projen.Settings.property.preferOffline">preferOffline</a></code> | <code>boolean</code> | Prefer locally cached data over remote fetches when possible. |
5821
- | <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. |
5822
- | <code><a href="#mise-projen.Settings.property.profile">profile</a></code> | <code>string</code> | Profile to use for mise.${MISE_PROFILE}.toml files. |
5823
- | <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. |
5967
+ | <code><a href="#mise-projen.Settings.property.prune">prune</a></code> | <code><a href="#mise-projen.SettingsPrune">SettingsPrune</a></code> | *No description.* |
5824
5968
  | <code><a href="#mise-projen.Settings.property.pypi">pypi</a></code> | <code><a href="#mise-projen.SettingsPypi">SettingsPypi</a></code> | *No description.* |
5825
5969
  | <code><a href="#mise-projen.Settings.property.python">python</a></code> | <code><a href="#mise-projen.SettingsPython">SettingsPython</a></code> | *No description.* |
5826
- | <code><a href="#mise-projen.Settings.property.quiet">quiet</a></code> | <code>boolean</code> | Suppress all output except errors. |
5827
- | <code><a href="#mise-projen.Settings.property.raw">raw</a></code> | <code>boolean</code> | Connect stdin/stdout/stderr to child processes. |
5828
- | <code><a href="#mise-projen.Settings.property.registryCacheTtl">registryCacheTtl</a></code> | <code>string</code> | How long to cache the floating mise registry. |
5829
- | <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. |
5830
5974
  | <code><a href="#mise-projen.Settings.property.ruby">ruby</a></code> | <code><a href="#mise-projen.SettingsRuby">SettingsRuby</a></code> | *No description.* |
5831
5975
  | <code><a href="#mise-projen.Settings.property.rust">rust</a></code> | <code><a href="#mise-projen.SettingsRust">SettingsRust</a></code> | *No description.* |
5832
- | <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. |
5833
5977
  | <code><a href="#mise-projen.Settings.property.sandbox">sandbox</a></code> | <code><a href="#mise-projen.SettingsSandbox">SettingsSandbox</a></code> | *No description.* |
5834
5978
  | <code><a href="#mise-projen.Settings.property.selfUpdate">selfUpdate</a></code> | <code><a href="#mise-projen.SettingsSelfUpdate">SettingsSelfUpdate</a></code> | *No description.* |
5835
- | <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. |
5836
5980
  | <code><a href="#mise-projen.Settings.property.shims">shims</a></code> | <code><a href="#mise-projen.SettingsShims">SettingsShims</a></code> | *No description.* |
5837
- | <code><a href="#mise-projen.Settings.property.shimsDir">shimsDir</a></code> | <code>string</code> | Directory containing user shims. |
5838
- | <code><a href="#mise-projen.Settings.property.shorthandsFile">shorthandsFile</a></code> | <code>string</code> | [deprecated] Path to a file containing custom tool shorthands. |
5839
- | <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; |
5840
5984
  | <code><a href="#mise-projen.Settings.property.skills">skills</a></code> | <code><a href="#mise-projen.SettingsSkills">SettingsSkills</a></code> | *No description.* |
5841
- | <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. |
5842
5986
  | <code><a href="#mise-projen.Settings.property.sops">sops</a></code> | <code><a href="#mise-projen.SettingsSops">SettingsSops</a></code> | *No description.* |
5843
5987
  | <code><a href="#mise-projen.Settings.property.spm">spm</a></code> | <code><a href="#mise-projen.SettingsSpm">SettingsSpm</a></code> | *No description.* |
5844
5988
  | <code><a href="#mise-projen.Settings.property.status">status</a></code> | <code><a href="#mise-projen.SettingsStatus">SettingsStatus</a></code> | *No description.* |
5845
5989
  | <code><a href="#mise-projen.Settings.property.swift">swift</a></code> | <code><a href="#mise-projen.SettingsSwift">SettingsSwift</a></code> | *No description.* |
5846
- | <code><a href="#mise-projen.Settings.property.systemConfigFile">systemConfigFile</a></code> | <code>string</code> | Path to the system mise config file. |
5847
- | <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. |
5848
- | <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. |
5849
5993
  | <code><a href="#mise-projen.Settings.property.systemPackages">systemPackages</a></code> | <code><a href="#mise-projen.SettingsSystemPackages">SettingsSystemPackages</a></code> | *No description.* |
5850
- | <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. |
5851
5995
  | <code><a href="#mise-projen.Settings.property.task">task</a></code> | <code><a href="#mise-projen.SettingsTask">SettingsTask</a></code> | *No description.* |
5852
- | <code><a href="#mise-projen.Settings.property.taskDisablePaths">taskDisablePaths</a></code> | <code>string[]</code> | Paths that mise will not look for tasks in. |
5853
- | <code><a href="#mise-projen.Settings.property.taskOutput">taskOutput</a></code> | <code>string</code> | Change output style when executing tasks. |
5854
- | <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. |
5855
- | <code><a href="#mise-projen.Settings.property.taskRunAutoInstall">taskRunAutoInstall</a></code> | <code>boolean</code> | Automatically install missing tools when executing tasks. |
5856
- | <code><a href="#mise-projen.Settings.property.taskShowFullCmd">taskShowFullCmd</a></code> | <code>boolean</code> | Disable truncation of command lines in task execution output. |
5857
- | <code><a href="#mise-projen.Settings.property.taskSkip">taskSkip</a></code> | <code>string[]</code> | Tasks to skip when running `mise run`. |
5858
- | <code><a href="#mise-projen.Settings.property.taskSkipDepends">taskSkipDepends</a></code> | <code>boolean</code> | Run only specified tasks skipping all dependencies. |
5859
- | <code><a href="#mise-projen.Settings.property.taskTimeout">taskTimeout</a></code> | <code>string</code> | Default timeout for tasks. |
5860
- | <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`. |
5861
- | <code><a href="#mise-projen.Settings.property.teraV1">teraV1</a></code> | <code>boolean</code> | Use Tera v1 instead of Tera v2 for template rendering. |
5862
- | <code><a href="#mise-projen.Settings.property.terminalProgress">terminalProgress</a></code> | <code>boolean</code> | Enable terminal progress indicators (OSC 9;4) for compatible terminals. |
5863
- | <code><a href="#mise-projen.Settings.property.trace">trace</a></code> | <code>boolean</code> | Sets log level to trace. |
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. |
6007
+ | <code><a href="#mise-projen.Settings.property.toolUpdate">toolUpdate</a></code> | <code><a href="#mise-projen.SettingsToolUpdate">SettingsToolUpdate</a></code> | *No description.* |
6008
+ | <code><a href="#mise-projen.Settings.property.trace">trace</a></code> | <code>boolean</code> | Set the log level to trace. |
5864
6009
  | <code><a href="#mise-projen.Settings.property.truncate">truncate</a></code> | <code>boolean</code> | Truncate long terminal output to fit the available width. |
5865
- | <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. |
5866
- | <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. |
5867
- | <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`. |
5868
6013
  | <code><a href="#mise-projen.Settings.property.upgrade">upgrade</a></code> | <code><a href="#mise-projen.SettingsUpgrade">SettingsUpgrade</a></code> | *No description.* |
5869
- | <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. |
5870
- | <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. |
5871
- | <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. |
5872
- | <code><a href="#mise-projen.Settings.property.useVersionsHostTrack">useVersionsHostTrack</a></code> | <code>boolean</code> | Send anonymous download statistics when installing tools. |
5873
- | <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. |
5874
- | <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. |
5875
- | <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. |
5876
- | <code><a href="#mise-projen.Settings.property.windowsExecutableExtensions">windowsExecutableExtensions</a></code> | <code>string[]</code> | List of executable extensions for Windows. |
5877
- | <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. |
5878
- | <code><a href="#mise-projen.Settings.property.windowsShimMode">windowsShimMode</a></code> | <code>string</code> | Shim file mode for Windows. |
5879
- | <code><a href="#mise-projen.Settings.property.yes">yes</a></code> | <code>boolean</code> | This will automatically answer yes or no to prompts. |
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. |
6024
+ | <code><a href="#mise-projen.Settings.property.writeTargets">writeTargets</a></code> | <code><a href="#mise-projen.SettingsWriteTargets">SettingsWriteTargets</a></code> | *No description.* |
6025
+ | <code><a href="#mise-projen.Settings.property.yes">yes</a></code> | <code>boolean</code> | Answer yes to every confirmation prompt, as `--yes` does. |
5880
6026
  | <code><a href="#mise-projen.Settings.property.zig">zig</a></code> | <code><a href="#mise-projen.SettingsZig">SettingsZig</a></code> | *No description.* |
5881
6027
 
5882
6028
  ---
@@ -5889,7 +6035,7 @@ public readonly activateAggressive: boolean;
5889
6035
 
5890
6036
  - *Type:* boolean
5891
6037
 
5892
- 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`.
5893
6039
 
5894
6040
  ---
5895
6041
 
@@ -5901,7 +6047,7 @@ public readonly activateShims: boolean;
5901
6047
 
5902
6048
  - *Type:* boolean
5903
6049
 
5904
- 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.
5905
6051
 
5906
6052
  ---
5907
6053
 
@@ -5923,7 +6069,7 @@ public readonly allCompile: boolean;
5923
6069
 
5924
6070
  - *Type:* boolean
5925
6071
 
5926
- do not use precompiled binaries for any tool.
6072
+ Compile Node.js, Python, Ruby and Erlang from source instead of using precompiled builds.
5927
6073
 
5928
6074
  ---
5929
6075
 
@@ -5935,7 +6081,7 @@ public readonly alwaysKeepDownload: boolean;
5935
6081
 
5936
6082
  - *Type:* boolean
5937
6083
 
5938
- keep downloaded files after installation for debugging.
6084
+ Keep downloaded archives and sources after installing, for debugging.
5939
6085
 
5940
6086
  ---
5941
6087
 
@@ -5947,7 +6093,7 @@ public readonly alwaysKeepInstall: boolean;
5947
6093
 
5948
6094
  - *Type:* boolean
5949
6095
 
5950
- 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.
5951
6097
 
5952
6098
  ---
5953
6099
 
@@ -5969,7 +6115,7 @@ public readonly arch: string;
5969
6115
 
5970
6116
  - *Type:* string
5971
6117
 
5972
- Architecture to use for precompiled binaries.
6118
+ Architecture of the precompiled binaries mise downloads.
5973
6119
 
5974
6120
  ---
5975
6121
 
@@ -5981,7 +6127,7 @@ public readonly asdfCompat: boolean;
5981
6127
 
5982
6128
  - *Type:* boolean
5983
6129
 
5984
- set to true to ensure .tool-versions will be compatible with asdf.
6130
+ Write `.tool-versions` files that asdf can read, with exact versions.
5985
6131
 
5986
6132
  ---
5987
6133
 
@@ -6005,7 +6151,7 @@ public readonly autoInstall: boolean;
6005
6151
 
6006
6152
  - *Type:* boolean
6007
6153
 
6008
- 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.
6009
6155
 
6010
6156
  ---
6011
6157
 
@@ -6017,7 +6163,7 @@ public readonly autoInstallDisableTools: string[];
6017
6163
 
6018
6164
  - *Type:* string[]
6019
6165
 
6020
- 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`.
6021
6167
 
6022
6168
  ---
6023
6169
 
@@ -6029,7 +6175,7 @@ public readonly autoUpdate: boolean;
6029
6175
 
6030
6176
  - *Type:* boolean
6031
6177
 
6032
- Automatically update mise before running eligible commands.
6178
+ [deprecated] Old name for `self_update.auto`.
6033
6179
 
6034
6180
  ---
6035
6181
 
@@ -6041,7 +6187,7 @@ public readonly autoUpdateCheckDuration: string;
6041
6187
 
6042
6188
  - *Type:* string
6043
6189
 
6044
- How often to check for a new mise release when auto-update is enabled.
6190
+ [deprecated] Old name for `self_update.check_duration`.
6045
6191
 
6046
6192
  ---
6047
6193
 
@@ -6053,7 +6199,7 @@ public readonly cachePruneAge: string;
6053
6199
 
6054
6200
  - *Type:* string
6055
6201
 
6056
- Delete files in cache that have not been accessed in this duration.
6202
+ Delete cache files that have not been accessed for this long.
6057
6203
 
6058
6204
  ---
6059
6205
 
@@ -6075,7 +6221,7 @@ public readonly cd: string;
6075
6221
 
6076
6222
  - *Type:* string
6077
6223
 
6078
- Path to change to after launching mise.
6224
+ Directory to change to after mise starts.
6079
6225
 
6080
6226
  ---
6081
6227
 
@@ -6087,7 +6233,7 @@ public readonly ceilingPaths: string[];
6087
6233
 
6088
6234
  - *Type:* string[]
6089
6235
 
6090
- Directories where mise stops searching for config files.
6236
+ Directories where mise stops searching parent directories for config files.
6091
6237
 
6092
6238
  ---
6093
6239
 
@@ -6099,7 +6245,9 @@ public readonly ci: boolean;
6099
6245
 
6100
6246
  - *Type:* boolean
6101
6247
 
6102
- 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.
6103
6251
 
6104
6252
  ---
6105
6253
 
@@ -6111,7 +6259,7 @@ public readonly color: boolean;
6111
6259
 
6112
6260
  - *Type:* boolean
6113
6261
 
6114
- Use color in mise terminal output.
6262
+ Use color in mise's terminal output.
6115
6263
 
6116
6264
  ---
6117
6265
 
@@ -6123,7 +6271,7 @@ public readonly colorTheme: SettingsColorTheme;
6123
6271
 
6124
6272
  - *Type:* <a href="#mise-projen.SettingsColorTheme">SettingsColorTheme</a>
6125
6273
 
6126
- Theme for interactive prompts (auto/default, charm, base16, catppuccin, dracula).
6274
+ Color theme for interactive prompts, such as the task picker in `mise run`.
6127
6275
 
6128
6276
  ---
6129
6277
 
@@ -6145,7 +6293,7 @@ public readonly debug: boolean;
6145
6293
 
6146
6294
  - *Type:* boolean
6147
6295
 
6148
- Sets log level to debug.
6296
+ Set the log level to debug.
6149
6297
 
6150
6298
  ---
6151
6299
 
@@ -6157,9 +6305,7 @@ public readonly defaultConfigFilename: string;
6157
6305
 
6158
6306
  - *Type:* string
6159
6307
 
6160
- The default config filename read.
6161
-
6162
- `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.
6163
6309
 
6164
6310
  ---
6165
6311
 
@@ -6171,7 +6317,7 @@ public readonly defaultToolVersionsFilename: string;
6171
6317
 
6172
6318
  - *Type:* string
6173
6319
 
6174
- 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.
6175
6321
 
6176
6322
  ---
6177
6323
 
@@ -6183,9 +6329,7 @@ public readonly disableBackends: string[];
6183
6329
 
6184
6330
  - *Type:* string[]
6185
6331
 
6186
- Backends to exclude from tool resolution and new installs, such as `asdf`, `pypi`, or a vfox-backend plugin name.
6187
-
6188
- 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`.
6189
6333
 
6190
6334
  ---
6191
6335
 
@@ -6197,9 +6341,7 @@ public readonly disableDefaultRegistry: boolean;
6197
6341
 
6198
6342
  - *Type:* boolean
6199
6343
 
6200
- Disable the default mapping of short tool names like `php` -> `asdf:mise-plugins/asdf-php`.
6201
-
6202
- 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.
6203
6345
 
6204
6346
  ---
6205
6347
 
@@ -6211,7 +6353,9 @@ public readonly disableHints: string[];
6211
6353
 
6212
6354
  - *Type:* string[]
6213
6355
 
6214
- Turns off helpful hints when using different mise features.
6356
+ Hints to stop showing, by ID;
6357
+
6358
+ `*` turns off every hint.
6215
6359
 
6216
6360
  ---
6217
6361
 
@@ -6223,7 +6367,7 @@ public readonly disableTools: string[];
6223
6367
 
6224
6368
  - *Type:* string[]
6225
6369
 
6226
- Tools defined in mise.toml that should be ignored.
6370
+ Tools mise ignores even when a config file lists them.
6227
6371
 
6228
6372
  ---
6229
6373
 
@@ -6267,7 +6411,9 @@ public readonly enableTools: string[];
6267
6411
 
6268
6412
  - *Type:* string[]
6269
6413
 
6270
- 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.
6271
6417
 
6272
6418
  ---
6273
6419
 
@@ -6279,7 +6425,7 @@ public readonly env: string[];
6279
6425
 
6280
6426
  - *Type:* string[]
6281
6427
 
6282
- Env to use for mise.<MISE_ENV>.toml files.
6428
+ Config environments to load, such as `development` for `mise.development.toml`.
6283
6429
 
6284
6430
  ---
6285
6431
 
@@ -6291,7 +6437,7 @@ public readonly envCache: boolean;
6291
6437
 
6292
6438
  - *Type:* boolean
6293
6439
 
6294
- [experimental] Enable environment caching for nested mise invocations.
6440
+ [experimental] Cache computed environments on disk for nested mise commands.
6295
6441
 
6296
6442
  ---
6297
6443
 
@@ -6303,7 +6449,7 @@ public readonly envCacheTtl: string;
6303
6449
 
6304
6450
  - *Type:* string
6305
6451
 
6306
- TTL for cached environments.
6452
+ How long a cached environment stays valid.
6307
6453
 
6308
6454
  ---
6309
6455
 
@@ -6327,7 +6473,7 @@ public readonly envFile: string;
6327
6473
 
6328
6474
  - *Type:* string
6329
6475
 
6330
- Path to a file containing environment variables to automatically load.
6476
+ Dotenv file name to load from the current directory and each parent directory.
6331
6477
 
6332
6478
  ---
6333
6479
 
@@ -6339,7 +6485,7 @@ public readonly envShellExpand: boolean;
6339
6485
 
6340
6486
  - *Type:* boolean
6341
6487
 
6342
- 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.
6343
6489
 
6344
6490
  ---
6345
6491
 
@@ -6361,7 +6507,7 @@ public readonly execAutoInstall: boolean;
6361
6507
 
6362
6508
  - *Type:* boolean
6363
6509
 
6364
- Automatically install missing tools when running `mise x`.
6510
+ Install missing tools automatically when you run `mise exec`.
6365
6511
 
6366
6512
  ---
6367
6513
 
@@ -6373,7 +6519,7 @@ public readonly experimental: boolean;
6373
6519
 
6374
6520
  - *Type:* boolean
6375
6521
 
6376
- 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.
6377
6523
 
6378
6524
  ---
6379
6525
 
@@ -6385,7 +6531,7 @@ public readonly fetchRemoteVersionsCache: string;
6385
6531
 
6386
6532
  - *Type:* string
6387
6533
 
6388
- How long to cache remote versions for tools.
6534
+ How long a tool's cached list of available versions stays fresh.
6389
6535
 
6390
6536
  ---
6391
6537
 
@@ -6397,7 +6543,7 @@ public readonly fetchRemoteVersionsTimeout: string;
6397
6543
 
6398
6544
  - *Type:* string
6399
6545
 
6400
- Timeout in seconds for HTTP requests to fetch new tool versions in mise.
6546
+ Timeout for looking up a tool's available versions.
6401
6547
 
6402
6548
  ---
6403
6549
 
@@ -6429,7 +6575,7 @@ public readonly githubAttestations: boolean;
6429
6575
 
6430
6576
  - *Type:* boolean
6431
6577
 
6432
- Enable GitHub Artifact Attestations verification for supported tools.
6578
+ Verify GitHub artifact attestations for downloads whose publisher provides them.
6433
6579
 
6434
6580
  ---
6435
6581
 
@@ -6461,7 +6607,7 @@ public readonly gix: boolean;
6461
6607
 
6462
6608
  - *Type:* boolean
6463
6609
 
6464
- 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`.
6465
6611
 
6466
6612
  ---
6467
6613
 
@@ -6472,11 +6618,8 @@ public readonly globalConfigFile: string;
6472
6618
  ```
6473
6619
 
6474
6620
  - *Type:* string
6475
- - *Default:* config/mise/config.toml`. This must be an env var.
6476
6621
 
6477
- Path to the global mise config file.
6478
-
6479
- 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`.
6480
6623
 
6481
6624
  ---
6482
6625
 
@@ -6487,11 +6630,8 @@ public readonly globalConfigRoot: string;
6487
6630
  ```
6488
6631
 
6489
6632
  - *Type:* string
6490
- - *Default:* HOME`. This must be an env var.
6491
-
6492
- Path which is used as `{{config_root}}` for the global config file.
6493
6633
 
6494
- 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.
6495
6635
 
6496
6636
  ---
6497
6637
 
@@ -6513,7 +6653,7 @@ public readonly goDefaultPackagesFile: string;
6513
6653
 
6514
6654
  - *Type:* string
6515
6655
 
6516
- Path to a file containing default go packages to install when installing go.
6656
+ File listing Go packages to install with every Go version.
6517
6657
 
6518
6658
  ---
6519
6659
 
@@ -6525,7 +6665,7 @@ public readonly goDownloadMirror: string;
6525
6665
 
6526
6666
  - *Type:* string
6527
6667
 
6528
- Mirror to download go sdk tarballs from.
6668
+ Base URL that mise downloads Go archives and their checksums from.
6529
6669
 
6530
6670
  ---
6531
6671
 
@@ -6537,7 +6677,7 @@ public readonly goRepo: string;
6537
6677
 
6538
6678
  - *Type:* string
6539
6679
 
6540
- URL to fetch go from.
6680
+ Git repository mise lists Go versions from.
6541
6681
 
6542
6682
  ---
6543
6683
 
@@ -6549,7 +6689,7 @@ public readonly goSetGobin: boolean;
6549
6689
 
6550
6690
  - *Type:* boolean
6551
6691
 
6552
- Changes where `go install` installs binaries to.
6692
+ Set `GOBIN` so `go install` puts binaries in the active Go version's directory.
6553
6693
 
6554
6694
  ---
6555
6695
 
@@ -6561,7 +6701,7 @@ public readonly goSetGopath: boolean;
6561
6701
 
6562
6702
  - *Type:* boolean
6563
6703
 
6564
- [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.
6565
6705
 
6566
6706
  ---
6567
6707
 
@@ -6573,7 +6713,7 @@ public readonly goSetGoroot: boolean;
6573
6713
 
6574
6714
  - *Type:* boolean
6575
6715
 
6576
- Sets GOROOT=~/.local/share/mise/installs/go/.../.
6716
+ Set `GOROOT` to the active Go version's install directory.
6577
6717
 
6578
6718
  ---
6579
6719
 
@@ -6585,7 +6725,7 @@ public readonly goSkipChecksum: boolean;
6585
6725
 
6586
6726
  - *Type:* boolean
6587
6727
 
6588
- Set to true to skip checksum verification when downloading go sdk tarballs.
6728
+ Skip SHA-256 verification of Go downloads.
6589
6729
 
6590
6730
  ---
6591
6731
 
@@ -6597,9 +6737,7 @@ public readonly gpgVerify: boolean;
6597
6737
 
6598
6738
  - *Type:* boolean
6599
6739
 
6600
- Verify OpenPGP signatures for all tools (built-in, no external gpg required).
6601
-
6602
- Set to false to disable.
6740
+ Verify OpenPGP signatures of Node.js and Swift downloads.
6603
6741
 
6604
6742
  ---
6605
6743
 
@@ -6631,7 +6769,7 @@ public readonly httpDownloadTimeout: string;
6631
6769
 
6632
6770
  - *Type:* string
6633
6771
 
6634
- Total time allowed for an HTTP download, including retries.
6772
+ Total time allowed to download one file, including retries.
6635
6773
 
6636
6774
  ---
6637
6775
 
@@ -6643,7 +6781,7 @@ public readonly httpRetries: number;
6643
6781
 
6644
6782
  - *Type:* number
6645
6783
 
6646
- Number of retries for transient HTTP failures in mise.
6784
+ Number of retries after a transient HTTP failure.
6647
6785
 
6648
6786
  ---
6649
6787
 
@@ -6667,7 +6805,9 @@ public readonly idiomaticVersionFile: boolean;
6667
6805
 
6668
6806
  - *Type:* boolean
6669
6807
 
6670
- 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`.
6671
6811
 
6672
6812
  ---
6673
6813
 
@@ -6679,7 +6819,7 @@ public readonly idiomaticVersionFileDisableFiles: string[];
6679
6819
 
6680
6820
  - *Type:* string[]
6681
6821
 
6682
- Specific idiomatic version files to disable for a tool.
6822
+ Idiomatic version files to ignore for one tool, as `tool:filename` pairs.
6683
6823
 
6684
6824
  ---
6685
6825
 
@@ -6691,7 +6831,9 @@ public readonly idiomaticVersionFileDisableTools: string[];
6691
6831
 
6692
6832
  - *Type:* string[]
6693
6833
 
6694
- 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`.
6695
6837
 
6696
6838
  ---
6697
6839
 
@@ -6703,7 +6845,7 @@ public readonly idiomaticVersionFileEnableTools: string[];
6703
6845
 
6704
6846
  - *Type:* string[]
6705
6847
 
6706
- 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`.
6707
6849
 
6708
6850
  ---
6709
6851
 
@@ -6727,7 +6869,7 @@ public readonly ignoredConfigPaths: string[];
6727
6869
 
6728
6870
  - *Type:* string[]
6729
6871
 
6730
- This is a list of config paths that mise will ignore.
6872
+ Config files and directories mise does not load.
6731
6873
 
6732
6874
  ---
6733
6875
 
@@ -6739,7 +6881,21 @@ public readonly installBefore: string;
6739
6881
 
6740
6882
  - *Type:* string
6741
6883
 
6742
- 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.
6887
+
6888
+ ---
6889
+
6890
+ ##### `installLayout`<sup>Optional</sup> <a name="installLayout" id="mise-projen.Settings.property.installLayout"></a>
6891
+
6892
+ ```typescript
6893
+ public readonly installLayout: SettingsInstallLayout;
6894
+ ```
6895
+
6896
+ - *Type:* <a href="#mise-projen.SettingsInstallLayout">SettingsInstallLayout</a>
6897
+
6898
+ [experimental] Name installations by what they are (`identity`) instead of `installs/<tool>/<version>` (`legacy`).
6743
6899
 
6744
6900
  ---
6745
6901
 
@@ -6775,7 +6931,9 @@ public readonly legacyVersionFile: boolean;
6775
6931
 
6776
6932
  - *Type:* boolean
6777
6933
 
6778
- 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`.
6779
6937
 
6780
6938
  ---
6781
6939
 
@@ -6787,7 +6945,9 @@ public readonly legacyVersionFileDisableTools: string[];
6787
6945
 
6788
6946
  - *Type:* string[]
6789
6947
 
6790
- 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`.
6791
6951
 
6792
6952
  ---
6793
6953
 
@@ -6799,7 +6959,7 @@ public readonly libc: SettingsLibc;
6799
6959
 
6800
6960
  - *Type:* <a href="#mise-projen.SettingsLibc">SettingsLibc</a>
6801
6961
 
6802
- Libc implementation to use for precompiled Linux binaries.
6962
+ Libc build to install on Linux when a tool publishes both glibc and musl builds.
6803
6963
 
6804
6964
  ---
6805
6965
 
@@ -6811,7 +6971,9 @@ public readonly libgit2: boolean;
6811
6971
 
6812
6972
  - *Type:* boolean
6813
6973
 
6814
- 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`.
6815
6977
 
6816
6978
  ---
6817
6979
 
@@ -6823,7 +6985,7 @@ public readonly locked: boolean;
6823
6985
 
6824
6986
  - *Type:* boolean
6825
6987
 
6826
- Require lockfile URLs to be present during installation.
6988
+ Require tool versions and download URLs to come from the lockfile.
6827
6989
 
6828
6990
  ---
6829
6991
 
@@ -6847,7 +7009,7 @@ public readonly lockedVerifyProvenance: boolean;
6847
7009
 
6848
7010
  - *Type:* boolean
6849
7011
 
6850
- 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.
6851
7013
 
6852
7014
  ---
6853
7015
 
@@ -6859,7 +7021,19 @@ public readonly lockfile: boolean;
6859
7021
 
6860
7022
  - *Type:* boolean
6861
7023
 
6862
- Create and read lockfiles for tool versions.
7024
+ Create, read and update `mise.lock` lockfiles for tool versions.
7025
+
7026
+ ---
7027
+
7028
+ ##### `lockfileAutoPrune`<sup>Optional</sup> <a name="lockfileAutoPrune" id="mise-projen.Settings.property.lockfileAutoPrune"></a>
7029
+
7030
+ ```typescript
7031
+ public readonly lockfileAutoPrune: boolean;
7032
+ ```
7033
+
7034
+ - *Type:* boolean
7035
+
7036
+ Remove lockfile tools that are absent from the active configuration.
6863
7037
 
6864
7038
  ---
6865
7039
 
@@ -6871,7 +7045,7 @@ public readonly lockfileMode: SettingsLockfileMode;
6871
7045
 
6872
7046
  - *Type:* <a href="#mise-projen.SettingsLockfileMode">SettingsLockfileMode</a>
6873
7047
 
6874
- Choose incremental merging or complete lockfile generation.
7048
+ How lockfiles are written: entry by entry, or rebuilt from the current requests.
6875
7049
 
6876
7050
  ---
6877
7051
 
@@ -6883,7 +7057,7 @@ public readonly lockfilePlatforms: string[];
6883
7057
 
6884
7058
  - *Type:* string[]
6885
7059
 
6886
- Platforms to target in lockfile operations.
7060
+ Platforms to resolve lockfile URLs and checksums for.
6887
7061
 
6888
7062
  ---
6889
7063
 
@@ -6895,7 +7069,7 @@ public readonly logLevel: SettingsLogLevel;
6895
7069
 
6896
7070
  - *Type:* <a href="#mise-projen.SettingsLogLevel">SettingsLogLevel</a>
6897
7071
 
6898
- Show more/less output.
7072
+ Log level for mise's own output.
6899
7073
 
6900
7074
  ---
6901
7075
 
@@ -6907,7 +7081,7 @@ public readonly minimumReleaseAge: string;
6907
7081
 
6908
7082
  - *Type:* string
6909
7083
 
6910
- Minimum release age / supply chain protection — only install versions older than this threshold.
7084
+ Skip versions published more recently than this duration or date.
6911
7085
 
6912
7086
  ---
6913
7087
 
@@ -6919,7 +7093,7 @@ public readonly minimumReleaseAgeExcludes: string[];
6919
7093
 
6920
7094
  - *Type:* string[]
6921
7095
 
6922
- 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.
6923
7097
 
6924
7098
  ---
6925
7099
 
@@ -6943,7 +7117,7 @@ public readonly netrcFile: string;
6943
7117
 
6944
7118
  - *Type:* string
6945
7119
 
6946
- 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).
6947
7121
 
6948
7122
  ---
6949
7123
 
@@ -6989,7 +7163,7 @@ public readonly notFoundAutoInstall: boolean;
6989
7163
 
6990
7164
  - *Type:* boolean
6991
7165
 
6992
- 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.
6993
7167
 
6994
7168
  ---
6995
7169
 
@@ -7001,7 +7175,7 @@ public readonly notFoundAutoInstallRegistry: boolean;
7001
7175
 
7002
7176
  - *Type:* boolean
7003
7177
 
7004
- 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.
7005
7179
 
7006
7180
  ---
7007
7181
 
@@ -7013,7 +7187,7 @@ public readonly notFoundSystemFallback: boolean;
7013
7187
 
7014
7188
  - *Type:* boolean
7015
7189
 
7016
- 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.
7017
7191
 
7018
7192
  ---
7019
7193
 
@@ -7045,9 +7219,7 @@ public readonly offline: boolean;
7045
7219
 
7046
7220
  - *Type:* boolean
7047
7221
 
7048
- Disable all HTTP requests.
7049
-
7050
- Tools will only use locally cached data.
7222
+ Block every HTTP request, so mise uses only installed tools and cached data.
7051
7223
 
7052
7224
  ---
7053
7225
 
@@ -7059,7 +7231,7 @@ public readonly os: string;
7059
7231
 
7060
7232
  - *Type:* string
7061
7233
 
7062
- OS to use for precompiled binaries.
7234
+ Operating system of the precompiled binaries mise downloads.
7063
7235
 
7064
7236
  ---
7065
7237
 
@@ -7081,7 +7253,7 @@ public readonly overrideConfigFilenames: string[];
7081
7253
 
7082
7254
  - *Type:* string[]
7083
7255
 
7084
- 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.
7085
7257
 
7086
7258
  ---
7087
7259
 
@@ -7093,7 +7265,7 @@ public readonly overrideToolVersionsFilenames: string[];
7093
7265
 
7094
7266
  - *Type:* string[]
7095
7267
 
7096
- 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`.
7097
7269
 
7098
7270
  ---
7099
7271
 
@@ -7115,7 +7287,7 @@ public readonly paranoid: boolean;
7115
7287
 
7116
7288
  - *Type:* boolean
7117
7289
 
7118
- Enables extra-secure behavior.
7290
+ Require explicit, content-bound trust for project config, and re-verify provenance on every install.
7119
7291
 
7120
7292
  ---
7121
7293
 
@@ -7126,9 +7298,8 @@ public readonly pin: boolean;
7126
7298
  ```
7127
7299
 
7128
7300
  - *Type:* boolean
7129
- - *Default:* pinning versions when running `mise use` in mise.toml files.
7130
7301
 
7131
- 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.
7132
7303
 
7133
7304
  ---
7134
7305
 
@@ -7150,7 +7321,9 @@ public readonly pluginAutoupdateLastCheckDuration: string;
7150
7321
 
7151
7322
  - *Type:* string
7152
7323
 
7153
- 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.
7154
7327
 
7155
7328
  ---
7156
7329
 
@@ -7162,7 +7335,7 @@ public readonly preferOffline: boolean;
7162
7335
 
7163
7336
  - *Type:* boolean
7164
7337
 
7165
- 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.
7166
7339
 
7167
7340
  ---
7168
7341
 
@@ -7174,7 +7347,7 @@ public readonly prereleases: boolean;
7174
7347
 
7175
7348
  - *Type:* boolean
7176
7349
 
7177
- 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.
7178
7351
 
7179
7352
  ---
7180
7353
 
@@ -7186,7 +7359,9 @@ public readonly profile: string;
7186
7359
 
7187
7360
  - *Type:* string
7188
7361
 
7189
- Profile to use for mise.${MISE_PROFILE}.toml files.
7362
+ Older name for the `env` setting;
7363
+
7364
+ use `MISE_ENV` instead.
7190
7365
 
7191
7366
  ---
7192
7367
 
@@ -7198,7 +7373,17 @@ public readonly provenanceApiFailuresFatal: boolean;
7198
7373
 
7199
7374
  - *Type:* boolean
7200
7375
 
7201
- 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.
7377
+
7378
+ ---
7379
+
7380
+ ##### `prune`<sup>Optional</sup> <a name="prune" id="mise-projen.Settings.property.prune"></a>
7381
+
7382
+ ```typescript
7383
+ public readonly prune: SettingsPrune;
7384
+ ```
7385
+
7386
+ - *Type:* <a href="#mise-projen.SettingsPrune">SettingsPrune</a>
7202
7387
 
7203
7388
  ---
7204
7389
 
@@ -7230,7 +7415,9 @@ public readonly quiet: boolean;
7230
7415
 
7231
7416
  - *Type:* boolean
7232
7417
 
7233
- Suppress all output except errors.
7418
+ Hide mise's own non-error messages, such as progress and task headers;
7419
+
7420
+ same as `--quiet`.
7234
7421
 
7235
7422
  ---
7236
7423
 
@@ -7242,7 +7429,7 @@ public readonly raw: boolean;
7242
7429
 
7243
7430
  - *Type:* boolean
7244
7431
 
7245
- Connect stdin/stdout/stderr to child processes.
7432
+ Connect tasks and install commands directly to the terminal's stdin, stdout and stderr.
7246
7433
 
7247
7434
  ---
7248
7435
 
@@ -7254,7 +7441,7 @@ public readonly registryCacheTtl: string;
7254
7441
 
7255
7442
  - *Type:* string
7256
7443
 
7257
- How long to cache the floating mise registry.
7444
+ How long a downloaded mise registry stays fresh when `registry_floating` is on.
7258
7445
 
7259
7446
  ---
7260
7447
 
@@ -7266,7 +7453,7 @@ public readonly registryFloating: boolean;
7266
7453
 
7267
7454
  - *Type:* boolean
7268
7455
 
7269
- 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.
7270
7457
 
7271
7458
  ---
7272
7459
 
@@ -7298,7 +7485,7 @@ public readonly safe: boolean;
7298
7485
 
7299
7486
  - *Type:* boolean
7300
7487
 
7301
- 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.
7302
7489
 
7303
7490
  ---
7304
7491
 
@@ -7330,7 +7517,7 @@ public readonly sharedInstallDirs: string[];
7330
7517
 
7331
7518
  - *Type:* string[]
7332
7519
 
7333
- Additional read-only directories to search for installed tool versions.
7520
+ Extra read-only directories that mise searches for installed tool versions.
7334
7521
 
7335
7522
  ---
7336
7523
 
@@ -7352,7 +7539,7 @@ public readonly shimsDir: string;
7352
7539
 
7353
7540
  - *Type:* string
7354
7541
 
7355
- Directory containing user shims.
7542
+ Directory where mise writes user shims.
7356
7543
 
7357
7544
  ---
7358
7545
 
@@ -7364,7 +7551,9 @@ public readonly shorthandsFile: string;
7364
7551
 
7365
7552
  - *Type:* string
7366
7553
 
7367
- [deprecated] Path to a file containing custom tool shorthands.
7554
+ [deprecated] File of custom tool shorthands;
7555
+
7556
+ use `[plugins]` instead.
7368
7557
 
7369
7558
  ---
7370
7559
 
@@ -7376,7 +7565,9 @@ public readonly silent: boolean;
7376
7565
 
7377
7566
  - *Type:* boolean
7378
7567
 
7379
- 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`.
7380
7571
 
7381
7572
  ---
7382
7573
 
@@ -7398,7 +7589,7 @@ public readonly slsa: boolean;
7398
7589
 
7399
7590
  - *Type:* boolean
7400
7591
 
7401
- Enable SLSA provenance verification globally.
7592
+ Verify SLSA provenance of downloads whose publisher provides it.
7402
7593
 
7403
7594
  ---
7404
7595
 
@@ -7449,11 +7640,8 @@ public readonly systemConfigFile: string;
7449
7640
  ```
7450
7641
 
7451
7642
  - *Type:* string
7452
- - *Default:* etc/mise/config.toml`. This must be an env var.
7453
7643
 
7454
- Path to the system mise config file.
7455
-
7456
- 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`.
7457
7645
 
7458
7646
  ---
7459
7647
 
@@ -7465,7 +7653,7 @@ public readonly systemDeps: SettingsSystemDeps;
7465
7653
 
7466
7654
  - *Type:* <a href="#mise-projen.SettingsSystemDeps">SettingsSystemDeps</a>
7467
7655
 
7468
- 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.
7469
7657
 
7470
7658
  ---
7471
7659
 
@@ -7477,7 +7665,7 @@ public readonly systemInstallsDir: string;
7477
7665
 
7478
7666
  - *Type:* string
7479
7667
 
7480
- Directory containing system tool installs.
7668
+ Directory that `mise install --system` installs into.
7481
7669
 
7482
7670
  ---
7483
7671
 
@@ -7499,7 +7687,7 @@ public readonly systemShimsDir: string;
7499
7687
 
7500
7688
  - *Type:* string
7501
7689
 
7502
- Directory containing system shims.
7690
+ Directory where `mise reshim --system` writes shims for system installs.
7503
7691
 
7504
7692
  ---
7505
7693
 
@@ -7521,7 +7709,7 @@ public readonly taskDisablePaths: string[];
7521
7709
 
7522
7710
  - *Type:* string[]
7523
7711
 
7524
- Paths that mise will not look for tasks in.
7712
+ Deprecated alias for `task.disable_paths`.
7525
7713
 
7526
7714
  ---
7527
7715
 
@@ -7533,7 +7721,7 @@ public readonly taskOutput: string;
7533
7721
 
7534
7722
  - *Type:* string
7535
7723
 
7536
- Change output style when executing tasks.
7724
+ Deprecated alias for `task.output`.
7537
7725
 
7538
7726
  ---
7539
7727
 
@@ -7545,7 +7733,7 @@ public readonly taskRemoteNoCache: boolean;
7545
7733
 
7546
7734
  - *Type:* boolean
7547
7735
 
7548
- Mise will always fetch the latest tasks from the remote, by default the cache is used.
7736
+ Deprecated alias for `task.remote_no_cache`.
7549
7737
 
7550
7738
  ---
7551
7739
 
@@ -7557,7 +7745,7 @@ public readonly taskRunAutoInstall: boolean;
7557
7745
 
7558
7746
  - *Type:* boolean
7559
7747
 
7560
- Automatically install missing tools when executing tasks.
7748
+ Deprecated alias for `task.run_auto_install`.
7561
7749
 
7562
7750
  ---
7563
7751
 
@@ -7569,9 +7757,7 @@ public readonly taskShowFullCmd: boolean;
7569
7757
 
7570
7758
  - *Type:* boolean
7571
7759
 
7572
- Disable truncation of command lines in task execution output.
7573
-
7574
- When true, the full command line will be shown.
7760
+ Deprecated alias for `task.show_full_cmd`.
7575
7761
 
7576
7762
  ---
7577
7763
 
@@ -7583,7 +7769,7 @@ public readonly taskSkip: string[];
7583
7769
 
7584
7770
  - *Type:* string[]
7585
7771
 
7586
- Tasks to skip when running `mise run`.
7772
+ Deprecated alias for `task.skip`.
7587
7773
 
7588
7774
  ---
7589
7775
 
@@ -7595,7 +7781,7 @@ public readonly taskSkipDepends: boolean;
7595
7781
 
7596
7782
  - *Type:* boolean
7597
7783
 
7598
- Run only specified tasks skipping all dependencies.
7784
+ Deprecated alias for `task.skip_depends`.
7599
7785
 
7600
7786
  ---
7601
7787
 
@@ -7607,9 +7793,7 @@ public readonly taskTimeout: string;
7607
7793
 
7608
7794
  - *Type:* string
7609
7795
 
7610
- Default timeout for tasks.
7611
-
7612
- Can be overridden by individual tasks.
7796
+ Deprecated alias for `task.timeout`.
7613
7797
 
7614
7798
  ---
7615
7799
 
@@ -7621,9 +7805,7 @@ public readonly taskTimings: boolean;
7621
7805
 
7622
7806
  - *Type:* boolean
7623
7807
 
7624
- Show completion message with elapsed time for each task on `mise run`.
7625
-
7626
- Default shows when output type is `prefix`.
7808
+ Deprecated alias for `task.timings`.
7627
7809
 
7628
7810
  ---
7629
7811
 
@@ -7635,7 +7817,7 @@ public readonly teraV1: boolean;
7635
7817
 
7636
7818
  - *Type:* boolean
7637
7819
 
7638
- Use Tera v1 instead of Tera v2 for template rendering.
7820
+ [deprecated] Render templates with Tera v1 instead of Tera v2.
7639
7821
 
7640
7822
  ---
7641
7823
 
@@ -7647,7 +7829,17 @@ public readonly terminalProgress: boolean;
7647
7829
 
7648
7830
  - *Type:* boolean
7649
7831
 
7650
- 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.
7833
+
7834
+ ---
7835
+
7836
+ ##### `toolUpdate`<sup>Optional</sup> <a name="toolUpdate" id="mise-projen.Settings.property.toolUpdate"></a>
7837
+
7838
+ ```typescript
7839
+ public readonly toolUpdate: SettingsToolUpdate;
7840
+ ```
7841
+
7842
+ - *Type:* <a href="#mise-projen.SettingsToolUpdate">SettingsToolUpdate</a>
7651
7843
 
7652
7844
  ---
7653
7845
 
@@ -7659,7 +7851,7 @@ public readonly trace: boolean;
7659
7851
 
7660
7852
  - *Type:* boolean
7661
7853
 
7662
- Sets log level to trace.
7854
+ Set the log level to trace.
7663
7855
 
7664
7856
  ---
7665
7857
 
@@ -7683,9 +7875,7 @@ public readonly trustedConfigPaths: string[];
7683
7875
 
7684
7876
  - *Type:* string[]
7685
7877
 
7686
- This is a list of config paths that mise will automatically mark as trusted.
7687
-
7688
- 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.
7689
7879
 
7690
7880
  ---
7691
7881
 
@@ -7697,9 +7887,7 @@ public readonly unixDefaultFileShellArgs: string;
7697
7887
 
7698
7888
  - *Type:* string
7699
7889
 
7700
- Default shell arguments for Unix to be used for file commands.
7701
-
7702
- 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.
7703
7891
 
7704
7892
  ---
7705
7893
 
@@ -7711,9 +7899,7 @@ public readonly unixDefaultInlineShellArgs: string;
7711
7899
 
7712
7900
  - *Type:* string
7713
7901
 
7714
- Default shell arguments for Unix to be used for inline commands.
7715
-
7716
- 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`.
7717
7903
 
7718
7904
  ---
7719
7905
 
@@ -7735,7 +7921,7 @@ public readonly urlReplacements: {[ key: string ]: string};
7735
7921
 
7736
7922
  - *Type:* {[ key: string ]: string}
7737
7923
 
7738
- 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.
7739
7925
 
7740
7926
  ---
7741
7927
 
@@ -7747,9 +7933,7 @@ public readonly useFileShellForExecutableTasks: boolean;
7747
7933
 
7748
7934
  - *Type:* boolean
7749
7935
 
7750
- Determines whether to use a specified shell for executing tasks in the tasks directory.
7751
-
7752
- 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.
7753
7937
 
7754
7938
  ---
7755
7939
 
@@ -7761,7 +7945,7 @@ public readonly useVersionsHost: boolean;
7761
7945
 
7762
7946
  - *Type:* boolean
7763
7947
 
7764
- 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.
7765
7949
 
7766
7950
  ---
7767
7951
 
@@ -7773,7 +7957,7 @@ public readonly useVersionsHostTrack: boolean;
7773
7957
 
7774
7958
  - *Type:* boolean
7775
7959
 
7776
- Send anonymous download statistics when installing tools.
7960
+ Send anonymous download statistics to mise-versions after installing a tool.
7777
7961
 
7778
7962
  ---
7779
7963
 
@@ -7785,7 +7969,9 @@ public readonly verbose: boolean;
7785
7969
 
7786
7970
  - *Type:* boolean
7787
7971
 
7788
- 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`.
7789
7975
 
7790
7976
  ---
7791
7977
 
@@ -7797,9 +7983,7 @@ public readonly windowsDefaultFileShellArgs: string;
7797
7983
 
7798
7984
  - *Type:* string
7799
7985
 
7800
- Default shell arguments for Windows to be used for file commands.
7801
-
7802
- 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.
7803
7987
 
7804
7988
  ---
7805
7989
 
@@ -7811,9 +7995,7 @@ public readonly windowsDefaultInlineShellArgs: string;
7811
7995
 
7812
7996
  - *Type:* string
7813
7997
 
7814
- Default shell arguments for Windows to be used for inline commands.
7815
-
7816
- 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`.
7817
7999
 
7818
8000
  ---
7819
8001
 
@@ -7825,9 +8007,7 @@ public readonly windowsExecutableExtensions: string[];
7825
8007
 
7826
8008
  - *Type:* string[]
7827
8009
 
7828
- List of executable extensions for Windows.
7829
-
7830
- 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.
7831
8011
 
7832
8012
  ---
7833
8013
 
@@ -7839,21 +8019,29 @@ public readonly windowsPowershellNoProfile: boolean;
7839
8019
 
7840
8020
  - *Type:* boolean
7841
8021
 
7842
- 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.
7843
8023
 
7844
8024
  ---
7845
8025
 
7846
8026
  ##### `windowsShimMode`<sup>Optional</sup> <a name="windowsShimMode" id="mise-projen.Settings.property.windowsShimMode"></a>
7847
8027
 
7848
8028
  ```typescript
7849
- public readonly windowsShimMode: string;
8029
+ public readonly windowsShimMode: SettingsWindowsShimMode;
7850
8030
  ```
7851
8031
 
7852
- - *Type:* string
8032
+ - *Type:* <a href="#mise-projen.SettingsWindowsShimMode">SettingsWindowsShimMode</a>
8033
+
8034
+ How mise creates shims on Windows.
8035
+
8036
+ ---
8037
+
8038
+ ##### `writeTargets`<sup>Optional</sup> <a name="writeTargets" id="mise-projen.Settings.property.writeTargets"></a>
7853
8039
 
7854
- Shim file mode for Windows.
8040
+ ```typescript
8041
+ public readonly writeTargets: SettingsWriteTargets;
8042
+ ```
7855
8043
 
7856
- Options: `exe`, `file`, `hardlink`, `symlink`.
8044
+ - *Type:* <a href="#mise-projen.SettingsWriteTargets">SettingsWriteTargets</a>
7857
8045
 
7858
8046
  ---
7859
8047
 
@@ -7865,9 +8053,7 @@ public readonly yes: boolean;
7865
8053
 
7866
8054
  - *Type:* boolean
7867
8055
 
7868
- This will automatically answer yes or no to prompts.
7869
-
7870
- This is useful for scripting.
8056
+ Answer yes to every confirmation prompt, as `--yes` does.
7871
8057
 
7872
8058
  ---
7873
8059
 
@@ -7895,10 +8081,10 @@ const settingsAge: SettingsAge = { ... }
7895
8081
 
7896
8082
  | **Name** | **Type** | **Description** |
7897
8083
  | --- | --- | --- |
7898
- | <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). |
7899
- | <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. |
7900
- | <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). |
7901
- | <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. |
7902
8088
 
7903
8089
  ---
7904
8090
 
@@ -7910,7 +8096,7 @@ public readonly identityFiles: string[];
7910
8096
 
7911
8097
  - *Type:* string[]
7912
8098
 
7913
- 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.
7914
8100
 
7915
8101
  ---
7916
8102
 
@@ -7922,7 +8108,7 @@ public readonly keyFile: string;
7922
8108
 
7923
8109
  - *Type:* string
7924
8110
 
7925
- 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.
7926
8112
 
7927
8113
  ---
7928
8114
 
@@ -7934,7 +8120,7 @@ public readonly sshIdentityFiles: string[];
7934
8120
 
7935
8121
  - *Type:* string[]
7936
8122
 
7937
- 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.
7938
8124
 
7939
8125
  ---
7940
8126
 
@@ -7946,9 +8132,7 @@ public readonly strict: boolean;
7946
8132
 
7947
8133
  - *Type:* boolean
7948
8134
 
7949
- If true, fail when age decryption fails (including when age is not available, the key is missing, or the key is invalid).
7950
-
7951
- If false, skip decryption and continue in these cases.
8135
+ Fail when an `[env]` age value cannot be decrypted, instead of skipping it.
7952
8136
 
7953
8137
  ---
7954
8138
 
@@ -7966,14 +8150,14 @@ const settingsAqua: SettingsAqua = { ... }
7966
8150
 
7967
8151
  | **Name** | **Type** | **Description** |
7968
8152
  | --- | --- | --- |
7969
- | <code><a href="#mise-projen.SettingsAqua.property.bakedRegistry">bakedRegistry</a></code> | <code>boolean</code> | Use baked-in aqua registry. |
7970
- | <code><a href="#mise-projen.SettingsAqua.property.cosign">cosign</a></code> | <code>boolean</code> | Use cosign to verify aqua tool signatures. |
7971
- | <code><a href="#mise-projen.SettingsAqua.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Enable GitHub Artifact Attestations verification for aqua tools. |
7972
- | <code><a href="#mise-projen.SettingsAqua.property.minisign">minisign</a></code> | <code>boolean</code> | Use minisign to verify aqua tool signatures. |
7973
- | <code><a href="#mise-projen.SettingsAqua.property.registries">registries</a></code> | <code>string[]</code> | Aqua registry sources to load before the baked-in registry. |
7974
- | <code><a href="#mise-projen.SettingsAqua.property.registryCacheTtl">registryCacheTtl</a></code> | <code>string</code> | How long to cache downloaded aqua registry source files. |
7975
- | <code><a href="#mise-projen.SettingsAqua.property.registryUrl">registryUrl</a></code> | <code>string</code> | [deprecated] URL of an aqua registry repository to fetch. |
7976
- | <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. |
7977
8161
 
7978
8162
  ---
7979
8163
 
@@ -7985,7 +8169,7 @@ public readonly bakedRegistry: boolean;
7985
8169
 
7986
8170
  - *Type:* boolean
7987
8171
 
7988
- Use baked-in aqua registry.
8172
+ Use the aqua registry built into mise.
7989
8173
 
7990
8174
  ---
7991
8175
 
@@ -7997,7 +8181,7 @@ public readonly cosign: boolean;
7997
8181
 
7998
8182
  - *Type:* boolean
7999
8183
 
8000
- Use cosign to verify aqua tool signatures.
8184
+ Verify Cosign signatures for aqua packages that declare them.
8001
8185
 
8002
8186
  ---
8003
8187
 
@@ -8009,7 +8193,7 @@ public readonly githubAttestations: boolean;
8009
8193
 
8010
8194
  - *Type:* boolean
8011
8195
 
8012
- Enable GitHub Artifact Attestations verification for aqua tools.
8196
+ Verify GitHub artifact attestations for aqua packages that declare them.
8013
8197
 
8014
8198
  ---
8015
8199
 
@@ -8021,7 +8205,7 @@ public readonly minisign: boolean;
8021
8205
 
8022
8206
  - *Type:* boolean
8023
8207
 
8024
- Use minisign to verify aqua tool signatures.
8208
+ Verify Minisign signatures for aqua packages that declare them.
8025
8209
 
8026
8210
  ---
8027
8211
 
@@ -8033,7 +8217,7 @@ public readonly registries: string[];
8033
8217
 
8034
8218
  - *Type:* string[]
8035
8219
 
8036
- Aqua registry sources to load before the baked-in registry.
8220
+ Aqua registries to search, in order, before the baked-in registry.
8037
8221
 
8038
8222
  ---
8039
8223
 
@@ -8045,7 +8229,7 @@ public readonly registryCacheTtl: string;
8045
8229
 
8046
8230
  - *Type:* string
8047
8231
 
8048
- How long to cache downloaded aqua registry source files.
8232
+ How long a downloaded aqua registry stays fresh before mise downloads it again.
8049
8233
 
8050
8234
  ---
8051
8235
 
@@ -8057,7 +8241,7 @@ public readonly registryUrl: string;
8057
8241
 
8058
8242
  - *Type:* string
8059
8243
 
8060
- [deprecated] URL of an aqua registry repository to fetch.
8244
+ [deprecated] URL of one aqua registry repository to search before the baked-in registry.
8061
8245
 
8062
8246
  ---
8063
8247
 
@@ -8069,7 +8253,7 @@ public readonly slsa: boolean;
8069
8253
 
8070
8254
  - *Type:* boolean
8071
8255
 
8072
- Use SLSA to verify aqua tool signatures.
8256
+ Verify SLSA provenance for aqua packages that declare it.
8073
8257
 
8074
8258
  ---
8075
8259
 
@@ -8087,11 +8271,11 @@ const settingsCargo: SettingsCargo = { ... }
8087
8271
 
8088
8272
  | **Name** | **Type** | **Description** |
8089
8273
  | --- | --- | --- |
8090
- | <code><a href="#mise-projen.SettingsCargo.property.binstall">binstall</a></code> | <code>boolean</code> | Use cargo-binstall instead of cargo install if available. |
8091
- | <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. |
8092
- | <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. |
8093
- | <code><a href="#mise-projen.SettingsCargo.property.binstallQuickinstall">binstallQuickinstall</a></code> | <code>boolean</code> | Allow cargo-binstall to use third-party cargo-quickinstall artifacts. |
8094
- | <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. |
8095
8279
 
8096
8280
  ---
8097
8281
 
@@ -8103,7 +8287,7 @@ public readonly binstall: boolean;
8103
8287
 
8104
8288
  - *Type:* boolean
8105
8289
 
8106
- Use cargo-binstall instead of cargo install if available.
8290
+ Install Cargo tools from cargo-binstall's prebuilt binaries when cargo-binstall is installed.
8107
8291
 
8108
8292
  ---
8109
8293
 
@@ -8115,7 +8299,7 @@ public readonly binstallNative: boolean;
8115
8299
 
8116
8300
  - *Type:* boolean
8117
8301
 
8118
- 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.
8119
8303
 
8120
8304
  ---
8121
8305
 
@@ -8127,9 +8311,7 @@ public readonly binstallOnly: boolean;
8127
8311
 
8128
8312
  - *Type:* boolean
8129
8313
 
8130
- Require cargo-binstall for Cargo tools without an explicit Git source.
8131
-
8132
- 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`.
8133
8315
 
8134
8316
  ---
8135
8317
 
@@ -8141,7 +8323,7 @@ public readonly binstallQuickinstall: boolean;
8141
8323
 
8142
8324
  - *Type:* boolean
8143
8325
 
8144
- Allow cargo-binstall to use third-party cargo-quickinstall artifacts.
8326
+ Let cargo-binstall download third-party artifacts from cargo-quickinstall.
8145
8327
 
8146
8328
  ---
8147
8329
 
@@ -8153,7 +8335,7 @@ public readonly registryName: string;
8153
8335
 
8154
8336
  - *Type:* string
8155
8337
 
8156
- Name of the cargo registry to use.
8338
+ Cargo registry to install crates from instead of crates.io.
8157
8339
 
8158
8340
  ---
8159
8341
 
@@ -8171,7 +8353,7 @@ const settingsConda: SettingsConda = { ... }
8171
8353
 
8172
8354
  | **Name** | **Type** | **Description** |
8173
8355
  | --- | --- | --- |
8174
- | <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. |
8175
8357
 
8176
8358
  ---
8177
8359
 
@@ -8183,7 +8365,7 @@ public readonly channel: string;
8183
8365
 
8184
8366
  - *Type:* string
8185
8367
 
8186
- Default channel for conda packages.
8368
+ Channel for `conda:` tools that do not set their own.
8187
8369
 
8188
8370
  ---
8189
8371
 
@@ -8201,23 +8383,21 @@ const settingsDotfiles: SettingsDotfiles = { ... }
8201
8383
 
8202
8384
  | **Name** | **Type** | **Description** |
8203
8385
  | --- | --- | --- |
8204
- | <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`. |
8205
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. |
8206
- | <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`. |
8207
8389
 
8208
8390
  ---
8209
8391
 
8210
8392
  ##### `defaultMode`<sup>Optional</sup> <a name="defaultMode" id="mise-projen.SettingsDotfiles.property.defaultMode"></a>
8211
8393
 
8212
8394
  ```typescript
8213
- public readonly defaultMode: string;
8395
+ public readonly defaultMode: SettingsDotfilesDefaultMode;
8214
8396
  ```
8215
8397
 
8216
- - *Type:* string
8398
+ - *Type:* <a href="#mise-projen.SettingsDotfilesDefaultMode">SettingsDotfilesDefaultMode</a>
8217
8399
 
8218
- Default mode for dotfile entries when mode is omitted.
8219
-
8220
- Options: `symlink`, `symlink-each`, `copy`, `template`.
8400
+ Mode for `[dotfiles]` entries that do not set `mode`.
8221
8401
 
8222
8402
  ---
8223
8403
 
@@ -8241,7 +8421,7 @@ public readonly root: string;
8241
8421
 
8242
8422
  - *Type:* string
8243
8423
 
8244
- Root directory used for implied dotfile sources.
8424
+ Directory that holds dotfile sources for entries without a `source`.
8245
8425
 
8246
8426
  ---
8247
8427
 
@@ -8259,10 +8439,10 @@ const settingsDotnet: SettingsDotnet = { ... }
8259
8439
 
8260
8440
  | **Name** | **Type** | **Description** |
8261
8441
  | --- | --- | --- |
8262
- | <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. |
8263
- | <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. |
8264
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. |
8265
- | <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; |
8266
8446
  | <code><a href="#mise-projen.SettingsDotnet.property.registryUrl">registryUrl</a></code> | <code>string</code> | NuGet service index used to discover dotnet tool versions. |
8267
8447
 
8268
8448
  ---
@@ -8275,7 +8455,7 @@ public readonly cliTelemetryOptout: boolean;
8275
8455
 
8276
8456
  - *Type:* boolean
8277
8457
 
8278
- 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.
8279
8459
 
8280
8460
  ---
8281
8461
 
@@ -8287,7 +8467,7 @@ public readonly dotnetRoot: string;
8287
8467
 
8288
8468
  - *Type:* string
8289
8469
 
8290
- Path to the shared .NET SDK root directory.
8470
+ Shared directory that every .NET SDK version installs into.
8291
8471
 
8292
8472
  ---
8293
8473
 
@@ -8311,7 +8491,9 @@ public readonly packageFlags: string[];
8311
8491
 
8312
8492
  - *Type:* string[]
8313
8493
 
8314
- [deprecated] Extends dotnet search and install abilities.
8494
+ [deprecated] Flags for every `dotnet:` tool;
8495
+
8496
+ the only flag, `prerelease`, includes prereleases.
8315
8497
 
8316
8498
  ---
8317
8499
 
@@ -8341,8 +8523,8 @@ const settingsErlang: SettingsErlang = { ... }
8341
8523
 
8342
8524
  | **Name** | **Type** | **Description** |
8343
8525
  | --- | --- | --- |
8344
- | <code><a href="#mise-projen.SettingsErlang.property.compile">compile</a></code> | <code>boolean</code> | If true, compile erlang from source. |
8345
- | <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. |
8346
8528
 
8347
8529
  ---
8348
8530
 
@@ -8354,21 +8536,19 @@ public readonly compile: boolean;
8354
8536
 
8355
8537
  - *Type:* boolean
8356
8538
 
8357
- If true, compile erlang from source.
8358
-
8359
- If false, use precompiled binaries. If not set, use precompiled binaries if available.
8539
+ Compile Erlang from source instead of using a precompiled build.
8360
8540
 
8361
8541
  ---
8362
8542
 
8363
8543
  ##### `precompiledOs`<sup>Optional</sup> <a name="precompiledOs" id="mise-projen.SettingsErlang.property.precompiledOs"></a>
8364
8544
 
8365
8545
  ```typescript
8366
- public readonly precompiledOs: string;
8546
+ public readonly precompiledOs: SettingsErlangPrecompiledOs;
8367
8547
  ```
8368
8548
 
8369
- - *Type:* string
8549
+ - *Type:* <a href="#mise-projen.SettingsErlangPrecompiledOs">SettingsErlangPrecompiledOs</a>
8370
8550
 
8371
- 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.
8372
8552
 
8373
8553
  ---
8374
8554
 
@@ -8386,9 +8566,9 @@ const settingsForgejo: SettingsForgejo = { ... }
8386
8566
 
8387
8567
  | **Name** | **Type** | **Description** |
8388
8568
  | --- | --- | --- |
8389
- | <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. |
8390
- | <code><a href="#mise-projen.SettingsForgejo.property.fjCliTokens">fjCliTokens</a></code> | <code>boolean</code> | Read Forgejo tokens from the fj CLI config. |
8391
- | <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`. |
8392
8572
 
8393
8573
  ---
8394
8574
 
@@ -8400,7 +8580,7 @@ public readonly credentialCommand: string;
8400
8580
 
8401
8581
  - *Type:* string
8402
8582
 
8403
- Shell command to run to obtain a Forgejo token for mise.
8583
+ Command that prints a Forgejo token on stdout.
8404
8584
 
8405
8585
  ---
8406
8586
 
@@ -8412,7 +8592,7 @@ public readonly fjCliTokens: boolean;
8412
8592
 
8413
8593
  - *Type:* boolean
8414
8594
 
8415
- Read Forgejo tokens from the fj CLI config.
8595
+ Read Forgejo tokens that the fj CLI stores in its `keys.json` file.
8416
8596
 
8417
8597
  ---
8418
8598
 
@@ -8424,7 +8604,7 @@ public readonly useGitCredentials: boolean;
8424
8604
 
8425
8605
  - *Type:* boolean
8426
8606
 
8427
- Use git credential helpers to obtain Forgejo tokens.
8607
+ Get Forgejo tokens from your Git credential helpers with `git credential fill`.
8428
8608
 
8429
8609
  ---
8430
8610
 
@@ -8442,17 +8622,17 @@ const settingsGithub: SettingsGithub = { ... }
8442
8622
 
8443
8623
  | **Name** | **Type** | **Description** |
8444
8624
  | --- | --- | --- |
8445
- | <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. |
8446
- | <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. |
8447
- | <code><a href="#mise-projen.SettingsGithub.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Enable GitHub Artifact Attestations verification for github backend tools. |
8448
- | <code><a href="#mise-projen.SettingsGithub.property.oauthApiUrl">oauthApiUrl</a></code> | <code>string</code> | GitHub API base URL for native OAuth token validation. |
8449
- | <code><a href="#mise-projen.SettingsGithub.property.oauthAuthUrl">oauthAuthUrl</a></code> | <code>string</code> | GitHub OAuth endpoint base URL for native device-flow tokens. |
8450
- | <code><a href="#mise-projen.SettingsGithub.property.oauthClientId">oauthClientId</a></code> | <code>string</code> | GitHub App client ID for native OAuth device-flow tokens. |
8451
- | <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). |
8452
- | <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. |
8453
8633
  | <code><a href="#mise-projen.SettingsGithub.property.oauthScopes">oauthScopes</a></code> | <code>string</code> | OAuth scopes requested for native GitHub device-flow tokens. |
8454
- | <code><a href="#mise-projen.SettingsGithub.property.slsa">slsa</a></code> | <code>boolean</code> | Enable SLSA provenance verification for github backend tools. |
8455
- | <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`. |
8456
8636
 
8457
8637
  ---
8458
8638
 
@@ -8464,7 +8644,7 @@ public readonly credentialCommand: string;
8464
8644
 
8465
8645
  - *Type:* string
8466
8646
 
8467
- Shell command to run to obtain a GitHub token for mise.
8647
+ Command that prints a GitHub token on stdout.
8468
8648
 
8469
8649
  ---
8470
8650
 
@@ -8476,7 +8656,7 @@ public readonly ghCliTokens: boolean;
8476
8656
 
8477
8657
  - *Type:* boolean
8478
8658
 
8479
- 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.
8480
8660
 
8481
8661
  ---
8482
8662
 
@@ -8488,7 +8668,7 @@ public readonly githubAttestations: boolean;
8488
8668
 
8489
8669
  - *Type:* boolean
8490
8670
 
8491
- Enable GitHub Artifact Attestations verification for github backend tools.
8671
+ Verify GitHub artifact attestations for github backend tools.
8492
8672
 
8493
8673
  ---
8494
8674
 
@@ -8500,7 +8680,7 @@ public readonly oauthApiUrl: string;
8500
8680
 
8501
8681
  - *Type:* string
8502
8682
 
8503
- GitHub API base URL for native OAuth token validation.
8683
+ GitHub API base URL mise uses to validate native OAuth tokens.
8504
8684
 
8505
8685
  ---
8506
8686
 
@@ -8512,7 +8692,7 @@ public readonly oauthAuthUrl: string;
8512
8692
 
8513
8693
  - *Type:* string
8514
8694
 
8515
- GitHub OAuth endpoint base URL for native device-flow tokens.
8695
+ GitHub OAuth endpoint base URL for the native device flow.
8516
8696
 
8517
8697
  ---
8518
8698
 
@@ -8524,7 +8704,7 @@ public readonly oauthClientId: string;
8524
8704
 
8525
8705
  - *Type:* string
8526
8706
 
8527
- GitHub App client ID for native OAuth device-flow tokens.
8707
+ GitHub App client ID that turns on native OAuth device-flow tokens.
8528
8708
 
8529
8709
  ---
8530
8710
 
@@ -8536,7 +8716,9 @@ public readonly oauthExportEnv: string;
8536
8716
 
8537
8717
  - *Type:* string
8538
8718
 
8539
- 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.
8540
8722
 
8541
8723
  ---
8542
8724
 
@@ -8548,7 +8730,7 @@ public readonly oauthOpenBrowser: boolean;
8548
8730
 
8549
8731
  - *Type:* boolean
8550
8732
 
8551
- Open the browser during native GitHub OAuth device flow.
8733
+ Open the verification page in your browser during the native GitHub OAuth device flow.
8552
8734
 
8553
8735
  ---
8554
8736
 
@@ -8572,7 +8754,7 @@ public readonly slsa: boolean;
8572
8754
 
8573
8755
  - *Type:* boolean
8574
8756
 
8575
- Enable SLSA provenance verification for github backend tools.
8757
+ Verify SLSA provenance for github backend tools that name a signer.
8576
8758
 
8577
8759
  ---
8578
8760
 
@@ -8584,7 +8766,7 @@ public readonly useGitCredentials: boolean;
8584
8766
 
8585
8767
  - *Type:* boolean
8586
8768
 
8587
- Use git credential helpers to obtain GitHub tokens.
8769
+ Get GitHub tokens from your Git credential helpers with `git credential fill`.
8588
8770
 
8589
8771
  ---
8590
8772
 
@@ -8602,11 +8784,11 @@ const settingsGithubRelay: SettingsGithubRelay = { ... }
8602
8784
 
8603
8785
  | **Name** | **Type** | **Description** |
8604
8786
  | --- | --- | --- |
8605
- | <code><a href="#mise-projen.SettingsGithubRelay.property.concurrency">concurrency</a></code> | <code>number</code> | Maximum simultaneous GitHub relay requests (1-32); |
8606
- | <code><a href="#mise-projen.SettingsGithubRelay.property.logFormat">logFormat</a></code> | <code>string</code> | GitHub relay request and summary output format: text or jsonl. |
8607
- | <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. |
8608
- | <code><a href="#mise-projen.SettingsGithubRelay.property.maxDuration">maxDuration</a></code> | <code>string</code> | Maximum borrowed GitHub access duration; |
8609
- | <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. |
8610
8792
 
8611
8793
  ---
8612
8794
 
@@ -8618,21 +8800,21 @@ public readonly concurrency: number;
8618
8800
 
8619
8801
  - *Type:* number
8620
8802
 
8621
- Maximum simultaneous GitHub relay requests (1-32);
8803
+ Maximum relayed GitHub requests that run at once, from 1 to 32;
8622
8804
 
8623
- excess requests fail closed.
8805
+ more requests fail instead of waiting.
8624
8806
 
8625
8807
  ---
8626
8808
 
8627
8809
  ##### `logFormat`<sup>Optional</sup> <a name="logFormat" id="mise-projen.SettingsGithubRelay.property.logFormat"></a>
8628
8810
 
8629
8811
  ```typescript
8630
- public readonly logFormat: string;
8812
+ public readonly logFormat: SettingsGithubRelayLogFormat;
8631
8813
  ```
8632
8814
 
8633
- - *Type:* string
8815
+ - *Type:* <a href="#mise-projen.SettingsGithubRelayLogFormat">SettingsGithubRelayLogFormat</a>
8634
8816
 
8635
- GitHub relay request and summary output format: text or jsonl.
8817
+ Format of GitHub relay request logs and the end-of-session summary.
8636
8818
 
8637
8819
  ---
8638
8820
 
@@ -8644,7 +8826,7 @@ public readonly logRequests: boolean;
8644
8826
 
8645
8827
  - *Type:* boolean
8646
8828
 
8647
- Log sanitized GitHub relay requests on the initiating machine's stderr.
8829
+ Log each relayed GitHub request, without credentials, on this machine's stderr.
8648
8830
 
8649
8831
  ---
8650
8832
 
@@ -8656,9 +8838,9 @@ public readonly maxDuration: string;
8656
8838
 
8657
8839
  - *Type:* string
8658
8840
 
8659
- Maximum borrowed GitHub access duration;
8841
+ How long a GitHub relay lends access;
8660
8842
 
8661
- 0s means until the session ends.
8843
+ `0s` lasts until the session ends.
8662
8844
 
8663
8845
  ---
8664
8846
 
@@ -8670,7 +8852,7 @@ public readonly requestTimeout: string;
8670
8852
 
8671
8853
  - *Type:* string
8672
8854
 
8673
- Total time limit for a relayed request, including response streaming.
8855
+ Time limit for one relayed GitHub request, including streaming its response.
8674
8856
 
8675
8857
  ---
8676
8858
 
@@ -8688,9 +8870,9 @@ const settingsGitlab: SettingsGitlab = { ... }
8688
8870
 
8689
8871
  | **Name** | **Type** | **Description** |
8690
8872
  | --- | --- | --- |
8691
- | <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. |
8692
- | <code><a href="#mise-projen.SettingsGitlab.property.glabCliTokens">glabCliTokens</a></code> | <code>boolean</code> | Read GitLab tokens from the glab CLI config. |
8693
- | <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`. |
8694
8876
 
8695
8877
  ---
8696
8878
 
@@ -8702,7 +8884,7 @@ public readonly credentialCommand: string;
8702
8884
 
8703
8885
  - *Type:* string
8704
8886
 
8705
- Shell command to run to obtain a GitLab token for mise.
8887
+ Command that prints a GitLab token on stdout.
8706
8888
 
8707
8889
  ---
8708
8890
 
@@ -8714,7 +8896,7 @@ public readonly glabCliTokens: boolean;
8714
8896
 
8715
8897
  - *Type:* boolean
8716
8898
 
8717
- Read GitLab tokens from the glab CLI config.
8899
+ Read GitLab tokens that the glab CLI stores in its `config.yml` file.
8718
8900
 
8719
8901
  ---
8720
8902
 
@@ -8726,7 +8908,7 @@ public readonly useGitCredentials: boolean;
8726
8908
 
8727
8909
  - *Type:* boolean
8728
8910
 
8729
- Use git credential helpers to obtain GitLab tokens.
8911
+ Get GitLab tokens from your Git credential helpers with `git credential fill`.
8730
8912
 
8731
8913
  ---
8732
8914
 
@@ -8744,13 +8926,13 @@ const settingsGo: SettingsGo = { ... }
8744
8926
 
8745
8927
  | **Name** | **Type** | **Description** |
8746
8928
  | --- | --- | --- |
8747
- | <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. |
8748
- | <code><a href="#mise-projen.SettingsGo.property.downloadMirror">downloadMirror</a></code> | <code>string</code> | Mirror to download go sdk tarballs from. |
8749
- | <code><a href="#mise-projen.SettingsGo.property.repo">repo</a></code> | <code>string</code> | URL to fetch go from. |
8750
- | <code><a href="#mise-projen.SettingsGo.property.setGobin">setGobin</a></code> | <code>boolean</code> | Changes where `go install` installs binaries to. |
8751
- | <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. |
8752
- | <code><a href="#mise-projen.SettingsGo.property.setGoroot">setGoroot</a></code> | <code>boolean</code> | Sets GOROOT=~/.local/share/mise/installs/go/.../. |
8753
- | <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. |
8754
8936
 
8755
8937
  ---
8756
8938
 
@@ -8762,7 +8944,7 @@ public readonly defaultPackagesFile: string;
8762
8944
 
8763
8945
  - *Type:* string
8764
8946
 
8765
- 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.
8766
8948
 
8767
8949
  ---
8768
8950
 
@@ -8774,7 +8956,7 @@ public readonly downloadMirror: string;
8774
8956
 
8775
8957
  - *Type:* string
8776
8958
 
8777
- Mirror to download go sdk tarballs from.
8959
+ Base URL that mise downloads Go archives and their checksums from.
8778
8960
 
8779
8961
  ---
8780
8962
 
@@ -8786,7 +8968,7 @@ public readonly repo: string;
8786
8968
 
8787
8969
  - *Type:* string
8788
8970
 
8789
- URL to fetch go from.
8971
+ Git repository mise lists Go versions from.
8790
8972
 
8791
8973
  ---
8792
8974
 
@@ -8798,7 +8980,7 @@ public readonly setGobin: boolean;
8798
8980
 
8799
8981
  - *Type:* boolean
8800
8982
 
8801
- Changes where `go install` installs binaries to.
8983
+ Set `GOBIN` so `go install` puts binaries in the active Go version's directory.
8802
8984
 
8803
8985
  ---
8804
8986
 
@@ -8810,7 +8992,7 @@ public readonly setGopath: boolean;
8810
8992
 
8811
8993
  - *Type:* boolean
8812
8994
 
8813
- [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.
8814
8996
 
8815
8997
  ---
8816
8998
 
@@ -8822,7 +9004,7 @@ public readonly setGoroot: boolean;
8822
9004
 
8823
9005
  - *Type:* boolean
8824
9006
 
8825
- Sets GOROOT=~/.local/share/mise/installs/go/.../.
9007
+ Set `GOROOT` to the active Go version's install directory.
8826
9008
 
8827
9009
  ---
8828
9010
 
@@ -8834,7 +9016,7 @@ public readonly skipChecksum: boolean;
8834
9016
 
8835
9017
  - *Type:* boolean
8836
9018
 
8837
- Set to true to skip checksum verification when downloading go sdk tarballs.
9019
+ Skip SHA-256 verification of Go downloads.
8838
9020
 
8839
9021
  ---
8840
9022
 
@@ -8852,13 +9034,13 @@ const settingsHistory: SettingsHistory = { ... }
8852
9034
 
8853
9035
  | **Name** | **Type** | **Description** |
8854
9036
  | --- | --- | --- |
8855
- | <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. |
8856
- | <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. |
8857
- | <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. |
8858
- | <code><a href="#mise-projen.SettingsHistory.property.fetchInterval">fetchInterval</a></code> | <code>string</code> | How often the history watcher fetches the origin branch. |
8859
- | <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. |
8860
- | <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. |
8861
- | <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. |
8862
9044
  | <code><a href="#mise-projen.SettingsHistory.property.watch">watch</a></code> | <code><a href="#mise-projen.SettingsHistoryWatch">SettingsHistoryWatch</a></code> | *No description.* |
8863
9045
 
8864
9046
  ---
@@ -8871,7 +9053,7 @@ public readonly allowPlaintextHistory: boolean;
8871
9053
 
8872
9054
  - *Type:* boolean
8873
9055
 
8874
- 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.
8875
9057
 
8876
9058
  ---
8877
9059
 
@@ -8883,9 +9065,7 @@ public readonly describeCommand: string;
8883
9065
 
8884
9066
  - *Type:* string
8885
9067
 
8886
- 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.
8887
-
8888
- Empty: computed descriptions only.
9068
+ Command, such as an AI agent, that writes the description of each checkpoint the history watcher saves.
8889
9069
 
8890
9070
  ---
8891
9071
 
@@ -8897,7 +9077,7 @@ public readonly enabled: boolean;
8897
9077
 
8898
9078
  - *Type:* boolean
8899
9079
 
8900
- 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.
8901
9081
 
8902
9082
  ---
8903
9083
 
@@ -8909,9 +9089,7 @@ public readonly fetchInterval: string;
8909
9089
 
8910
9090
  - *Type:* string
8911
9091
 
8912
- How often the history watcher fetches the origin branch.
8913
-
8914
- 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.
8915
9093
 
8916
9094
  ---
8917
9095
 
@@ -8923,9 +9101,7 @@ public readonly notify: boolean;
8923
9101
 
8924
9102
  - *Type:* boolean
8925
9103
 
8926
- Show a desktop notification when conflicts pause sharing for the setup.
8927
-
8928
- 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.
8929
9105
 
8930
9106
  ---
8931
9107
 
@@ -8937,9 +9113,7 @@ public readonly sync: SettingsHistorySync;
8937
9113
 
8938
9114
  - *Type:* <a href="#mise-projen.SettingsHistorySync">SettingsHistorySync</a>
8939
9115
 
8940
- What the history watcher does with a connected setup repository on its own: `sync` publishes after saves, fetches periodically, and applies incoming changes.
8941
-
8942
- 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.
8943
9117
 
8944
9118
  ---
8945
9119
 
@@ -8951,7 +9125,7 @@ public readonly syncInterval: string;
8951
9125
 
8952
9126
  - *Type:* string
8953
9127
 
8954
- 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.
8955
9129
 
8956
9130
  ---
8957
9131
 
@@ -8979,9 +9153,9 @@ const settingsHistoryWatch: SettingsHistoryWatch = { ... }
8979
9153
 
8980
9154
  | **Name** | **Type** | **Description** |
8981
9155
  | --- | --- | --- |
8982
- | <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). |
8983
- | <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. |
8984
- | <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. |
8985
9159
 
8986
9160
  ---
8987
9161
 
@@ -8993,9 +9167,7 @@ public readonly debounce: string;
8993
9167
 
8994
9168
  - *Type:* string
8995
9169
 
8996
- How long a changed file must stay quiet before the history watcher saves it (the base autosave interval).
8997
-
8998
- 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.
8999
9171
 
9000
9172
  ---
9001
9173
 
@@ -9007,9 +9179,7 @@ public readonly maxInterval: string;
9007
9179
 
9008
9180
  - *Type:* string
9009
9181
 
9010
- The longest autosave interval the history watcher stretches a constantly changing file to.
9011
-
9012
- 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.
9013
9183
 
9014
9184
  ---
9015
9185
 
@@ -9021,9 +9191,7 @@ public readonly reconcile: string;
9021
9191
 
9022
9192
  - *Type:* string
9023
9193
 
9024
- How often the history watcher rescans the whole tracked set for changes its watches missed.
9025
-
9026
- `0` disables periodic reconciliation (startup and configuration changes still reconcile).
9194
+ How often the history watcher rescans all tracked files for changes it missed.
9027
9195
 
9028
9196
  ---
9029
9197
 
@@ -9041,8 +9209,8 @@ const settingsHookEnv: SettingsHookEnv = { ... }
9041
9209
 
9042
9210
  | **Name** | **Type** | **Description** |
9043
9211
  | --- | --- | --- |
9044
- | <code><a href="#mise-projen.SettingsHookEnv.property.cacheTtl">cacheTtl</a></code> | <code>string</code> | Cache hook-env directory checks for this duration. |
9045
- | <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. |
9046
9214
 
9047
9215
  ---
9048
9216
 
@@ -9054,9 +9222,7 @@ public readonly cacheTtl: string;
9054
9222
 
9055
9223
  - *Type:* string
9056
9224
 
9057
- Cache hook-env directory checks for this duration.
9058
-
9059
- Useful for slow filesystems like NFS.
9225
+ How long the shell hook reuses its last config file check, for slow filesystems such as NFS.
9060
9226
 
9061
9227
  ---
9062
9228
 
@@ -9068,7 +9234,7 @@ public readonly chpwdOnly: boolean;
9068
9234
 
9069
9235
  - *Type:* boolean
9070
9236
 
9071
- 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.
9072
9238
 
9073
9239
  ---
9074
9240
 
@@ -9086,7 +9252,7 @@ const settingsJava: SettingsJava = { ... }
9086
9252
 
9087
9253
  | **Name** | **Type** | **Description** |
9088
9254
  | --- | --- | --- |
9089
- | <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`. |
9090
9256
 
9091
9257
  ---
9092
9258
 
@@ -9098,9 +9264,7 @@ public readonly shorthandVendor: string;
9098
9264
 
9099
9265
  - *Type:* string
9100
9266
 
9101
- Shorthand for Java.
9102
-
9103
- Used when installing Java without a vendor prefix.
9267
+ Vendor used for a Java version without a vendor prefix, such as `java@21`.
9104
9268
 
9105
9269
  ---
9106
9270
 
@@ -9118,24 +9282,24 @@ const settingsNode: SettingsNode = { ... }
9118
9282
 
9119
9283
  | **Name** | **Type** | **Description** |
9120
9284
  | --- | --- | --- |
9121
- | <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. |
9122
- | <code><a href="#mise-projen.SettingsNode.property.cflags">cflags</a></code> | <code>string</code> | Additional CFLAGS options (e.g., to override -O3). |
9123
- | <code><a href="#mise-projen.SettingsNode.property.compile">compile</a></code> | <code>boolean</code> | Compile node from source. |
9124
- | <code><a href="#mise-projen.SettingsNode.property.concurrency">concurrency</a></code> | <code>number</code> | How many jobs should be used in compilation. |
9125
- | <code><a href="#mise-projen.SettingsNode.property.configureOpts">configureOpts</a></code> | <code>string</code> | Additional ./configure options. |
9126
- | <code><a href="#mise-projen.SettingsNode.property.corepack">corepack</a></code> | <code>boolean</code> | Installs the default corepack shims after installing any node version. |
9127
- | <code><a href="#mise-projen.SettingsNode.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> | Path to a file containing default npm packages to install. |
9128
- | <code><a href="#mise-projen.SettingsNode.property.flavor">flavor</a></code> | <code>string</code> | Install a specific node flavor like glibc-217 or musl. |
9129
- | <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). |
9130
- | <code><a href="#mise-projen.SettingsNode.property.make">make</a></code> | <code>string</code> | Make command to use. |
9131
- | <code><a href="#mise-projen.SettingsNode.property.makeInstallOpts">makeInstallOpts</a></code> | <code>string</code> | Additional make install options. |
9132
- | <code><a href="#mise-projen.SettingsNode.property.makeOpts">makeOpts</a></code> | <code>string</code> | Additional make options. |
9133
- | <code><a href="#mise-projen.SettingsNode.property.mirrorUrl">mirrorUrl</a></code> | <code>string</code> | Mirror to download node tarballs from. |
9134
- | <code><a href="#mise-projen.SettingsNode.property.ninja">ninja</a></code> | <code>boolean</code> | Use ninja instead of make to compile node. |
9135
- | <code><a href="#mise-projen.SettingsNode.property.nodenvRoot">nodenvRoot</a></code> | <code>string</code> | Directory for nodenv. |
9136
- | <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`. |
9137
- | <code><a href="#mise-projen.SettingsNode.property.nvmDir">nvmDir</a></code> | <code>string</code> | Directory for nvm. |
9138
- | <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`. |
9139
9303
 
9140
9304
  ---
9141
9305
 
@@ -9147,7 +9311,7 @@ public readonly applyPatches: string;
9147
9311
 
9148
9312
  - *Type:* string
9149
9313
 
9150
- 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.
9151
9315
 
9152
9316
  ---
9153
9317
 
@@ -9159,7 +9323,7 @@ public readonly cflags: string;
9159
9323
 
9160
9324
  - *Type:* string
9161
9325
 
9162
- Additional CFLAGS options (e.g., to override -O3).
9326
+ Extra `CFLAGS` for compiling Node.js, for example to replace `-O3`.
9163
9327
 
9164
9328
  ---
9165
9329
 
@@ -9171,7 +9335,7 @@ public readonly compile: boolean;
9171
9335
 
9172
9336
  - *Type:* boolean
9173
9337
 
9174
- Compile node from source.
9338
+ Compile Node.js from source instead of using a precompiled build.
9175
9339
 
9176
9340
  ---
9177
9341
 
@@ -9183,7 +9347,7 @@ public readonly concurrency: number;
9183
9347
 
9184
9348
  - *Type:* number
9185
9349
 
9186
- How many jobs should be used in compilation.
9350
+ Number of parallel jobs (`make -j`) when compiling Node.js.
9187
9351
 
9188
9352
  ---
9189
9353
 
@@ -9195,7 +9359,7 @@ public readonly configureOpts: string;
9195
9359
 
9196
9360
  - *Type:* string
9197
9361
 
9198
- Additional ./configure options.
9362
+ Extra arguments for `./configure` when compiling Node.js.
9199
9363
 
9200
9364
  ---
9201
9365
 
@@ -9207,7 +9371,7 @@ public readonly corepack: boolean;
9207
9371
 
9208
9372
  - *Type:* boolean
9209
9373
 
9210
- 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.
9211
9375
 
9212
9376
  ---
9213
9377
 
@@ -9219,7 +9383,7 @@ public readonly defaultPackagesFile: string;
9219
9383
 
9220
9384
  - *Type:* string
9221
9385
 
9222
- 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.
9223
9387
 
9224
9388
  ---
9225
9389
 
@@ -9231,9 +9395,7 @@ public readonly flavor: string;
9231
9395
 
9232
9396
  - *Type:* string
9233
9397
 
9234
- Install a specific node flavor like glibc-217 or musl.
9235
-
9236
- Use with unofficial node build repo.
9398
+ Linux build flavor of Node.js to download, such as `musl` or `glibc-217`.
9237
9399
 
9238
9400
  ---
9239
9401
 
@@ -9245,9 +9407,7 @@ public readonly gpgVerify: boolean;
9245
9407
 
9246
9408
  - *Type:* boolean
9247
9409
 
9248
- Verify OpenPGP signatures for node (built-in, no external gpg required).
9249
-
9250
- Set to false to disable.
9410
+ Check the OpenPGP signature of the `SHASUMS256.txt` file that `node.verify` checks downloads against.
9251
9411
 
9252
9412
  ---
9253
9413
 
@@ -9259,7 +9419,7 @@ public readonly make: string;
9259
9419
 
9260
9420
  - *Type:* string
9261
9421
 
9262
- Make command to use.
9422
+ Command to run instead of `make` when compiling Node.js, such as `gmake`.
9263
9423
 
9264
9424
  ---
9265
9425
 
@@ -9271,7 +9431,7 @@ public readonly makeInstallOpts: string;
9271
9431
 
9272
9432
  - *Type:* string
9273
9433
 
9274
- Additional make install options.
9434
+ Extra arguments for `make install` when compiling Node.js.
9275
9435
 
9276
9436
  ---
9277
9437
 
@@ -9283,7 +9443,7 @@ public readonly makeOpts: string;
9283
9443
 
9284
9444
  - *Type:* string
9285
9445
 
9286
- Additional make options.
9446
+ Extra arguments for `make` when compiling Node.js.
9287
9447
 
9288
9448
  ---
9289
9449
 
@@ -9295,7 +9455,7 @@ public readonly mirrorUrl: string;
9295
9455
 
9296
9456
  - *Type:* string
9297
9457
 
9298
- Mirror to download node tarballs from.
9458
+ Base URL that mise downloads Node.js archives and their `SHASUMS256.txt` checksums from.
9299
9459
 
9300
9460
  ---
9301
9461
 
@@ -9307,7 +9467,7 @@ public readonly ninja: boolean;
9307
9467
 
9308
9468
  - *Type:* boolean
9309
9469
 
9310
- Use ninja instead of make to compile node.
9470
+ Build Node.js with ninja instead of make when compiling from source.
9311
9471
 
9312
9472
  ---
9313
9473
 
@@ -9319,7 +9479,7 @@ public readonly nodenvRoot: string;
9319
9479
 
9320
9480
  - *Type:* string
9321
9481
 
9322
- Directory for nodenv.
9482
+ Root directory of nodenv, which `mise sync node --nodenv` imports Node.js versions from.
9323
9483
 
9324
9484
  ---
9325
9485
 
@@ -9331,9 +9491,7 @@ public readonly npmShim: boolean;
9331
9491
 
9332
9492
  - *Type:* boolean
9333
9493
 
9334
- Install a bash wrapper at bin/npm that triggers `mise reshim` after `npm install -g`.
9335
-
9336
- 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.
9337
9495
 
9338
9496
  ---
9339
9497
 
@@ -9345,7 +9503,7 @@ public readonly nvmDir: string;
9345
9503
 
9346
9504
  - *Type:* string
9347
9505
 
9348
- Directory for nvm.
9506
+ Directory of nvm, which `mise sync node --nvm` imports Node.js versions from.
9349
9507
 
9350
9508
  ---
9351
9509
 
@@ -9357,7 +9515,7 @@ public readonly verify: boolean;
9357
9515
 
9358
9516
  - *Type:* boolean
9359
9517
 
9360
- Verify the downloaded assets using GPG.
9518
+ Verify downloaded Node.js archives against the SHA-256 checksums in `SHASUMS256.txt`.
9361
9519
 
9362
9520
  ---
9363
9521
 
@@ -9375,9 +9533,9 @@ const settingsNpm: SettingsNpm = { ... }
9375
9533
 
9376
9534
  | **Name** | **Type** | **Description** |
9377
9535
  | --- | --- | --- |
9378
- | <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. |
9379
- | <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. |
9380
- | <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. |
9381
9539
 
9382
9540
  ---
9383
9541
 
@@ -9389,7 +9547,9 @@ public readonly bun: boolean;
9389
9547
 
9390
9548
  - *Type:* boolean
9391
9549
 
9392
- 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"`.
9393
9553
 
9394
9554
  ---
9395
9555
 
@@ -9401,7 +9561,7 @@ public readonly packageManager: SettingsNpmPackageManager;
9401
9561
 
9402
9562
  - *Type:* <a href="#mise-projen.SettingsNpmPackageManager">SettingsNpmPackageManager</a>
9403
9563
 
9404
- Package manager to use for installing npm packages.
9564
+ Package manager that installs `npm:` tools.
9405
9565
 
9406
9566
  ---
9407
9567
 
@@ -9413,7 +9573,7 @@ public readonly shellOut: boolean;
9413
9573
 
9414
9574
  - *Type:* boolean
9415
9575
 
9416
- 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.
9417
9577
 
9418
9578
  ---
9419
9579
 
@@ -9431,9 +9591,9 @@ const settingsOci: SettingsOci = { ... }
9431
9591
 
9432
9592
  | **Name** | **Type** | **Description** |
9433
9593
  | --- | --- | --- |
9434
- | <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. |
9435
- | <code><a href="#mise-projen.SettingsOci.property.defaultMountPoint">defaultMountPoint</a></code> | <code>string</code> | Path inside OCI images where mise tools are installed. |
9436
- | <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. |
9437
9597
 
9438
9598
  ---
9439
9599
 
@@ -9445,7 +9605,7 @@ public readonly defaultFrom: string;
9445
9605
 
9446
9606
  - *Type:* string
9447
9607
 
9448
- 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.
9449
9609
 
9450
9610
  ---
9451
9611
 
@@ -9457,7 +9617,7 @@ public readonly defaultMountPoint: string;
9457
9617
 
9458
9618
  - *Type:* string
9459
9619
 
9460
- 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.
9461
9621
 
9462
9622
  ---
9463
9623
 
@@ -9469,7 +9629,7 @@ public readonly insecureRegistries: string[];
9469
9629
 
9470
9630
  - *Type:* string[]
9471
9631
 
9472
- 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.
9473
9633
 
9474
9634
  ---
9475
9635
 
@@ -9487,8 +9647,8 @@ const settingsOtel: SettingsOtel = { ... }
9487
9647
 
9488
9648
  | **Name** | **Type** | **Description** |
9489
9649
  | --- | --- | --- |
9490
- | <code><a href="#mise-projen.SettingsOtel.property.enabled">enabled</a></code> | <code>boolean</code> | [experimental] Enable OpenTelemetry trace export for task executions. |
9491
- | <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. |
9492
9652
 
9493
9653
  ---
9494
9654
 
@@ -9500,7 +9660,7 @@ public readonly enabled: boolean;
9500
9660
 
9501
9661
  - *Type:* boolean
9502
9662
 
9503
- [experimental] Enable OpenTelemetry trace export for task executions.
9663
+ [experimental] Export OpenTelemetry traces of `mise run`.
9504
9664
 
9505
9665
  ---
9506
9666
 
@@ -9512,7 +9672,7 @@ public readonly logs: boolean;
9512
9672
 
9513
9673
  - *Type:* boolean
9514
9674
 
9515
- [experimental] Enable OpenTelemetry log export for task stdout/stderr.
9675
+ [experimental] Export each line of task stdout and stderr as an OpenTelemetry log record.
9516
9676
 
9517
9677
  ---
9518
9678
 
@@ -9530,8 +9690,8 @@ const settingsPackslip: SettingsPackslip = { ... }
9530
9690
 
9531
9691
  | **Name** | **Type** | **Description** |
9532
9692
  | --- | --- | --- |
9533
- | <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. |
9534
- | <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`. |
9535
9695
 
9536
9696
  ---
9537
9697
 
@@ -9543,7 +9703,7 @@ public readonly exec: boolean;
9543
9703
 
9544
9704
  - *Type:* boolean
9545
9705
 
9546
- 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.
9547
9707
 
9548
9708
  ---
9549
9709
 
@@ -9555,7 +9715,7 @@ public readonly stampers: string[];
9555
9715
 
9556
9716
  - *Type:* string[]
9557
9717
 
9558
- 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`.
9559
9719
 
9560
9720
  ---
9561
9721
 
@@ -9573,8 +9733,8 @@ const settingsPipx: SettingsPipx = { ... }
9573
9733
 
9574
9734
  | **Name** | **Type** | **Description** |
9575
9735
  | --- | --- | --- |
9576
- | <code><a href="#mise-projen.SettingsPipx.property.registryUrl">registryUrl</a></code> | <code>string</code> | URL to use for pipx registry. |
9577
- | <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`. |
9578
9738
 
9579
9739
  ---
9580
9740
 
@@ -9586,7 +9746,7 @@ public readonly registryUrl: string;
9586
9746
 
9587
9747
  - *Type:* string
9588
9748
 
9589
- URL to use for pipx registry.
9749
+ Older name for `pypi.registry_url`.
9590
9750
 
9591
9751
  ---
9592
9752
 
@@ -9598,7 +9758,37 @@ public readonly uvx: boolean;
9598
9758
 
9599
9759
  - *Type:* boolean
9600
9760
 
9601
- Use uvx instead of pipx if uv is installed and on PATH.
9761
+ Older name for `pypi.uvx`.
9762
+
9763
+ ---
9764
+
9765
+ ### SettingsPrune <a name="SettingsPrune" id="mise-projen.SettingsPrune"></a>
9766
+
9767
+ #### Initializer <a name="Initializer" id="mise-projen.SettingsPrune.Initializer"></a>
9768
+
9769
+ ```typescript
9770
+ import { SettingsPrune } from 'mise-projen'
9771
+
9772
+ const settingsPrune: SettingsPrune = { ... }
9773
+ ```
9774
+
9775
+ #### Properties <a name="Properties" id="Properties"></a>
9776
+
9777
+ | **Name** | **Type** | **Description** |
9778
+ | --- | --- | --- |
9779
+ | <code><a href="#mise-projen.SettingsPrune.property.exclude">exclude</a></code> | <code>string[]</code> | Tools that `mise prune` never removes, such as `node` or `aqua:BurntSushi/ripgrep`. |
9780
+
9781
+ ---
9782
+
9783
+ ##### `exclude`<sup>Optional</sup> <a name="exclude" id="mise-projen.SettingsPrune.property.exclude"></a>
9784
+
9785
+ ```typescript
9786
+ public readonly exclude: string[];
9787
+ ```
9788
+
9789
+ - *Type:* string[]
9790
+
9791
+ Tools that `mise prune` never removes, such as `node` or `aqua:BurntSushi/ripgrep`.
9602
9792
 
9603
9793
  ---
9604
9794
 
@@ -9616,8 +9806,8 @@ const settingsPypi: SettingsPypi = { ... }
9616
9806
 
9617
9807
  | **Name** | **Type** | **Description** |
9618
9808
  | --- | --- | --- |
9619
- | <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). |
9620
- | <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. |
9621
9811
 
9622
9812
  ---
9623
9813
 
@@ -9629,7 +9819,7 @@ public readonly registryUrl: string;
9629
9819
 
9630
9820
  - *Type:* string
9631
9821
 
9632
- 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.
9633
9823
 
9634
9824
  ---
9635
9825
 
@@ -9641,7 +9831,7 @@ public readonly uvx: boolean;
9641
9831
 
9642
9832
  - *Type:* boolean
9643
9833
 
9644
- 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.
9645
9835
 
9646
9836
  ---
9647
9837
 
@@ -9659,19 +9849,19 @@ const settingsPython: SettingsPython = { ... }
9659
9849
 
9660
9850
  | **Name** | **Type** | **Description** |
9661
9851
  | --- | --- | --- |
9662
- | <code><a href="#mise-projen.SettingsPython.property.compile">compile</a></code> | <code>boolean</code> | If true, compile python from source. |
9663
- | <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. |
9664
- | <code><a href="#mise-projen.SettingsPython.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Enable GitHub Artifact Attestations verification for precompiled Python binaries. |
9665
- | <code><a href="#mise-projen.SettingsPython.property.patchesDirectory">patchesDirectory</a></code> | <code>string</code> | Directory to fetch python patches from. |
9666
- | <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. |
9667
- | <code><a href="#mise-projen.SettingsPython.property.precompiledArch">precompiledArch</a></code> | <code>string</code> | Specify the architecture to use for precompiled binaries. |
9668
- | <code><a href="#mise-projen.SettingsPython.property.precompiledFlavor">precompiledFlavor</a></code> | <code>string</code> | Specify the flavor to use for precompiled binaries. |
9669
- | <code><a href="#mise-projen.SettingsPython.property.precompiledOs">precompiledOs</a></code> | <code>string</code> | Specify the OS to use for precompiled binaries. |
9670
- | <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. |
9671
- | <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. |
9672
- | <code><a href="#mise-projen.SettingsPython.property.uvVenvCreateArgs">uvVenvCreateArgs</a></code> | <code>string[]</code> | Arguments to pass to uv when creating a venv. |
9673
- | <code><a href="#mise-projen.SettingsPython.property.venvCreateArgs">venvCreateArgs</a></code> | <code>string[]</code> | Arguments to pass to python when creating a venv. |
9674
- | <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. |
9675
9865
 
9676
9866
  ---
9677
9867
 
@@ -9683,9 +9873,7 @@ public readonly compile: boolean;
9683
9873
 
9684
9874
  - *Type:* boolean
9685
9875
 
9686
- If true, compile python from source.
9687
-
9688
- 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.
9689
9877
 
9690
9878
  ---
9691
9879
 
@@ -9697,7 +9885,7 @@ public readonly defaultPackagesFile: string;
9697
9885
 
9698
9886
  - *Type:* string
9699
9887
 
9700
- 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.
9701
9889
 
9702
9890
  ---
9703
9891
 
@@ -9709,7 +9897,7 @@ public readonly githubAttestations: boolean;
9709
9897
 
9710
9898
  - *Type:* boolean
9711
9899
 
9712
- Enable GitHub Artifact Attestations verification for precompiled Python binaries.
9900
+ Verify GitHub artifact attestations of precompiled Python builds from python-build-standalone.
9713
9901
 
9714
9902
  ---
9715
9903
 
@@ -9721,7 +9909,7 @@ public readonly patchesDirectory: string;
9721
9909
 
9722
9910
  - *Type:* string
9723
9911
 
9724
- Directory to fetch python patches from.
9912
+ Directory of per-version patches for the Python versions that python-build compiles.
9725
9913
 
9726
9914
  ---
9727
9915
 
@@ -9733,7 +9921,7 @@ public readonly patchUrl: string;
9733
9921
 
9734
9922
  - *Type:* string
9735
9923
 
9736
- 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.
9737
9925
 
9738
9926
  ---
9739
9927
 
@@ -9745,7 +9933,7 @@ public readonly precompiledArch: string;
9745
9933
 
9746
9934
  - *Type:* string
9747
9935
 
9748
- 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`.
9749
9937
 
9750
9938
  ---
9751
9939
 
@@ -9757,7 +9945,7 @@ public readonly precompiledFlavor: string;
9757
9945
 
9758
9946
  - *Type:* string
9759
9947
 
9760
- 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`.
9761
9949
 
9762
9950
  ---
9763
9951
 
@@ -9769,7 +9957,7 @@ public readonly precompiledOs: string;
9769
9957
 
9770
9958
  - *Type:* string
9771
9959
 
9772
- 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`.
9773
9961
 
9774
9962
  ---
9775
9963
 
@@ -9781,7 +9969,7 @@ public readonly pyenvRepo: string;
9781
9969
 
9782
9970
  - *Type:* string
9783
9971
 
9784
- URL to fetch pyenv from for compiling python with python-build.
9972
+ Git repository that mise clones pyenv from to get python-build.
9785
9973
 
9786
9974
  ---
9787
9975
 
@@ -9793,7 +9981,7 @@ public readonly uvVenvAuto: SettingsPythonUvVenvAuto;
9793
9981
 
9794
9982
  - *Type:* <a href="#mise-projen.SettingsPythonUvVenvAuto">SettingsPythonUvVenvAuto</a>
9795
9983
 
9796
- 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.
9797
9985
 
9798
9986
  ---
9799
9987
 
@@ -9805,7 +9993,7 @@ public readonly uvVenvCreateArgs: string[];
9805
9993
 
9806
9994
  - *Type:* string[]
9807
9995
 
9808
- Arguments to pass to uv when creating a venv.
9996
+ Arguments for `uv venv` when mise creates a virtualenv with uv.
9809
9997
 
9810
9998
  ---
9811
9999
 
@@ -9817,9 +10005,7 @@ public readonly venvCreateArgs: string[];
9817
10005
 
9818
10006
  - *Type:* string[]
9819
10007
 
9820
- Arguments to pass to python when creating a venv.
9821
-
9822
- (not used for uv venv creation)
10008
+ Arguments for `python -m venv` when `_.python.venv` creates a virtualenv without uv.
9823
10009
 
9824
10010
  ---
9825
10011
 
@@ -9831,7 +10017,7 @@ public readonly venvStdlib: boolean;
9831
10017
 
9832
10018
  - *Type:* boolean
9833
10019
 
9834
- Prefer to use venv from Python's standard library.
10020
+ Create `_.python.venv` virtualenvs with `python -m venv` even when uv is installed.
9835
10021
 
9836
10022
  ---
9837
10023
 
@@ -9849,20 +10035,20 @@ const settingsRuby: SettingsRuby = { ... }
9849
10035
 
9850
10036
  | **Name** | **Type** | **Description** |
9851
10037
  | --- | --- | --- |
9852
- | <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. |
9853
- | <code><a href="#mise-projen.SettingsRuby.property.compile">compile</a></code> | <code>boolean</code> | If true, compile ruby from source. |
9854
- | <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. |
9855
- | <code><a href="#mise-projen.SettingsRuby.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Enable GitHub Artifact Attestations verification for precompiled Ruby binaries. |
9856
- | <code><a href="#mise-projen.SettingsRuby.property.precompiledArch">precompiledArch</a></code> | <code>string</code> | Override architecture identifier for precompiled Ruby binaries. |
9857
- | <code><a href="#mise-projen.SettingsRuby.property.precompiledOs">precompiledOs</a></code> | <code>string</code> | Override OS identifier for precompiled Ruby binaries. |
9858
- | <code><a href="#mise-projen.SettingsRuby.property.precompiledUrl">precompiledUrl</a></code> | <code>string</code> | URL template or GitHub repo for precompiled Ruby binaries. |
9859
- | <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. |
9860
- | <code><a href="#mise-projen.SettingsRuby.property.rubyBuildOpts">rubyBuildOpts</a></code> | <code>string</code> | Configure arguments passed through ruby-build after `--`. |
9861
- | <code><a href="#mise-projen.SettingsRuby.property.rubyBuildRepo">rubyBuildRepo</a></code> | <code>string</code> | The URL used to fetch ruby-build. |
9862
- | <code><a href="#mise-projen.SettingsRuby.property.rubyInstall">rubyInstall</a></code> | <code>boolean</code> | Use ruby-install instead of ruby-build. |
9863
- | <code><a href="#mise-projen.SettingsRuby.property.rubyInstallOpts">rubyInstallOpts</a></code> | <code>string</code> | Options to pass to ruby-install. |
9864
- | <code><a href="#mise-projen.SettingsRuby.property.rubyInstallRepo">rubyInstallRepo</a></code> | <code>string</code> | The URL used to fetch ruby-install. |
9865
- | <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. |
9866
10052
 
9867
10053
  ---
9868
10054
 
@@ -9874,7 +10060,7 @@ public readonly applyPatches: string;
9874
10060
 
9875
10061
  - *Type:* string
9876
10062
 
9877
- 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.
9878
10064
 
9879
10065
  ---
9880
10066
 
@@ -9886,9 +10072,7 @@ public readonly compile: boolean;
9886
10072
 
9887
10073
  - *Type:* boolean
9888
10074
 
9889
- If true, compile ruby from source.
9890
-
9891
- If false, require precompiled binaries. If not set, use precompiled binaries if available.
10075
+ Compile Ruby from source instead of using a precompiled build.
9892
10076
 
9893
10077
  ---
9894
10078
 
@@ -9900,7 +10084,7 @@ public readonly defaultPackagesFile: string;
9900
10084
 
9901
10085
  - *Type:* string
9902
10086
 
9903
- 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.
9904
10088
 
9905
10089
  ---
9906
10090
 
@@ -9912,7 +10096,7 @@ public readonly githubAttestations: boolean;
9912
10096
 
9913
10097
  - *Type:* boolean
9914
10098
 
9915
- Enable GitHub Artifact Attestations verification for precompiled Ruby binaries.
10099
+ Verify GitHub artifact attestations of precompiled Ruby builds.
9916
10100
 
9917
10101
  ---
9918
10102
 
@@ -9924,7 +10108,7 @@ public readonly precompiledArch: string;
9924
10108
 
9925
10109
  - *Type:* string
9926
10110
 
9927
- 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`.
9928
10112
 
9929
10113
  ---
9930
10114
 
@@ -9936,7 +10120,7 @@ public readonly precompiledOs: string;
9936
10120
 
9937
10121
  - *Type:* string
9938
10122
 
9939
- Override OS identifier for precompiled Ruby binaries.
10123
+ OS name of precompiled Ruby builds, such as `linux`, used with `ruby.precompiled_arch`.
9940
10124
 
9941
10125
  ---
9942
10126
 
@@ -9948,7 +10132,7 @@ public readonly precompiledUrl: string;
9948
10132
 
9949
10133
  - *Type:* string
9950
10134
 
9951
- 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.
9952
10136
 
9953
10137
  ---
9954
10138
 
@@ -9960,7 +10144,7 @@ public readonly rubyBuildCliOpts: string;
9960
10144
 
9961
10145
  - *Type:* string
9962
10146
 
9963
- 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.
9964
10148
 
9965
10149
  ---
9966
10150
 
@@ -9972,7 +10156,7 @@ public readonly rubyBuildOpts: string;
9972
10156
 
9973
10157
  - *Type:* string
9974
10158
 
9975
- Configure arguments passed through ruby-build after `--`.
10159
+ Arguments for Ruby's `configure`, such as `--enable-yjit`, passed through ruby-build.
9976
10160
 
9977
10161
  ---
9978
10162
 
@@ -9984,9 +10168,7 @@ public readonly rubyBuildRepo: string;
9984
10168
 
9985
10169
  - *Type:* string
9986
10170
 
9987
- The URL used to fetch ruby-build.
9988
-
9989
- This accepts either a Git repository or a ZIP archive.
10171
+ Git repository or ZIP archive URL that mise gets ruby-build from.
9990
10172
 
9991
10173
  ---
9992
10174
 
@@ -9998,7 +10180,7 @@ public readonly rubyInstall: boolean;
9998
10180
 
9999
10181
  - *Type:* boolean
10000
10182
 
10001
- Use ruby-install instead of ruby-build.
10183
+ Compile Ruby with ruby-install instead of ruby-build.
10002
10184
 
10003
10185
  ---
10004
10186
 
@@ -10010,7 +10192,7 @@ public readonly rubyInstallOpts: string;
10010
10192
 
10011
10193
  - *Type:* string
10012
10194
 
10013
- Options to pass to ruby-install.
10195
+ Arguments for Ruby's `configure`, passed through ruby-install.
10014
10196
 
10015
10197
  ---
10016
10198
 
@@ -10022,9 +10204,7 @@ public readonly rubyInstallRepo: string;
10022
10204
 
10023
10205
  - *Type:* string
10024
10206
 
10025
- The URL used to fetch ruby-install.
10026
-
10027
- This accepts either a Git repository or a ZIP archive.
10207
+ Git repository or ZIP archive URL that mise gets ruby-install from.
10028
10208
 
10029
10209
  ---
10030
10210
 
@@ -10036,7 +10216,7 @@ public readonly verboseInstall: boolean;
10036
10216
 
10037
10217
  - *Type:* boolean
10038
10218
 
10039
- Set to true to enable verbose output during ruby installation.
10219
+ Show ruby-build's full output while compiling Ruby.
10040
10220
 
10041
10221
  ---
10042
10222
 
@@ -10054,9 +10234,9 @@ const settingsRust: SettingsRust = { ... }
10054
10234
 
10055
10235
  | **Name** | **Type** | **Description** |
10056
10236
  | --- | --- | --- |
10057
- | <code><a href="#mise-projen.SettingsRust.property.cargoHome">cargoHome</a></code> | <code>string</code> | Path to the cargo home directory. |
10058
- | <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`. |
10059
- | <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. |
10060
10240
 
10061
10241
  ---
10062
10242
 
@@ -10067,11 +10247,8 @@ public readonly cargoHome: string;
10067
10247
  ```
10068
10248
 
10069
10249
  - *Type:* string
10070
- - *Default:* cargo` or `%USERPROFILE%\.cargo`
10071
-
10072
- Path to the cargo home directory.
10073
10250
 
10074
- Defaults to `~/.cargo` or `%USERPROFILE%\.cargo`
10251
+ Directory used as `CARGO_HOME` for the Rust toolchains that mise manages.
10075
10252
 
10076
10253
  ---
10077
10254
 
@@ -10083,7 +10260,7 @@ public readonly defaultHost: string;
10083
10260
 
10084
10261
  - *Type:* string
10085
10262
 
10086
- Default host triple to pass to `rustup init` via `--default-host`.
10263
+ Host triple that mise passes to `rustup init` as `--default-host`.
10087
10264
 
10088
10265
  ---
10089
10266
 
@@ -10094,11 +10271,8 @@ public readonly rustupHome: string;
10094
10271
  ```
10095
10272
 
10096
10273
  - *Type:* string
10097
- - *Default:* rustup` or `%USERPROFILE%\.rustup`
10098
10274
 
10099
- Path to the rustup home directory.
10100
-
10101
- Defaults to `~/.rustup` or `%USERPROFILE%\.rustup`
10275
+ Directory used as `RUSTUP_HOME` for the Rust toolchains that mise manages.
10102
10276
 
10103
10277
  ---
10104
10278
 
@@ -10116,7 +10290,7 @@ const settingsSandbox: SettingsSandbox = { ... }
10116
10290
 
10117
10291
  | **Name** | **Type** | **Description** |
10118
10292
  | --- | --- | --- |
10119
- | <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`. |
10120
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`. |
10121
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`. |
10122
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`. |
@@ -10132,7 +10306,7 @@ public readonly denyAll: boolean;
10132
10306
 
10133
10307
  - *Type:* boolean
10134
10308
 
10135
- 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`.
10136
10310
 
10137
10311
  ---
10138
10312
 
@@ -10198,9 +10372,11 @@ const settingsSelfUpdate: SettingsSelfUpdate = { ... }
10198
10372
 
10199
10373
  | **Name** | **Type** | **Description** |
10200
10374
  | --- | --- | --- |
10201
- | <code><a href="#mise-projen.SettingsSelfUpdate.property.apiUrl">apiUrl</a></code> | <code>string</code> | GitHub API base URL used by `mise self-update`. |
10202
- | <code><a href="#mise-projen.SettingsSelfUpdate.property.minimumReleaseAge">minimumReleaseAge</a></code> | <code>string</code> | Minimum release age for mise itself; |
10203
- | <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. |
10204
10380
 
10205
10381
  ---
10206
10382
 
@@ -10212,7 +10388,31 @@ public readonly apiUrl: string;
10212
10388
 
10213
10389
  - *Type:* string
10214
10390
 
10215
- GitHub API base URL used by `mise self-update`.
10391
+ GitHub API base URL that `mise self-update` gets mise releases from.
10392
+
10393
+ ---
10394
+
10395
+ ##### `auto`<sup>Optional</sup> <a name="auto" id="mise-projen.SettingsSelfUpdate.property.auto"></a>
10396
+
10397
+ ```typescript
10398
+ public readonly auto: boolean;
10399
+ ```
10400
+
10401
+ - *Type:* boolean
10402
+
10403
+ Update mise automatically before running eligible commands.
10404
+
10405
+ ---
10406
+
10407
+ ##### `checkDuration`<sup>Optional</sup> <a name="checkDuration" id="mise-projen.SettingsSelfUpdate.property.checkDuration"></a>
10408
+
10409
+ ```typescript
10410
+ public readonly checkDuration: string;
10411
+ ```
10412
+
10413
+ - *Type:* string
10414
+
10415
+ How often automatic updates check for a new mise release when `self_update.auto` is on.
10216
10416
 
10217
10417
  ---
10218
10418
 
@@ -10224,9 +10424,7 @@ public readonly minimumReleaseAge: string;
10224
10424
 
10225
10425
  - *Type:* string
10226
10426
 
10227
- Minimum release age for mise itself;
10228
-
10229
- inherits minimum_release_age (24h by default).
10427
+ Skip mise releases published more recently than this, for `mise self-update` and automatic updates.
10230
10428
 
10231
10429
  ---
10232
10430
 
@@ -10238,7 +10436,7 @@ public readonly repository: string;
10238
10436
 
10239
10437
  - *Type:* string
10240
10438
 
10241
- GitHub repository used by `mise self-update`.
10439
+ GitHub repository, as `owner/repo`, that mise gets its own releases from.
10242
10440
 
10243
10441
  ---
10244
10442
 
@@ -10256,7 +10454,7 @@ const settingsShims: SettingsShims = { ... }
10256
10454
 
10257
10455
  | **Name** | **Type** | **Description** |
10258
10456
  | --- | --- | --- |
10259
- | <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`. |
10260
10458
 
10261
10459
  ---
10262
10460
 
@@ -10268,7 +10466,7 @@ public readonly exclude: string[];
10268
10466
 
10269
10467
  - *Type:* string[]
10270
10468
 
10271
- 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`.
10272
10470
 
10273
10471
  ---
10274
10472
 
@@ -10289,7 +10487,7 @@ const settingsSkills: SettingsSkills = { ... }
10289
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`. |
10290
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`. |
10291
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. |
10292
- | <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`. |
10293
10491
 
10294
10492
  ---
10295
10493
 
@@ -10337,7 +10535,7 @@ public readonly prune: boolean;
10337
10535
 
10338
10536
  - *Type:* boolean
10339
10537
 
10340
- 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`.
10341
10539
 
10342
10540
  ---
10343
10541
 
@@ -10355,11 +10553,11 @@ const settingsSops: SettingsSops = { ... }
10355
10553
 
10356
10554
  | **Name** | **Type** | **Description** |
10357
10555
  | --- | --- | --- |
10358
- | <code><a href="#mise-projen.SettingsSops.property.ageKey">ageKey</a></code> | <code>string</code> | The age private key to use for sops secret decryption. |
10359
- | <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. |
10360
- | <code><a href="#mise-projen.SettingsSops.property.ageRecipients">ageRecipients</a></code> | <code>string</code> | The age public keys to use for sops secret encryption. |
10361
- | <code><a href="#mise-projen.SettingsSops.property.rops">rops</a></code> | <code>boolean</code> | Use rops to decrypt sops files. |
10362
- | <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. |
10363
10561
 
10364
10562
  ---
10365
10563
 
@@ -10371,9 +10569,7 @@ public readonly ageKey: string;
10371
10569
 
10372
10570
  - *Type:* string
10373
10571
 
10374
- The age private key to use for sops secret decryption.
10375
-
10376
- Takes precedence over standard SOPS_AGE_KEY environment variable.
10572
+ Private age key for decrypting SOPS files, used before any other key source.
10377
10573
 
10378
10574
  ---
10379
10575
 
@@ -10385,9 +10581,7 @@ public readonly ageKeyFile: string;
10385
10581
 
10386
10582
  - *Type:* string
10387
10583
 
10388
- Path to the age private key file for sops secret decryption.
10389
-
10390
- 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`.
10391
10585
 
10392
10586
  ---
10393
10587
 
@@ -10399,7 +10593,9 @@ public readonly ageRecipients: string;
10399
10593
 
10400
10594
  - *Type:* string
10401
10595
 
10402
- The age public keys to use for sops secret encryption.
10596
+ [deprecated] Has no effect;
10597
+
10598
+ mise does not encrypt sops files.
10403
10599
 
10404
10600
  ---
10405
10601
 
@@ -10411,9 +10607,7 @@ public readonly rops: boolean;
10411
10607
 
10412
10608
  - *Type:* boolean
10413
10609
 
10414
- Use rops to decrypt sops files.
10415
-
10416
- 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.
10417
10611
 
10418
10612
  ---
10419
10613
 
@@ -10425,9 +10619,7 @@ public readonly strict: boolean;
10425
10619
 
10426
10620
  - *Type:* boolean
10427
10621
 
10428
- If true, fail when sops decryption fails (including when sops is not available, the key is missing, or the key is invalid).
10429
-
10430
- If false, skip decryption and continue in these cases.
10622
+ Fail when a SOPS file cannot be decrypted, instead of skipping it.
10431
10623
 
10432
10624
  ---
10433
10625
 
@@ -10445,7 +10637,7 @@ const settingsSpm: SettingsSpm = { ... }
10445
10637
 
10446
10638
  | **Name** | **Type** | **Description** |
10447
10639
  | --- | --- | --- |
10448
- | <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. |
10449
10641
 
10450
10642
  ---
10451
10643
 
@@ -10457,7 +10649,7 @@ public readonly artifactbundleOnly: boolean;
10457
10649
 
10458
10650
  - *Type:* boolean
10459
10651
 
10460
- 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.
10461
10653
 
10462
10654
  ---
10463
10655
 
@@ -10475,23 +10667,23 @@ const settingsStatus: SettingsStatus = { ... }
10475
10667
 
10476
10668
  | **Name** | **Type** | **Description** |
10477
10669
  | --- | --- | --- |
10478
- | <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. |
10479
- | <code><a href="#mise-projen.SettingsStatus.property.showDepsStale">showDepsStale</a></code> | <code>boolean</code> | Show warning when deps providers have stale dependencies. |
10480
- | <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. |
10481
- | <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. |
10482
- | <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. |
10483
10675
 
10484
10676
  ---
10485
10677
 
10486
10678
  ##### `missingTools`<sup>Optional</sup> <a name="missingTools" id="mise-projen.SettingsStatus.property.missingTools"></a>
10487
10679
 
10488
10680
  ```typescript
10489
- public readonly missingTools: string;
10681
+ public readonly missingTools: SettingsStatusMissingTools;
10490
10682
  ```
10491
10683
 
10492
- - *Type:* string
10684
+ - *Type:* <a href="#mise-projen.SettingsStatusMissingTools">SettingsStatusMissingTools</a>
10493
10685
 
10494
- 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.
10495
10687
 
10496
10688
  ---
10497
10689
 
@@ -10503,7 +10695,7 @@ public readonly showDepsStale: boolean;
10503
10695
 
10504
10696
  - *Type:* boolean
10505
10697
 
10506
- 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.
10507
10699
 
10508
10700
  ---
10509
10701
 
@@ -10515,7 +10707,7 @@ public readonly showEnv: boolean;
10515
10707
 
10516
10708
  - *Type:* boolean
10517
10709
 
10518
- 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.
10519
10711
 
10520
10712
  ---
10521
10713
 
@@ -10527,7 +10719,7 @@ public readonly showTools: boolean;
10527
10719
 
10528
10720
  - *Type:* boolean
10529
10721
 
10530
- 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.
10531
10723
 
10532
10724
  ---
10533
10725
 
@@ -10539,7 +10731,7 @@ public readonly truncate: boolean;
10539
10731
 
10540
10732
  - *Type:* boolean
10541
10733
 
10542
- Truncate status messages.
10734
+ Cut the lines from `status.show_env` and `status.show_tools` to the terminal width.
10543
10735
 
10544
10736
  ---
10545
10737
 
@@ -10557,8 +10749,8 @@ const settingsSwift: SettingsSwift = { ... }
10557
10749
 
10558
10750
  | **Name** | **Type** | **Description** |
10559
10751
  | --- | --- | --- |
10560
- | <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). |
10561
- | <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`. |
10562
10754
 
10563
10755
  ---
10564
10756
 
@@ -10570,9 +10762,7 @@ public readonly gpgVerify: boolean;
10570
10762
 
10571
10763
  - *Type:* boolean
10572
10764
 
10573
- Verify OpenPGP signatures for swift (built-in, no external gpg required).
10574
-
10575
- Set to false to disable.
10765
+ Verify the OpenPGP signature of Swift downloads on Linux.
10576
10766
 
10577
10767
  ---
10578
10768
 
@@ -10584,9 +10774,7 @@ public readonly platform: string;
10584
10774
 
10585
10775
  - *Type:* string
10586
10776
 
10587
- Override the distro build to use for precompiled binaries.
10588
-
10589
- 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`.
10590
10778
 
10591
10779
  ---
10592
10780
 
@@ -10604,8 +10792,8 @@ const settingsSystemPackages: SettingsSystemPackages = { ... }
10604
10792
 
10605
10793
  | **Name** | **Type** | **Description** |
10606
10794
  | --- | --- | --- |
10607
- | <code><a href="#mise-projen.SettingsSystemPackages.property.managers">managers</a></code> | <code>string[]</code> | Restrict which system package managers mise will use. |
10608
- | <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`. |
10609
10797
 
10610
10798
  ---
10611
10799
 
@@ -10617,7 +10805,7 @@ public readonly managers: string[];
10617
10805
 
10618
10806
  - *Type:* string[]
10619
10807
 
10620
- Restrict which system package managers mise will use.
10808
+ Package managers that mise may use for `[bootstrap.packages]` and missing plugin dependencies.
10621
10809
 
10622
10810
  ---
10623
10811
 
@@ -10629,7 +10817,7 @@ public readonly sudo: boolean;
10629
10817
 
10630
10818
  - *Type:* boolean
10631
10819
 
10632
- 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`.
10633
10821
 
10634
10822
  ---
10635
10823
 
@@ -10647,33 +10835,33 @@ const settingsTask: SettingsTask = { ... }
10647
10835
 
10648
10836
  | **Name** | **Type** | **Description** |
10649
10837
  | --- | --- | --- |
10650
- | <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`. |
10651
10839
  | <code><a href="#mise-projen.SettingsTask.property.cache">cache</a></code> | <code><a href="#mise-projen.SettingsTaskCache">SettingsTaskCache</a></code> | *No description.* |
10652
- | <code><a href="#mise-projen.SettingsTask.property.cacheDir">cacheDir</a></code> | <code>string</code> | [experimental] Directory for task output cache artifacts. |
10653
- | <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. |
10654
- | <code><a href="#mise-projen.SettingsTask.property.cacheMaxSize">cacheMaxSize</a></code> | <code>string</code> | [experimental] Maximum total size of task output cache entries. |
10655
- | <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. |
10656
- | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteNamespace">cacheRemoteNamespace</a></code> | <code>string</code> | Compatibility alias for task.cache.remote_namespace. |
10657
- | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteOidcAudience">cacheRemoteOidcAudience</a></code> | <code>string</code> | Compatibility alias for task.cache.remote_oidc_audience. |
10658
- | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteToken">cacheRemoteToken</a></code> | <code>string</code> | Compatibility alias for task.cache.remote_token. |
10659
- | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteTokenFile">cacheRemoteTokenFile</a></code> | <code>string</code> | Compatibility alias for task.cache.remote_token_file. |
10660
- | <code><a href="#mise-projen.SettingsTask.property.cacheRemoteUrl">cacheRemoteUrl</a></code> | <code>string</code> | Compatibility alias for task.cache.remote_url. |
10661
- | <code><a href="#mise-projen.SettingsTask.property.disablePaths">disablePaths</a></code> | <code>string[]</code> | Paths that mise will not look for tasks in. |
10662
- | <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). |
10663
- | <code><a href="#mise-projen.SettingsTask.property.monorepoDepth">monorepoDepth</a></code> | <code>number</code> | Maximum depth to search for task files in monorepo subdirectories. |
10664
- | <code><a href="#mise-projen.SettingsTask.property.monorepoExcludeDirs">monorepoExcludeDirs</a></code> | <code>string[]</code> | Directory patterns to exclude when discovering monorepo subdirectories. |
10665
- | <code><a href="#mise-projen.SettingsTask.property.monorepoRespectGitignore">monorepoRespectGitignore</a></code> | <code>boolean</code> | Whether to respect .gitignore files when discovering monorepo subdirectories. |
10666
- | <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. |
10667
- | <code><a href="#mise-projen.SettingsTask.property.quiet">quiet</a></code> | <code>boolean</code> | Suppress mise's own output while executing tasks. |
10668
- | <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. |
10669
- | <code><a href="#mise-projen.SettingsTask.property.runAutoInstall">runAutoInstall</a></code> | <code>boolean</code> | Automatically install missing tools when executing tasks. |
10670
- | <code><a href="#mise-projen.SettingsTask.property.showFullCmd">showFullCmd</a></code> | <code>boolean</code> | Disable truncation of command lines in task execution output. |
10671
- | <code><a href="#mise-projen.SettingsTask.property.skip">skip</a></code> | <code>string[]</code> | Tasks to skip when running `mise run`. |
10672
- | <code><a href="#mise-projen.SettingsTask.property.skipDepends">skipDepends</a></code> | <code>boolean</code> | Run only specified tasks skipping all dependencies. |
10673
- | <code><a href="#mise-projen.SettingsTask.property.sourceFreshnessEqualMtimeIsFresh">sourceFreshnessEqualMtimeIsFresh</a></code> | <code>boolean</code> | When source mtime equals output mtime, consider sources fresh (use <=). |
10674
- | <code><a href="#mise-projen.SettingsTask.property.sourceFreshnessHashContents">sourceFreshnessHashContents</a></code> | <code>boolean</code> | Use content hashing (blake3) instead of metadata for source freshness. |
10675
- | <code><a href="#mise-projen.SettingsTask.property.timeout">timeout</a></code> | <code>string</code> | Default timeout for tasks. |
10676
- | <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. |
10677
10865
 
10678
10866
  ---
10679
10867
 
@@ -10685,7 +10873,7 @@ public readonly autoInfer: string[];
10685
10873
 
10686
10874
  - *Type:* string[]
10687
10875
 
10688
- [experimental] Workspace providers from which to automatically infer tasks.
10876
+ [experimental] Workspace providers whose package scripts mise imports as tasks, such as `node`.
10689
10877
 
10690
10878
  ---
10691
10879
 
@@ -10707,7 +10895,7 @@ public readonly cacheDir: string;
10707
10895
 
10708
10896
  - *Type:* string
10709
10897
 
10710
- [experimental] Directory for task output cache artifacts.
10898
+ [experimental] Directory for the task artifact cache.
10711
10899
 
10712
10900
  ---
10713
10901
 
@@ -10719,7 +10907,7 @@ public readonly cacheMaxAge: string;
10719
10907
 
10720
10908
  - *Type:* string
10721
10909
 
10722
- [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.
10723
10911
 
10724
10912
  ---
10725
10913
 
@@ -10731,7 +10919,7 @@ public readonly cacheMaxSize: string;
10731
10919
 
10732
10920
  - *Type:* string
10733
10921
 
10734
- [experimental] Maximum total size of task output cache entries.
10922
+ [experimental] Maximum total size of the task artifact cache, such as `500MB` or `2GiB`.
10735
10923
 
10736
10924
  ---
10737
10925
 
@@ -10743,7 +10931,7 @@ public readonly cacheRemoteMode: SettingsTaskCacheRemoteMode;
10743
10931
 
10744
10932
  - *Type:* <a href="#mise-projen.SettingsTaskCacheRemoteMode">SettingsTaskCacheRemoteMode</a>
10745
10933
 
10746
- Compatibility alias for task.cache.remote_mode.
10934
+ Deprecated alias for `task.cache.remote_mode`.
10747
10935
 
10748
10936
  ---
10749
10937
 
@@ -10755,7 +10943,7 @@ public readonly cacheRemoteNamespace: string;
10755
10943
 
10756
10944
  - *Type:* string
10757
10945
 
10758
- Compatibility alias for task.cache.remote_namespace.
10946
+ Deprecated alias for `task.cache.remote_namespace`.
10759
10947
 
10760
10948
  ---
10761
10949
 
@@ -10767,7 +10955,7 @@ public readonly cacheRemoteOidcAudience: string;
10767
10955
 
10768
10956
  - *Type:* string
10769
10957
 
10770
- Compatibility alias for task.cache.remote_oidc_audience.
10958
+ Deprecated alias for `task.cache.remote_oidc_audience`.
10771
10959
 
10772
10960
  ---
10773
10961
 
@@ -10779,7 +10967,7 @@ public readonly cacheRemoteToken: string;
10779
10967
 
10780
10968
  - *Type:* string
10781
10969
 
10782
- Compatibility alias for task.cache.remote_token.
10970
+ Deprecated alias for `task.cache.remote_token`.
10783
10971
 
10784
10972
  ---
10785
10973
 
@@ -10791,7 +10979,7 @@ public readonly cacheRemoteTokenFile: string;
10791
10979
 
10792
10980
  - *Type:* string
10793
10981
 
10794
- Compatibility alias for task.cache.remote_token_file.
10982
+ Deprecated alias for `task.cache.remote_token_file`.
10795
10983
 
10796
10984
  ---
10797
10985
 
@@ -10803,7 +10991,7 @@ public readonly cacheRemoteUrl: string;
10803
10991
 
10804
10992
  - *Type:* string
10805
10993
 
10806
- Compatibility alias for task.cache.remote_url.
10994
+ Deprecated alias for `task.cache.remote_url`.
10807
10995
 
10808
10996
  ---
10809
10997
 
@@ -10815,7 +11003,7 @@ public readonly disablePaths: string[];
10815
11003
 
10816
11004
  - *Type:* string[]
10817
11005
 
10818
- Paths that mise will not look for tasks in.
11006
+ Paths that mise does not look for tasks in.
10819
11007
 
10820
11008
  ---
10821
11009
 
@@ -10827,9 +11015,7 @@ public readonly disableSpecFromRunScripts: boolean;
10827
11015
 
10828
11016
  - *Type:* boolean
10829
11017
 
10830
- Opt out of parsing task run scripts to infer the usage spec (arguments and flags).
10831
-
10832
- 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.
10833
11019
 
10834
11020
  ---
10835
11021
 
@@ -10841,7 +11027,7 @@ public readonly monorepoDepth: number;
10841
11027
 
10842
11028
  - *Type:* number
10843
11029
 
10844
- Maximum depth to search for task files in monorepo subdirectories.
11030
+ Maximum directory depth for automatic monorepo discovery, which is deprecated.
10845
11031
 
10846
11032
  ---
10847
11033
 
@@ -10853,7 +11039,7 @@ public readonly monorepoExcludeDirs: string[];
10853
11039
 
10854
11040
  - *Type:* string[]
10855
11041
 
10856
- Directory patterns to exclude when discovering monorepo subdirectories.
11042
+ Directory names that automatic monorepo discovery skips.
10857
11043
 
10858
11044
  ---
10859
11045
 
@@ -10865,7 +11051,7 @@ public readonly monorepoRespectGitignore: boolean;
10865
11051
 
10866
11052
  - *Type:* boolean
10867
11053
 
10868
- Whether to respect .gitignore files when discovering monorepo subdirectories.
11054
+ Skip directories that `.gitignore` files ignore during automatic monorepo discovery.
10869
11055
 
10870
11056
  ---
10871
11057
 
@@ -10877,7 +11063,7 @@ public readonly output: SettingsTaskOutput;
10877
11063
 
10878
11064
  - *Type:* <a href="#mise-projen.SettingsTaskOutput">SettingsTaskOutput</a>
10879
11065
 
10880
- Change output style when executing tasks.
11066
+ Default output style for `mise run`.
10881
11067
 
10882
11068
  ---
10883
11069
 
@@ -10889,7 +11075,7 @@ public readonly quiet: boolean;
10889
11075
 
10890
11076
  - *Type:* boolean
10891
11077
 
10892
- Suppress mise's own output while executing tasks.
11078
+ Hide mise's own messages while tasks run, without changing other mise commands.
10893
11079
 
10894
11080
  ---
10895
11081
 
@@ -10901,7 +11087,7 @@ public readonly remoteNoCache: boolean;
10901
11087
 
10902
11088
  - *Type:* boolean
10903
11089
 
10904
- 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.
10905
11091
 
10906
11092
  ---
10907
11093
 
@@ -10913,7 +11099,7 @@ public readonly runAutoInstall: boolean;
10913
11099
 
10914
11100
  - *Type:* boolean
10915
11101
 
10916
- Automatically install missing tools when executing tasks.
11102
+ Install missing tools automatically before tasks run.
10917
11103
 
10918
11104
  ---
10919
11105
 
@@ -10925,9 +11111,7 @@ public readonly showFullCmd: boolean;
10925
11111
 
10926
11112
  - *Type:* boolean
10927
11113
 
10928
- Disable truncation of command lines in task execution output.
10929
-
10930
- 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.
10931
11115
 
10932
11116
  ---
10933
11117
 
@@ -10939,7 +11123,7 @@ public readonly skip: string[];
10939
11123
 
10940
11124
  - *Type:* string[]
10941
11125
 
10942
- Tasks to skip when running `mise run`.
11126
+ Names of tasks that `mise run` skips.
10943
11127
 
10944
11128
  ---
10945
11129
 
@@ -10951,7 +11135,9 @@ public readonly skipDepends: boolean;
10951
11135
 
10952
11136
  - *Type:* boolean
10953
11137
 
10954
- 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`.
10955
11141
 
10956
11142
  ---
10957
11143
 
@@ -10963,9 +11149,7 @@ public readonly sourceFreshnessEqualMtimeIsFresh: boolean;
10963
11149
 
10964
11150
  - *Type:* boolean
10965
11151
 
10966
- When source mtime equals output mtime, consider sources fresh (use <=).
10967
-
10968
- 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.
10969
11153
 
10970
11154
  ---
10971
11155
 
@@ -10977,9 +11161,7 @@ public readonly sourceFreshnessHashContents: boolean;
10977
11161
 
10978
11162
  - *Type:* boolean
10979
11163
 
10980
- Use content hashing (blake3) instead of metadata for source freshness.
10981
-
10982
- More accurate but slower.
11164
+ Decide whether a task's sources changed by hashing their contents instead of comparing modification times.
10983
11165
 
10984
11166
  ---
10985
11167
 
@@ -10991,7 +11173,7 @@ public readonly timeout: string;
10991
11173
 
10992
11174
  - *Type:* string
10993
11175
 
10994
- Default timeout for tasks.
11176
+ Time limit for a whole `mise run` invocation, across every task it runs.
10995
11177
 
10996
11178
  ---
10997
11179
 
@@ -11003,9 +11185,7 @@ public readonly timings: boolean;
11003
11185
 
11004
11186
  - *Type:* boolean
11005
11187
 
11006
- Show completion message with elapsed time for each task on `mise run`.
11007
-
11008
- Default shows when output type is `prefix`.
11188
+ Print each task's elapsed time when it finishes.
11009
11189
 
11010
11190
  ---
11011
11191
 
@@ -11023,14 +11203,14 @@ const settingsTaskCache: SettingsTaskCache = { ... }
11023
11203
 
11024
11204
  | **Name** | **Type** | **Description** |
11025
11205
  | --- | --- | --- |
11026
- | <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. |
11027
- | <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. |
11028
- | <code><a href="#mise-projen.SettingsTaskCache.property.remoteNamespace">remoteNamespace</a></code> | <code>string</code> | [experimental] Namespace sent to the remote build cache. |
11029
- | <code><a href="#mise-projen.SettingsTaskCache.property.remoteOidcAudience">remoteOidcAudience</a></code> | <code>string</code> | [experimental] Audience for an automatically acquired remote cache OIDC token. |
11030
- | <code><a href="#mise-projen.SettingsTaskCache.property.remoteToken">remoteToken</a></code> | <code>string</code> | [experimental] Bearer token for remote build-cache authentication. |
11031
- | <code><a href="#mise-projen.SettingsTaskCache.property.remoteTokenFile">remoteTokenFile</a></code> | <code>string</code> | [experimental] File containing a remote build-cache bearer token. |
11032
- | <code><a href="#mise-projen.SettingsTaskCache.property.remoteUrl">remoteUrl</a></code> | <code>string</code> | [experimental] Base URL for the remote build-cache service. |
11033
- | <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. |
11034
11214
 
11035
11215
  ---
11036
11216
 
@@ -11042,7 +11222,7 @@ public readonly auditReport: string;
11042
11222
 
11043
11223
  - *Type:* string
11044
11224
 
11045
- [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.
11046
11226
 
11047
11227
  ---
11048
11228
 
@@ -11054,7 +11234,7 @@ public readonly remoteMode: SettingsTaskCacheRemoteMode;
11054
11234
 
11055
11235
  - *Type:* <a href="#mise-projen.SettingsTaskCacheRemoteMode">SettingsTaskCacheRemoteMode</a>
11056
11236
 
11057
- [experimental] Remote task and action cache access mode.
11237
+ [experimental] How mise uses the remote task cache server.
11058
11238
 
11059
11239
  ---
11060
11240
 
@@ -11066,7 +11246,7 @@ public readonly remoteNamespace: string;
11066
11246
 
11067
11247
  - *Type:* string
11068
11248
 
11069
- [experimental] Namespace sent to the remote build cache.
11249
+ [experimental] Namespace that keeps this project's entries apart on the remote task cache server.
11070
11250
 
11071
11251
  ---
11072
11252
 
@@ -11078,7 +11258,7 @@ public readonly remoteOidcAudience: string;
11078
11258
 
11079
11259
  - *Type:* string
11080
11260
 
11081
- [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.
11082
11262
 
11083
11263
  ---
11084
11264
 
@@ -11090,7 +11270,7 @@ public readonly remoteToken: string;
11090
11270
 
11091
11271
  - *Type:* string
11092
11272
 
11093
- [experimental] Bearer token for remote build-cache authentication.
11273
+ [experimental] Bearer token that mise sends to the remote task cache server.
11094
11274
 
11095
11275
  ---
11096
11276
 
@@ -11102,7 +11282,7 @@ public readonly remoteTokenFile: string;
11102
11282
 
11103
11283
  - *Type:* string
11104
11284
 
11105
- [experimental] File containing a remote build-cache bearer token.
11285
+ [experimental] File that mise reads the remote task cache token from before each request.
11106
11286
 
11107
11287
  ---
11108
11288
 
@@ -11114,7 +11294,7 @@ public readonly remoteUrl: string;
11114
11294
 
11115
11295
  - *Type:* string
11116
11296
 
11117
- [experimental] Base URL for the remote build-cache service.
11297
+ [experimental] Base URL of the remote task cache server.
11118
11298
 
11119
11299
  ---
11120
11300
 
@@ -11126,7 +11306,37 @@ public readonly statsReport: string;
11126
11306
 
11127
11307
  - *Type:* string
11128
11308
 
11129
- [experimental] File to write action-cache session statistics to.
11309
+ [deprecated] Has no effect since the built-in action cache was removed.
11310
+
11311
+ ---
11312
+
11313
+ ### SettingsToolUpdate <a name="SettingsToolUpdate" id="mise-projen.SettingsToolUpdate"></a>
11314
+
11315
+ #### Initializer <a name="Initializer" id="mise-projen.SettingsToolUpdate.Initializer"></a>
11316
+
11317
+ ```typescript
11318
+ import { SettingsToolUpdate } from 'mise-projen'
11319
+
11320
+ const settingsToolUpdate: SettingsToolUpdate = { ... }
11321
+ ```
11322
+
11323
+ #### Properties <a name="Properties" id="Properties"></a>
11324
+
11325
+ | **Name** | **Type** | **Description** |
11326
+ | --- | --- | --- |
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`. |
11328
+
11329
+ ---
11330
+
11331
+ ##### `checkDuration`<sup>Optional</sup> <a name="checkDuration" id="mise-projen.SettingsToolUpdate.property.checkDuration"></a>
11332
+
11333
+ ```typescript
11334
+ public readonly checkDuration: string;
11335
+ ```
11336
+
11337
+ - *Type:* string
11338
+
11339
+ How often mise checks for a newer version of a global tool that sets `auto_update = true`.
11130
11340
 
11131
11341
  ---
11132
11342
 
@@ -11144,8 +11354,8 @@ const settingsUpgrade: SettingsUpgrade = { ... }
11144
11354
 
11145
11355
  | **Name** | **Type** | **Description** |
11146
11356
  | --- | --- | --- |
11147
- | <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. |
11148
- | <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. |
11149
11359
 
11150
11360
  ---
11151
11361
 
@@ -11157,7 +11367,7 @@ public readonly autoPrune: boolean;
11157
11367
 
11158
11368
  - *Type:* boolean
11159
11369
 
11160
- 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.
11161
11371
 
11162
11372
  ---
11163
11373
 
@@ -11169,7 +11379,63 @@ public readonly pruneAfter: string;
11169
11379
 
11170
11380
  - *Type:* string
11171
11381
 
11172
- Grace period before versions replaced by `mise upgrade` are automatically pruned.
11382
+ Grace period before mise removes a version that `mise upgrade` replaced.
11383
+
11384
+ ---
11385
+
11386
+ ### SettingsWriteTargets <a name="SettingsWriteTargets" id="mise-projen.SettingsWriteTargets"></a>
11387
+
11388
+ #### Initializer <a name="Initializer" id="mise-projen.SettingsWriteTargets.Initializer"></a>
11389
+
11390
+ ```typescript
11391
+ import { SettingsWriteTargets } from 'mise-projen'
11392
+
11393
+ const settingsWriteTargets: SettingsWriteTargets = { ... }
11394
+ ```
11395
+
11396
+ #### Properties <a name="Properties" id="Properties"></a>
11397
+
11398
+ | **Name** | **Type** | **Description** |
11399
+ | --- | --- | --- |
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. |
11403
+
11404
+ ---
11405
+
11406
+ ##### `dotfiles`<sup>Optional</sup> <a name="dotfiles" id="mise-projen.SettingsWriteTargets.property.dotfiles"></a>
11407
+
11408
+ ```typescript
11409
+ public readonly dotfiles: string;
11410
+ ```
11411
+
11412
+ - *Type:* string
11413
+
11414
+ Global config file where `mise dot add` creates new `[dotfiles]` entries.
11415
+
11416
+ ---
11417
+
11418
+ ##### `packages`<sup>Optional</sup> <a name="packages" id="mise-projen.SettingsWriteTargets.property.packages"></a>
11419
+
11420
+ ```typescript
11421
+ public readonly packages: string;
11422
+ ```
11423
+
11424
+ - *Type:* string
11425
+
11426
+ Global config file where `--global` package commands create new `[bootstrap.packages]` entries.
11427
+
11428
+ ---
11429
+
11430
+ ##### `tools`<sup>Optional</sup> <a name="tools" id="mise-projen.SettingsWriteTargets.property.tools"></a>
11431
+
11432
+ ```typescript
11433
+ public readonly tools: string;
11434
+ ```
11435
+
11436
+ - *Type:* string
11437
+
11438
+ Global config file where `mise use --global` creates new `[tools]` entries.
11173
11439
 
11174
11440
  ---
11175
11441
 
@@ -11187,7 +11453,7 @@ const settingsZig: SettingsZig = { ... }
11187
11453
 
11188
11454
  | **Name** | **Type** | **Description** |
11189
11455
  | --- | --- | --- |
11190
- | <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. |
11191
11457
 
11192
11458
  ---
11193
11459
 
@@ -11199,7 +11465,7 @@ public readonly useCommunityMirrors: boolean;
11199
11465
 
11200
11466
  - *Type:* boolean
11201
11467
 
11202
- Download Zig from community-maintained mirrors.
11468
+ Download Zig from the community mirrors that ziglang.org recommends before trying ziglang.org itself.
11203
11469
 
11204
11470
  ---
11205
11471
 
@@ -11823,7 +12089,7 @@ public readonly value: string | number | boolean;
11823
12089
 
11824
12090
  ### SettingsPythonUvVenvAuto <a name="SettingsPythonUvVenvAuto" id="mise-projen.SettingsPythonUvVenvAuto"></a>
11825
12091
 
11826
- 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.
11827
12093
 
11828
12094
 
11829
12095
  #### Static Functions <a name="Static Functions" id="Static Functions"></a>
@@ -12403,6 +12669,35 @@ absent.
12403
12669
  ---
12404
12670
 
12405
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
+
12406
12701
  ### MiseTomlSchemaBootstrapLinuxSystemdUnitsType <a name="MiseTomlSchemaBootstrapLinuxSystemdUnitsType" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsType"></a>
12407
12702
 
12408
12703
  write Type in the [Service] section.
@@ -12633,6 +12928,7 @@ A mise-provided user service.
12633
12928
  | **Name** | **Description** |
12634
12929
  | --- | --- |
12635
12930
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServicesBuiltin.HISTORY_HYPHEN_WATCH">HISTORY_HYPHEN_WATCH</a></code> | history-watch. |
12931
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServicesBuiltin.TOOL_HYPHEN_UPDATE">TOOL_HYPHEN_UPDATE</a></code> | tool-update. |
12636
12932
 
12637
12933
  ---
12638
12934
 
@@ -12643,6 +12939,13 @@ history-watch.
12643
12939
  ---
12644
12940
 
12645
12941
 
12942
+ ##### `TOOL_HYPHEN_UPDATE` <a name="TOOL_HYPHEN_UPDATE" id="mise-projen.MiseTomlSchemaBootstrapServicesBuiltin.TOOL_HYPHEN_UPDATE"></a>
12943
+
12944
+ tool-update.
12945
+
12946
+ ---
12947
+
12948
+
12646
12949
  ### MiseTomlSchemaBootstrapServicesOnChange <a name="MiseTomlSchemaBootstrapServicesOnChange" id="mise-projen.MiseTomlSchemaBootstrapServicesOnChange"></a>
12647
12950
 
12648
12951
  System scope only.
@@ -12870,7 +13173,7 @@ symlink.
12870
13173
 
12871
13174
  ### SettingsColorTheme <a name="SettingsColorTheme" id="mise-projen.SettingsColorTheme"></a>
12872
13175
 
12873
- Theme for interactive prompts (auto/default, charm, base16, catppuccin, dracula).
13176
+ Color theme for interactive prompts, such as the task picker in `mise run`.
12874
13177
 
12875
13178
  #### Members <a name="Members" id="Members"></a>
12876
13179
 
@@ -12927,11 +13230,122 @@ dracula.
12927
13230
  ---
12928
13231
 
12929
13232
 
12930
- ### 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
+ ---
12931
13274
 
12932
- What the history watcher does with a connected setup repository on its own: `sync` publishes after saves, fetches periodically, and applies incoming changes.
12933
13275
 
12934
- 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.
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
+
13338
+
13339
+ ##### `JSONL` <a name="JSONL" id="mise-projen.SettingsGithubRelayLogFormat.JSONL"></a>
13340
+
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.
12935
13349
 
12936
13350
  #### Members <a name="Members" id="Members"></a>
12937
13351
 
@@ -12964,9 +13378,36 @@ manual.
12964
13378
  ---
12965
13379
 
12966
13380
 
13381
+ ### SettingsInstallLayout <a name="SettingsInstallLayout" id="mise-projen.SettingsInstallLayout"></a>
13382
+
13383
+ [experimental] Name installations by what they are (`identity`) instead of `installs/<tool>/<version>` (`legacy`).
13384
+
13385
+ #### Members <a name="Members" id="Members"></a>
13386
+
13387
+ | **Name** | **Description** |
13388
+ | --- | --- |
13389
+ | <code><a href="#mise-projen.SettingsInstallLayout.LEGACY">LEGACY</a></code> | legacy. |
13390
+ | <code><a href="#mise-projen.SettingsInstallLayout.IDENTITY">IDENTITY</a></code> | identity. |
13391
+
13392
+ ---
13393
+
13394
+ ##### `LEGACY` <a name="LEGACY" id="mise-projen.SettingsInstallLayout.LEGACY"></a>
13395
+
13396
+ legacy.
13397
+
13398
+ ---
13399
+
13400
+
13401
+ ##### `IDENTITY` <a name="IDENTITY" id="mise-projen.SettingsInstallLayout.IDENTITY"></a>
13402
+
13403
+ identity.
13404
+
13405
+ ---
13406
+
13407
+
12967
13408
  ### SettingsLibc <a name="SettingsLibc" id="mise-projen.SettingsLibc"></a>
12968
13409
 
12969
- Libc implementation to use for precompiled Linux binaries.
13410
+ Libc build to install on Linux when a tool publishes both glibc and musl builds.
12970
13411
 
12971
13412
  #### Members <a name="Members" id="Members"></a>
12972
13413
 
@@ -13034,7 +13475,7 @@ system.
13034
13475
 
13035
13476
  ### SettingsLockfileMode <a name="SettingsLockfileMode" id="mise-projen.SettingsLockfileMode"></a>
13036
13477
 
13037
- Choose incremental merging or complete lockfile generation.
13478
+ How lockfiles are written: entry by entry, or rebuilt from the current requests.
13038
13479
 
13039
13480
  #### Members <a name="Members" id="Members"></a>
13040
13481
 
@@ -13061,7 +13502,7 @@ generate.
13061
13502
 
13062
13503
  ### SettingsLogLevel <a name="SettingsLogLevel" id="mise-projen.SettingsLogLevel"></a>
13063
13504
 
13064
- Show more/less output.
13505
+ Log level for mise's own output.
13065
13506
 
13066
13507
  #### Members <a name="Members" id="Members"></a>
13067
13508
 
@@ -13112,7 +13553,7 @@ error.
13112
13553
 
13113
13554
  ### SettingsNpmPackageManager <a name="SettingsNpmPackageManager" id="mise-projen.SettingsNpmPackageManager"></a>
13114
13555
 
13115
- Package manager to use for installing npm packages.
13556
+ Package manager that installs `npm:` tools.
13116
13557
 
13117
13558
  #### Members <a name="Members" id="Members"></a>
13118
13559
 
@@ -13169,9 +13610,44 @@ pnpm.
13169
13610
  ---
13170
13611
 
13171
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
+
13172
13648
  ### SettingsSystemDeps <a name="SettingsSystemDeps" id="mise-projen.SettingsSystemDeps"></a>
13173
13649
 
13174
- 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.
13175
13651
 
13176
13652
  #### Members <a name="Members" id="Members"></a>
13177
13653
 
@@ -13214,7 +13690,7 @@ ignore.
13214
13690
 
13215
13691
  ### SettingsTaskCacheRemoteMode <a name="SettingsTaskCacheRemoteMode" id="mise-projen.SettingsTaskCacheRemoteMode"></a>
13216
13692
 
13217
- [experimental] Remote task and action cache access mode.
13693
+ [experimental] How mise uses the remote task cache server.
13218
13694
 
13219
13695
  #### Members <a name="Members" id="Members"></a>
13220
13696
 
@@ -13249,7 +13725,7 @@ write-only.
13249
13725
 
13250
13726
  ### SettingsTaskOutput <a name="SettingsTaskOutput" id="mise-projen.SettingsTaskOutput"></a>
13251
13727
 
13252
- Change output style when executing tasks.
13728
+ Default output style for `mise run`.
13253
13729
 
13254
13730
  #### Members <a name="Members" id="Members"></a>
13255
13731
 
@@ -13313,3 +13789,46 @@ silent.
13313
13789
 
13314
13790
  ---
13315
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
+