mise-projen 0.0.9 → 0.0.11
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/.jsii +1764 -1215
- package/API.md +1135 -778
- package/lib/index.js +1 -1
- package/lib/miseConfig.d.ts +476 -338
- package/lib/miseConfig.js +150 -17
- package/lib/miseFile.js +1 -1
- package/package.json +1 -1
- package/schemas/mise.json +544 -375
package/API.md
CHANGED
|
@@ -922,7 +922,7 @@ const miseTomlSchema: MiseTomlSchema = { ... }
|
|
|
922
922
|
| <code><a href="#mise-projen.MiseTomlSchema.property.experimentalMonorepoRoot">experimentalMonorepoRoot</a></code> | <code>boolean</code> | deprecated alias of monorepo_root. |
|
|
923
923
|
| <code><a href="#mise-projen.MiseTomlSchema.property.history">history</a></code> | <code><a href="#mise-projen.MiseTomlSchemaHistory">MiseTomlSchemaHistory</a></code> | dotfiles history: what is never captured, reload commands, and the setup repository (https://mise.jdx.dev/history.html). |
|
|
924
924
|
| <code><a href="#mise-projen.MiseTomlSchema.property.hooks">hooks</a></code> | <code><a href="#mise-projen.Hooks">Hooks</a></code> | hooks to run on events like cd, enter, leave. |
|
|
925
|
-
| <code><a href="#mise-projen.MiseTomlSchema.property.include">include</a></code> | <code>any</code> |
|
|
925
|
+
| <code><a href="#mise-projen.MiseTomlSchema.property.include">include</a></code> | <code>any</code> | config files merged into this one, ranking just below it: a local path (relative to this file), git::<url>//<path>.toml?ref=<ref> or oci::<registry>/<repo>[:tag\|@sha256:<digest>] (the artifact holds a mise.toml). Paranoid mode requires a commit sha or digest for remote includes and rejects local ones; otherwise a branch or tag is refreshed after fetch_remote_versions_cache. |
|
|
926
926
|
| <code><a href="#mise-projen.MiseTomlSchema.property.minVersion">minVersion</a></code> | <code>any</code> | minimum version of mise required to use this config. |
|
|
927
927
|
| <code><a href="#mise-projen.MiseTomlSchema.property.monorepo">monorepo</a></code> | <code><a href="#mise-projen.Monorepo">Monorepo</a></code> | configuration for monorepo task discovery. |
|
|
928
928
|
| <code><a href="#mise-projen.MiseTomlSchema.property.monorepoRoot">monorepoRoot</a></code> | <code>boolean</code> | marks this config as a monorepo root for task path syntax. |
|
|
@@ -1166,7 +1166,7 @@ public readonly include: any;
|
|
|
1166
1166
|
|
|
1167
1167
|
- *Type:* any
|
|
1168
1168
|
|
|
1169
|
-
|
|
1169
|
+
config files merged into this one, ranking just below it: a local path (relative to this file), git::<url>//<path>.toml?ref=<ref> or oci::<registry>/<repo>[:tag|@sha256:<digest>] (the artifact holds a mise.toml). Paranoid mode requires a commit sha or digest for remote includes and rejects local ones; otherwise a branch or tag is refreshed after fetch_remote_versions_cache.
|
|
1170
1170
|
|
|
1171
1171
|
---
|
|
1172
1172
|
|
|
@@ -1958,6 +1958,7 @@ const miseTomlSchemaBootstrapDirectories: MiseTomlSchemaBootstrapDirectories = {
|
|
|
1958
1958
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.group">group</a></code> | <code>string</code> | *No description.* |
|
|
1959
1959
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.mode">mode</a></code> | <code>string</code> | *No description.* |
|
|
1960
1960
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.notify">notify</a></code> | <code>string[]</code> | *No description.* |
|
|
1961
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.os">os</a></code> | <code>string[]</code> | OS or OS/arch selectors; |
|
|
1961
1962
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.owner">owner</a></code> | <code>string</code> | *No description.* |
|
|
1962
1963
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.phase">phase</a></code> | <code><a href="#mise-projen.BootstrapFilePhase">BootstrapFilePhase</a></code> | *No description.* |
|
|
1963
1964
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.recursive">recursive</a></code> | <code>boolean</code> | *No description.* |
|
|
@@ -1996,6 +1997,20 @@ public readonly notify: string[];
|
|
|
1996
1997
|
|
|
1997
1998
|
---
|
|
1998
1999
|
|
|
2000
|
+
##### `os`<sup>Optional</sup> <a name="os" id="mise-projen.MiseTomlSchemaBootstrapDirectories.property.os"></a>
|
|
2001
|
+
|
|
2002
|
+
```typescript
|
|
2003
|
+
public readonly os: string[];
|
|
2004
|
+
```
|
|
2005
|
+
|
|
2006
|
+
- *Type:* string[]
|
|
2007
|
+
|
|
2008
|
+
OS or OS/arch selectors;
|
|
2009
|
+
|
|
2010
|
+
entries on other platforms are skipped
|
|
2011
|
+
|
|
2012
|
+
---
|
|
2013
|
+
|
|
1999
2014
|
##### `owner`<sup>Optional</sup> <a name="owner" id="mise-projen.MiseTomlSchemaBootstrapDirectories.property.owner"></a>
|
|
2000
2015
|
|
|
2001
2016
|
```typescript
|
|
@@ -2064,6 +2079,7 @@ const miseTomlSchemaBootstrapFiles: MiseTomlSchemaBootstrapFiles = { ... }
|
|
|
2064
2079
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.group">group</a></code> | <code>string</code> | *No description.* |
|
|
2065
2080
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.mode">mode</a></code> | <code>string</code> | *No description.* |
|
|
2066
2081
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.notify">notify</a></code> | <code>string[]</code> | *No description.* |
|
|
2082
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.os">os</a></code> | <code>string[]</code> | OS or OS/arch selectors; |
|
|
2067
2083
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.owner">owner</a></code> | <code>string</code> | *No description.* |
|
|
2068
2084
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.phase">phase</a></code> | <code><a href="#mise-projen.BootstrapFilePhase">BootstrapFilePhase</a></code> | *No description.* |
|
|
2069
2085
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.removeEmpty">removeEmpty</a></code> | <code>boolean</code> | remove the target when the template renders to empty or whitespace-only content; |
|
|
@@ -2114,6 +2130,20 @@ public readonly notify: string[];
|
|
|
2114
2130
|
|
|
2115
2131
|
---
|
|
2116
2132
|
|
|
2133
|
+
##### `os`<sup>Optional</sup> <a name="os" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.os"></a>
|
|
2134
|
+
|
|
2135
|
+
```typescript
|
|
2136
|
+
public readonly os: string[];
|
|
2137
|
+
```
|
|
2138
|
+
|
|
2139
|
+
- *Type:* string[]
|
|
2140
|
+
|
|
2141
|
+
OS or OS/arch selectors;
|
|
2142
|
+
|
|
2143
|
+
entries on other platforms are skipped
|
|
2144
|
+
|
|
2145
|
+
---
|
|
2146
|
+
|
|
2117
2147
|
##### `owner`<sup>Optional</sup> <a name="owner" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.owner"></a>
|
|
2118
2148
|
|
|
2119
2149
|
```typescript
|
|
@@ -2711,6 +2741,7 @@ const miseTomlSchemaBootstrapLinuxSystemdUnits: MiseTomlSchemaBootstrapLinuxSyst
|
|
|
2711
2741
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.standardError">standardError</a></code> | <code>string</code> | write StandardError in the [Service] section. |
|
|
2712
2742
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.standardOutput">standardOutput</a></code> | <code>string</code> | write StandardOutput in the [Service] section. |
|
|
2713
2743
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.start">start</a></code> | <code>boolean</code> | restart the unit after writing it; |
|
|
2744
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState">MiseTomlSchemaBootstrapLinuxSystemdUnitsState</a></code> | present writes and manages the unit; |
|
|
2714
2745
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.timeoutStartSec">timeoutStartSec</a></code> | <code>string</code> | write TimeoutStartSec in the [Service] section. |
|
|
2715
2746
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.timeoutStopSec">timeoutStopSec</a></code> | <code>string</code> | write TimeoutStopSec in the [Service] section. |
|
|
2716
2747
|
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.type">type</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsType">MiseTomlSchemaBootstrapLinuxSystemdUnitsType</a></code> | write Type in the [Service] section. |
|
|
@@ -3084,6 +3115,20 @@ when false, stop the unit after writing it
|
|
|
3084
3115
|
|
|
3085
3116
|
---
|
|
3086
3117
|
|
|
3118
|
+
##### `state`<sup>Optional</sup> <a name="state" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.state"></a>
|
|
3119
|
+
|
|
3120
|
+
```typescript
|
|
3121
|
+
public readonly state: MiseTomlSchemaBootstrapLinuxSystemdUnitsState;
|
|
3122
|
+
```
|
|
3123
|
+
|
|
3124
|
+
- *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState">MiseTomlSchemaBootstrapLinuxSystemdUnitsState</a>
|
|
3125
|
+
|
|
3126
|
+
present writes and manages the unit;
|
|
3127
|
+
|
|
3128
|
+
absent stops, disables, and removes both dev.mise.<name>.service and dev.mise.<name>.timer
|
|
3129
|
+
|
|
3130
|
+
---
|
|
3131
|
+
|
|
3087
3132
|
##### `timeoutStartSec`<sup>Optional</sup> <a name="timeoutStartSec" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.property.timeoutStartSec"></a>
|
|
3088
3133
|
|
|
3089
3134
|
```typescript
|
|
@@ -5158,6 +5203,7 @@ const miseTomlSchemaHistory: MiseTomlSchemaHistory = { ... }
|
|
|
5158
5203
|
| <code><a href="#mise-projen.MiseTomlSchemaHistory.property.encryption">encryption</a></code> | <code><a href="#mise-projen.MiseTomlSchemaHistoryEncryption">MiseTomlSchemaHistoryEncryption</a></code> | *No description.* |
|
|
5159
5204
|
| <code><a href="#mise-projen.MiseTomlSchemaHistory.property.exclude">exclude</a></code> | <code>string[]</code> | globs never captured by dotfiles history; |
|
|
5160
5205
|
| <code><a href="#mise-projen.MiseTomlSchemaHistory.property.gitEmail">gitEmail</a></code> | <code>string</code> | email used for history commit authors and committers; |
|
|
5206
|
+
| <code><a href="#mise-projen.MiseTomlSchemaHistory.property.machine">machine</a></code> | <code>string</code> | this machine's name in per-machine streams (variants = [{ machine = true }]) instead of the name generated with the history store. |
|
|
5161
5207
|
| <code><a href="#mise-projen.MiseTomlSchemaHistory.property.origin">origin</a></code> | <code><a href="#mise-projen.MiseTomlSchemaHistoryOrigin">MiseTomlSchemaHistoryOrigin</a></code> | the setup repository this machine publishes to and fetches from; |
|
|
5162
5208
|
| <code><a href="#mise-projen.MiseTomlSchemaHistory.property.reload">reload</a></code> | <code>{[ key: string ]: string}</code> | commands run once after a rollback or undo writes a path matching the glob (trusted global or system config only). |
|
|
5163
5209
|
|
|
@@ -5201,6 +5247,18 @@ email used for history commit authors and committers;
|
|
|
5201
5247
|
|
|
5202
5248
|
---
|
|
5203
5249
|
|
|
5250
|
+
##### `machine`<sup>Optional</sup> <a name="machine" id="mise-projen.MiseTomlSchemaHistory.property.machine"></a>
|
|
5251
|
+
|
|
5252
|
+
```typescript
|
|
5253
|
+
public readonly machine: string;
|
|
5254
|
+
```
|
|
5255
|
+
|
|
5256
|
+
- *Type:* string
|
|
5257
|
+
|
|
5258
|
+
this machine's name in per-machine streams (variants = [{ machine = true }]) instead of the name generated with the history store.
|
|
5259
|
+
|
|
5260
|
+
---
|
|
5261
|
+
|
|
5204
5262
|
##### `origin`<sup>Optional</sup> <a name="origin" id="mise-projen.MiseTomlSchemaHistory.property.origin"></a>
|
|
5205
5263
|
|
|
5206
5264
|
```typescript
|
|
@@ -5612,8 +5670,8 @@ const monorepo: Monorepo = { ... }
|
|
|
5612
5670
|
| <code><a href="#mise-projen.Monorepo.property.configRoots">configRoots</a></code> | <code>string[]</code> | Explicit list of config root paths for monorepo task discovery. |
|
|
5613
5671
|
| <code><a href="#mise-projen.Monorepo.property.lockfile">lockfile</a></code> | <code>boolean</code> | Use a single lockfile at the monorepo root for descendant config roots. |
|
|
5614
5672
|
| <code><a href="#mise-projen.Monorepo.property.pathAliases">pathAliases</a></code> | <code>{[ key: string ]: string}</code> | Short names for configured monorepo task roots. |
|
|
5615
|
-
| <code><a href="#mise-projen.Monorepo.property.projects">projects</a></code> | <code>{[ key: string ]: <a href="#mise-projen.MonorepoProjects">MonorepoProjects</a>}</code> |
|
|
5616
|
-
| <code><a href="#mise-projen.Monorepo.property.taskDefaults">taskDefaults</a></code> | <code>{[ key: string ]: any}</code> |
|
|
5673
|
+
| <code><a href="#mise-projen.Monorepo.property.projects">projects</a></code> | <code>{[ key: string ]: <a href="#mise-projen.MonorepoProjects">MonorepoProjects</a>}</code> | Explicit additions, removals, and overrides applied to provider-inferred workspace projects. |
|
|
5674
|
+
| <code><a href="#mise-projen.Monorepo.property.taskDefaults">taskDefaults</a></code> | <code>{[ key: string ]: any}</code> | Task defaults applied by task name across inferred and explicit workspace projects. |
|
|
5617
5675
|
|
|
5618
5676
|
---
|
|
5619
5677
|
|
|
@@ -5667,7 +5725,7 @@ public readonly projects: {[ key: string ]: MonorepoProjects};
|
|
|
5667
5725
|
|
|
5668
5726
|
- *Type:* {[ key: string ]: <a href="#mise-projen.MonorepoProjects">MonorepoProjects</a>}
|
|
5669
5727
|
|
|
5670
|
-
|
|
5728
|
+
Explicit additions, removals, and overrides applied to provider-inferred workspace projects.
|
|
5671
5729
|
|
|
5672
5730
|
---
|
|
5673
5731
|
|
|
@@ -5679,7 +5737,7 @@ public readonly taskDefaults: {[ key: string ]: any};
|
|
|
5679
5737
|
|
|
5680
5738
|
- *Type:* {[ key: string ]: any}
|
|
5681
5739
|
|
|
5682
|
-
|
|
5740
|
+
Task defaults applied by task name across inferred and explicit workspace projects.
|
|
5683
5741
|
|
|
5684
5742
|
---
|
|
5685
5743
|
|
|
@@ -5792,179 +5850,181 @@ const settings: Settings = { ... }
|
|
|
5792
5850
|
|
|
5793
5851
|
| **Name** | **Type** | **Description** |
|
|
5794
5852
|
| --- | --- | --- |
|
|
5795
|
-
| <code><a href="#mise-projen.Settings.property.activateAggressive">activateAggressive</a></code> | <code>boolean</code> |
|
|
5796
|
-
| <code><a href="#mise-projen.Settings.property.activateShims">activateShims</a></code> | <code>boolean</code> |
|
|
5853
|
+
| <code><a href="#mise-projen.Settings.property.activateAggressive">activateAggressive</a></code> | <code>boolean</code> | Keep mise's tool directories ahead of `PATH` entries added after `mise activate`. |
|
|
5854
|
+
| <code><a href="#mise-projen.Settings.property.activateShims">activateShims</a></code> | <code>boolean</code> | Let `mise activate` add the shims directories to `PATH` for auto-install and lazy tools. |
|
|
5797
5855
|
| <code><a href="#mise-projen.Settings.property.age">age</a></code> | <code><a href="#mise-projen.SettingsAge">SettingsAge</a></code> | *No description.* |
|
|
5798
|
-
| <code><a href="#mise-projen.Settings.property.allCompile">allCompile</a></code> | <code>boolean</code> |
|
|
5799
|
-
| <code><a href="#mise-projen.Settings.property.alwaysKeepDownload">alwaysKeepDownload</a></code> | <code>boolean</code> |
|
|
5800
|
-
| <code><a href="#mise-projen.Settings.property.alwaysKeepInstall">alwaysKeepInstall</a></code> | <code>boolean</code> |
|
|
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> | [deprecated] Keep downloaded archives and sources after installing, for debugging. |
|
|
5858
|
+
| <code><a href="#mise-projen.Settings.property.alwaysKeepInstall">alwaysKeepInstall</a></code> | <code>boolean</code> | Keep a failed installation's partial install directory and downloads, for debugging. |
|
|
5801
5859
|
| <code><a href="#mise-projen.Settings.property.aqua">aqua</a></code> | <code><a href="#mise-projen.SettingsAqua">SettingsAqua</a></code> | *No description.* |
|
|
5802
|
-
| <code><a href="#mise-projen.Settings.property.arch">arch</a></code> | <code>string</code> | Architecture
|
|
5803
|
-
| <code><a href="#mise-projen.Settings.property.asdfCompat">asdfCompat</a></code> | <code>boolean</code> |
|
|
5860
|
+
| <code><a href="#mise-projen.Settings.property.arch">arch</a></code> | <code>string</code> | Architecture of the precompiled binaries mise downloads. |
|
|
5861
|
+
| <code><a href="#mise-projen.Settings.property.asdfCompat">asdfCompat</a></code> | <code>boolean</code> | Write `.tool-versions` files that asdf can read, with exact versions. |
|
|
5804
5862
|
| <code><a href="#mise-projen.Settings.property.autoEnv">autoEnv</a></code> | <code>boolean</code> | Automatically enable platform config environments (unix, {os}, {os}-{arch}). |
|
|
5805
|
-
| <code><a href="#mise-projen.Settings.property.autoInstall">autoInstall</a></code> | <code>boolean</code> |
|
|
5806
|
-
| <code><a href="#mise-projen.Settings.property.autoInstallDisableTools">autoInstallDisableTools</a></code> | <code>string[]</code> |
|
|
5807
|
-
| <code><a href="#mise-projen.Settings.property.autoUpdate">autoUpdate</a></code> | <code>boolean</code> | [deprecated]
|
|
5808
|
-
| <code><a href="#mise-projen.Settings.property.autoUpdateCheckDuration">autoUpdateCheckDuration</a></code> | <code>string</code> | [deprecated]
|
|
5809
|
-
| <code><a href="#mise-projen.Settings.property.cachePruneAge">cachePruneAge</a></code> | <code>string</code> | Delete files
|
|
5863
|
+
| <code><a href="#mise-projen.Settings.property.autoInstall">autoInstall</a></code> | <code>boolean</code> | Install missing tools automatically when a command needs them. |
|
|
5864
|
+
| <code><a href="#mise-projen.Settings.property.autoInstallDisableTools">autoInstallDisableTools</a></code> | <code>string[]</code> | Tools that automatic installs skip, such as `node`. |
|
|
5865
|
+
| <code><a href="#mise-projen.Settings.property.autoUpdate">autoUpdate</a></code> | <code>boolean</code> | [deprecated] Old name for `self_update.auto`. |
|
|
5866
|
+
| <code><a href="#mise-projen.Settings.property.autoUpdateCheckDuration">autoUpdateCheckDuration</a></code> | <code>string</code> | [deprecated] Old name for `self_update.check_duration`. |
|
|
5867
|
+
| <code><a href="#mise-projen.Settings.property.cachePruneAge">cachePruneAge</a></code> | <code>string</code> | Delete cache files that have not been accessed for this long. |
|
|
5810
5868
|
| <code><a href="#mise-projen.Settings.property.cargo">cargo</a></code> | <code><a href="#mise-projen.SettingsCargo">SettingsCargo</a></code> | *No description.* |
|
|
5811
|
-
| <code><a href="#mise-projen.Settings.property.cd">cd</a></code> | <code>string</code> |
|
|
5812
|
-
| <code><a href="#mise-projen.Settings.property.ceilingPaths">ceilingPaths</a></code> | <code>string[]</code> | Directories where mise stops searching for config files. |
|
|
5813
|
-
| <code><a href="#mise-projen.Settings.property.ci">ci</a></code> | <code>boolean</code> |
|
|
5814
|
-
| <code><a href="#mise-projen.Settings.property.color">color</a></code> | <code>boolean</code> | Use color in mise terminal output. |
|
|
5815
|
-
| <code><a href="#mise-projen.Settings.property.colorTheme">colorTheme</a></code> | <code><a href="#mise-projen.SettingsColorTheme">SettingsColorTheme</a></code> |
|
|
5869
|
+
| <code><a href="#mise-projen.Settings.property.cd">cd</a></code> | <code>string</code> | Directory to change to after mise starts. |
|
|
5870
|
+
| <code><a href="#mise-projen.Settings.property.ceilingPaths">ceilingPaths</a></code> | <code>string[]</code> | Directories where mise stops searching parent directories for config files. |
|
|
5871
|
+
| <code><a href="#mise-projen.Settings.property.ci">ci</a></code> | <code>boolean</code> | Behave as in CI, which answers yes to confirmation prompts; |
|
|
5872
|
+
| <code><a href="#mise-projen.Settings.property.color">color</a></code> | <code>boolean</code> | Use color in mise's terminal output. |
|
|
5873
|
+
| <code><a href="#mise-projen.Settings.property.colorTheme">colorTheme</a></code> | <code><a href="#mise-projen.SettingsColorTheme">SettingsColorTheme</a></code> | Color theme for interactive prompts, such as the task picker in `mise run`. |
|
|
5816
5874
|
| <code><a href="#mise-projen.Settings.property.conda">conda</a></code> | <code><a href="#mise-projen.SettingsConda">SettingsConda</a></code> | *No description.* |
|
|
5817
|
-
| <code><a href="#mise-projen.Settings.property.debug">debug</a></code> | <code>boolean</code> |
|
|
5818
|
-
| <code><a href="#mise-projen.Settings.property.defaultConfigFilename">defaultConfigFilename</a></code> | <code>string</code> |
|
|
5819
|
-
| <code><a href="#mise-projen.Settings.property.defaultToolVersionsFilename">defaultToolVersionsFilename</a></code> | <code>string</code> |
|
|
5820
|
-
| <code><a href="#mise-projen.Settings.property.disableBackends">disableBackends</a></code> | <code>string[]</code> | Backends
|
|
5821
|
-
| <code><a href="#mise-projen.Settings.property.disableDefaultRegistry">disableDefaultRegistry</a></code> | <code>boolean</code> |
|
|
5822
|
-
| <code><a href="#mise-projen.Settings.property.disableHints">disableHints</a></code> | <code>string[]</code> |
|
|
5823
|
-
| <code><a href="#mise-projen.Settings.property.disableTools">disableTools</a></code> | <code>string[]</code> | Tools
|
|
5875
|
+
| <code><a href="#mise-projen.Settings.property.debug">debug</a></code> | <code>boolean</code> | Set the log level to debug. |
|
|
5876
|
+
| <code><a href="#mise-projen.Settings.property.defaultConfigFilename">defaultConfigFilename</a></code> | <code>string</code> | Extra project config filename mise reads, and the name it gives new config files. |
|
|
5877
|
+
| <code><a href="#mise-projen.Settings.property.defaultToolVersionsFilename">defaultToolVersionsFilename</a></code> | <code>string</code> | Extra filename mise reads as a `.tool-versions` file. |
|
|
5878
|
+
| <code><a href="#mise-projen.Settings.property.disableBackends">disableBackends</a></code> | <code>string[]</code> | Backends mise ignores when resolving and installing tools, such as `asdf` or `pypi`. |
|
|
5879
|
+
| <code><a href="#mise-projen.Settings.property.disableDefaultRegistry">disableDefaultRegistry</a></code> | <code>boolean</code> | Stop mapping short names such as `php` to the asdf and vfox plugins listed in the registry. |
|
|
5880
|
+
| <code><a href="#mise-projen.Settings.property.disableHints">disableHints</a></code> | <code>string[]</code> | Hints to stop showing, by ID; |
|
|
5881
|
+
| <code><a href="#mise-projen.Settings.property.disableTools">disableTools</a></code> | <code>string[]</code> | Tools mise ignores even when a config file lists them. |
|
|
5824
5882
|
| <code><a href="#mise-projen.Settings.property.disableUpdateWarning">disableUpdateWarning</a></code> | <code>boolean</code> | Suppress warnings when a newer mise version is available. |
|
|
5825
5883
|
| <code><a href="#mise-projen.Settings.property.dotfiles">dotfiles</a></code> | <code><a href="#mise-projen.SettingsDotfiles">SettingsDotfiles</a></code> | *No description.* |
|
|
5826
5884
|
| <code><a href="#mise-projen.Settings.property.dotnet">dotnet</a></code> | <code><a href="#mise-projen.SettingsDotnet">SettingsDotnet</a></code> | *No description.* |
|
|
5827
|
-
| <code><a href="#mise-projen.Settings.property.
|
|
5828
|
-
| <code><a href="#mise-projen.Settings.property.
|
|
5829
|
-
| <code><a href="#mise-projen.Settings.property.
|
|
5830
|
-
| <code><a href="#mise-projen.Settings.property.
|
|
5885
|
+
| <code><a href="#mise-projen.Settings.property.downloadCache">downloadCache</a></code> | <code>boolean</code> | Reuse finished downloads instead of fetching them again. |
|
|
5886
|
+
| <code><a href="#mise-projen.Settings.property.downloadCacheMaxSize">downloadCacheMaxSize</a></code> | <code>string</code> | Maximum total size of the download cache, such as `500MB` or `10GiB`. |
|
|
5887
|
+
| <code><a href="#mise-projen.Settings.property.enableTools">enableTools</a></code> | <code>string[]</code> | Allowlist of configured tools mise uses; |
|
|
5888
|
+
| <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`. |
|
|
5889
|
+
| <code><a href="#mise-projen.Settings.property.envCache">envCache</a></code> | <code>boolean</code> | [experimental] Cache computed environments on disk for nested mise commands. |
|
|
5890
|
+
| <code><a href="#mise-projen.Settings.property.envCacheTtl">envCacheTtl</a></code> | <code>string</code> | How long a cached environment stays valid. |
|
|
5831
5891
|
| <code><a href="#mise-projen.Settings.property.envConfD">envConfD</a></code> | <code>boolean</code> | Enable environment-specific filenames in conf.d directories. |
|
|
5832
|
-
| <code><a href="#mise-projen.Settings.property.envFile">envFile</a></code> | <code>string</code> |
|
|
5833
|
-
| <code><a href="#mise-projen.Settings.property.envShellExpand">envShellExpand</a></code> | <code>boolean</code> |
|
|
5892
|
+
| <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. |
|
|
5893
|
+
| <code><a href="#mise-projen.Settings.property.envShellExpand">envShellExpand</a></code> | <code>boolean</code> | Expand shell-style variables such as `$FOO` and `${BAR:-default}` in `[env]` values. |
|
|
5834
5894
|
| <code><a href="#mise-projen.Settings.property.erlang">erlang</a></code> | <code><a href="#mise-projen.SettingsErlang">SettingsErlang</a></code> | *No description.* |
|
|
5835
|
-
| <code><a href="#mise-projen.Settings.property.execAutoInstall">execAutoInstall</a></code> | <code>boolean</code> |
|
|
5836
|
-
| <code><a href="#mise-projen.Settings.property.experimental">experimental</a></code> | <code>boolean</code> | Enable experimental
|
|
5837
|
-
| <code><a href="#mise-projen.Settings.property.fetchRemoteVersionsCache">fetchRemoteVersionsCache</a></code> | <code>string</code> | How long
|
|
5838
|
-
| <code><a href="#mise-projen.Settings.property.fetchRemoteVersionsTimeout">fetchRemoteVersionsTimeout</a></code> | <code>string</code> | Timeout
|
|
5895
|
+
| <code><a href="#mise-projen.Settings.property.execAutoInstall">execAutoInstall</a></code> | <code>boolean</code> | Install missing tools automatically when you run `mise exec`. |
|
|
5896
|
+
| <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. |
|
|
5897
|
+
| <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. |
|
|
5898
|
+
| <code><a href="#mise-projen.Settings.property.fetchRemoteVersionsTimeout">fetchRemoteVersionsTimeout</a></code> | <code>string</code> | Timeout for looking up a tool's available versions. |
|
|
5839
5899
|
| <code><a href="#mise-projen.Settings.property.forgejo">forgejo</a></code> | <code><a href="#mise-projen.SettingsForgejo">SettingsForgejo</a></code> | *No description.* |
|
|
5840
5900
|
| <code><a href="#mise-projen.Settings.property.github">github</a></code> | <code><a href="#mise-projen.SettingsGithub">SettingsGithub</a></code> | *No description.* |
|
|
5841
|
-
| <code><a href="#mise-projen.Settings.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> |
|
|
5901
|
+
| <code><a href="#mise-projen.Settings.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Verify GitHub artifact attestations for downloads whose publisher provides them. |
|
|
5842
5902
|
| <code><a href="#mise-projen.Settings.property.githubRelay">githubRelay</a></code> | <code><a href="#mise-projen.SettingsGithubRelay">SettingsGithubRelay</a></code> | *No description.* |
|
|
5843
5903
|
| <code><a href="#mise-projen.Settings.property.gitlab">gitlab</a></code> | <code><a href="#mise-projen.SettingsGitlab">SettingsGitlab</a></code> | *No description.* |
|
|
5844
|
-
| <code><a href="#mise-projen.Settings.property.gix">gix</a></code> | <code>boolean</code> |
|
|
5845
|
-
| <code><a href="#mise-projen.Settings.property.globalConfigFile">globalConfigFile</a></code> | <code>string</code> |
|
|
5846
|
-
| <code><a href="#mise-projen.Settings.property.globalConfigRoot">globalConfigRoot</a></code> | <code>string</code> |
|
|
5904
|
+
| <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`. |
|
|
5905
|
+
| <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`. |
|
|
5906
|
+
| <code><a href="#mise-projen.Settings.property.globalConfigRoot">globalConfigRoot</a></code> | <code>string</code> | Directory used as `config_root` for the global config, such as for `{{config_root}}` in templates. |
|
|
5847
5907
|
| <code><a href="#mise-projen.Settings.property.go">go</a></code> | <code><a href="#mise-projen.SettingsGo">SettingsGo</a></code> | *No description.* |
|
|
5848
|
-
| <code><a href="#mise-projen.Settings.property.goDefaultPackagesFile">goDefaultPackagesFile</a></code> | <code>string</code> |
|
|
5849
|
-
| <code><a href="#mise-projen.Settings.property.goDownloadMirror">goDownloadMirror</a></code> | <code>string</code> |
|
|
5850
|
-
| <code><a href="#mise-projen.Settings.property.goRepo">goRepo</a></code> | <code>string</code> |
|
|
5851
|
-
| <code><a href="#mise-projen.Settings.property.goSetGobin">goSetGobin</a></code> | <code>boolean</code> |
|
|
5852
|
-
| <code><a href="#mise-projen.Settings.property.goSetGopath">goSetGopath</a></code> | <code>boolean</code> | [deprecated] Set to
|
|
5853
|
-
| <code><a href="#mise-projen.Settings.property.goSetGoroot">goSetGoroot</a></code> | <code>boolean</code> |
|
|
5854
|
-
| <code><a href="#mise-projen.Settings.property.goSkipChecksum">goSkipChecksum</a></code> | <code>boolean</code> |
|
|
5855
|
-
| <code><a href="#mise-projen.Settings.property.gpgVerify">gpgVerify</a></code> | <code>boolean</code> | Verify OpenPGP signatures
|
|
5908
|
+
| <code><a href="#mise-projen.Settings.property.goDefaultPackagesFile">goDefaultPackagesFile</a></code> | <code>string</code> | File listing Go packages to install with every Go version. |
|
|
5909
|
+
| <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. |
|
|
5910
|
+
| <code><a href="#mise-projen.Settings.property.goRepo">goRepo</a></code> | <code>string</code> | Git repository mise lists Go versions from. |
|
|
5911
|
+
| <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. |
|
|
5912
|
+
| <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. |
|
|
5913
|
+
| <code><a href="#mise-projen.Settings.property.goSetGoroot">goSetGoroot</a></code> | <code>boolean</code> | Set `GOROOT` to the active Go version's install directory. |
|
|
5914
|
+
| <code><a href="#mise-projen.Settings.property.goSkipChecksum">goSkipChecksum</a></code> | <code>boolean</code> | Skip SHA-256 verification of Go downloads. |
|
|
5915
|
+
| <code><a href="#mise-projen.Settings.property.gpgVerify">gpgVerify</a></code> | <code>boolean</code> | Verify OpenPGP signatures of Node.js and Swift downloads. |
|
|
5856
5916
|
| <code><a href="#mise-projen.Settings.property.history">history</a></code> | <code><a href="#mise-projen.SettingsHistory">SettingsHistory</a></code> | *No description.* |
|
|
5857
5917
|
| <code><a href="#mise-projen.Settings.property.hookEnv">hookEnv</a></code> | <code><a href="#mise-projen.SettingsHookEnv">SettingsHookEnv</a></code> | *No description.* |
|
|
5858
|
-
| <code><a href="#mise-projen.Settings.property.httpDownloadTimeout">httpDownloadTimeout</a></code> | <code>string</code> | Total time allowed
|
|
5859
|
-
| <code><a href="#mise-projen.Settings.property.httpRetries">httpRetries</a></code> | <code>number</code> | Number of retries
|
|
5918
|
+
| <code><a href="#mise-projen.Settings.property.httpDownloadTimeout">httpDownloadTimeout</a></code> | <code>string</code> | Total time allowed to download one file, including retries. |
|
|
5919
|
+
| <code><a href="#mise-projen.Settings.property.httpRetries">httpRetries</a></code> | <code>number</code> | Number of retries after a transient HTTP failure. |
|
|
5860
5920
|
| <code><a href="#mise-projen.Settings.property.httpTimeout">httpTimeout</a></code> | <code>string</code> | Timeout for connecting or waiting between reads during HTTP requests. |
|
|
5861
|
-
| <code><a href="#mise-projen.Settings.property.idiomaticVersionFile">idiomaticVersionFile</a></code> | <code>boolean</code> |
|
|
5862
|
-
| <code><a href="#mise-projen.Settings.property.idiomaticVersionFileDisableFiles">idiomaticVersionFileDisableFiles</a></code> | <code>string[]</code> |
|
|
5863
|
-
| <code><a href="#mise-projen.Settings.property.idiomaticVersionFileDisableTools">idiomaticVersionFileDisableTools</a></code> | <code>string[]</code> |
|
|
5864
|
-
| <code><a href="#mise-projen.Settings.property.idiomaticVersionFileEnableTools">idiomaticVersionFileEnableTools</a></code> | <code>string[]</code> |
|
|
5921
|
+
| <code><a href="#mise-projen.Settings.property.idiomaticVersionFile">idiomaticVersionFile</a></code> | <code>boolean</code> | [deprecated] No effect; |
|
|
5922
|
+
| <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. |
|
|
5923
|
+
| <code><a href="#mise-projen.Settings.property.idiomaticVersionFileDisableTools">idiomaticVersionFileDisableTools</a></code> | <code>string[]</code> | [deprecated] No effect; |
|
|
5924
|
+
| <code><a href="#mise-projen.Settings.property.idiomaticVersionFileEnableTools">idiomaticVersionFileEnableTools</a></code> | <code>string[]</code> | Tools that read idiomatic version files such as `.node-version` or `.ruby-version`. |
|
|
5865
5925
|
| <code><a href="#mise-projen.Settings.property.idiomaticVersionFileIgnoreMinimumVersions">idiomaticVersionFileIgnoreMinimumVersions</a></code> | <code>boolean</code> | Ignore idiomatic version file fields that only declare a minimum compatible version. |
|
|
5866
|
-
| <code><a href="#mise-projen.Settings.property.ignoredConfigPaths">ignoredConfigPaths</a></code> | <code>string[]</code> |
|
|
5867
|
-
| <code><a href="#mise-projen.Settings.property.installBefore">installBefore</a></code> | <code>string</code> |
|
|
5926
|
+
| <code><a href="#mise-projen.Settings.property.ignoredConfigPaths">ignoredConfigPaths</a></code> | <code>string[]</code> | Config files and directories mise does not load. |
|
|
5927
|
+
| <code><a href="#mise-projen.Settings.property.installBefore">installBefore</a></code> | <code>string</code> | [deprecated] Install only versions released before this date; |
|
|
5868
5928
|
| <code><a href="#mise-projen.Settings.property.installLayout">installLayout</a></code> | <code><a href="#mise-projen.SettingsInstallLayout">SettingsInstallLayout</a></code> | [experimental] Name installations by what they are (`identity`) instead of `installs/<tool>/<version>` (`legacy`). |
|
|
5869
5929
|
| <code><a href="#mise-projen.Settings.property.java">java</a></code> | <code><a href="#mise-projen.SettingsJava">SettingsJava</a></code> | *No description.* |
|
|
5870
5930
|
| <code><a href="#mise-projen.Settings.property.jobs">jobs</a></code> | <code>number</code> | How many jobs to run concurrently such as tool installs. |
|
|
5871
|
-
| <code><a href="#mise-projen.Settings.property.legacyVersionFile">legacyVersionFile</a></code> | <code>boolean</code> |
|
|
5872
|
-
| <code><a href="#mise-projen.Settings.property.legacyVersionFileDisableTools">legacyVersionFileDisableTools</a></code> | <code>string[]</code> |
|
|
5873
|
-
| <code><a href="#mise-projen.Settings.property.libc">libc</a></code> | <code><a href="#mise-projen.SettingsLibc">SettingsLibc</a></code> | Libc
|
|
5874
|
-
| <code><a href="#mise-projen.Settings.property.libgit2">libgit2</a></code> | <code>boolean</code> |
|
|
5875
|
-
| <code><a href="#mise-projen.Settings.property.locked">locked</a></code> | <code>boolean</code> | Require
|
|
5931
|
+
| <code><a href="#mise-projen.Settings.property.legacyVersionFile">legacyVersionFile</a></code> | <code>boolean</code> | [deprecated] No effect; |
|
|
5932
|
+
| <code><a href="#mise-projen.Settings.property.legacyVersionFileDisableTools">legacyVersionFileDisableTools</a></code> | <code>string[]</code> | [deprecated] No effect; |
|
|
5933
|
+
| <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. |
|
|
5934
|
+
| <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`; |
|
|
5935
|
+
| <code><a href="#mise-projen.Settings.property.locked">locked</a></code> | <code>boolean</code> | Require tool versions and download URLs to come from the lockfile. |
|
|
5876
5936
|
| <code><a href="#mise-projen.Settings.property.lockedScopes">lockedScopes</a></code> | <code><a href="#mise-projen.SettingsLockedScopes">SettingsLockedScopes</a>[]</code> | Config scopes where invocation-wide locked mode is enforced. |
|
|
5877
|
-
| <code><a href="#mise-projen.Settings.property.lockedVerifyProvenance">lockedVerifyProvenance</a></code> | <code>boolean</code> | Re-verify provenance at install time even when the lockfile already
|
|
5878
|
-
| <code><a href="#mise-projen.Settings.property.lockfile">lockfile</a></code> | <code>boolean</code> | Create and
|
|
5937
|
+
| <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. |
|
|
5938
|
+
| <code><a href="#mise-projen.Settings.property.lockfile">lockfile</a></code> | <code>boolean</code> | Create, read and update `mise.lock` lockfiles for tool versions. |
|
|
5879
5939
|
| <code><a href="#mise-projen.Settings.property.lockfileAutoPrune">lockfileAutoPrune</a></code> | <code>boolean</code> | Remove lockfile tools that are absent from the active configuration. |
|
|
5880
|
-
| <code><a href="#mise-projen.Settings.property.lockfileMode">lockfileMode</a></code> | <code><a href="#mise-projen.SettingsLockfileMode">SettingsLockfileMode</a></code> |
|
|
5881
|
-
| <code><a href="#mise-projen.Settings.property.lockfilePlatforms">lockfilePlatforms</a></code> | <code>string[]</code> | Platforms to
|
|
5882
|
-
| <code><a href="#mise-projen.Settings.property.logLevel">logLevel</a></code> | <code><a href="#mise-projen.SettingsLogLevel">SettingsLogLevel</a></code> |
|
|
5883
|
-
| <code><a href="#mise-projen.Settings.property.minimumReleaseAge">minimumReleaseAge</a></code> | <code>string</code> |
|
|
5884
|
-
| <code><a href="#mise-projen.Settings.property.minimumReleaseAgeExcludes">minimumReleaseAgeExcludes</a></code> | <code>string[]</code> | Tools and backends
|
|
5940
|
+
| <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. |
|
|
5941
|
+
| <code><a href="#mise-projen.Settings.property.lockfilePlatforms">lockfilePlatforms</a></code> | <code>string[]</code> | Platforms to resolve lockfile URLs and checksums for. |
|
|
5942
|
+
| <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. |
|
|
5943
|
+
| <code><a href="#mise-projen.Settings.property.minimumReleaseAge">minimumReleaseAge</a></code> | <code>string</code> | Skip versions published more recently than this duration or date. |
|
|
5944
|
+
| <code><a href="#mise-projen.Settings.property.minimumReleaseAgeExcludes">minimumReleaseAgeExcludes</a></code> | <code>string[]</code> | Tools and backends that the configured and default `minimum_release_age` do not apply to. |
|
|
5885
5945
|
| <code><a href="#mise-projen.Settings.property.netrc">netrc</a></code> | <code>boolean</code> | Use a netrc file for HTTP Basic authentication. |
|
|
5886
|
-
| <code><a href="#mise-projen.Settings.property.netrcFile">netrcFile</a></code> | <code>string</code> | Path
|
|
5946
|
+
| <code><a href="#mise-projen.Settings.property.netrcFile">netrcFile</a></code> | <code>string</code> | Path of the netrc file to use instead of `~/.netrc` (`%USERPROFILE%\_netrc` on Windows). |
|
|
5887
5947
|
| <code><a href="#mise-projen.Settings.property.node">node</a></code> | <code><a href="#mise-projen.SettingsNode">SettingsNode</a></code> | *No description.* |
|
|
5888
5948
|
| <code><a href="#mise-projen.Settings.property.noEnv">noEnv</a></code> | <code>boolean</code> | Do not load environment variables from config files. |
|
|
5889
5949
|
| <code><a href="#mise-projen.Settings.property.noHooks">noHooks</a></code> | <code>boolean</code> | Do not execute hooks from config files. |
|
|
5890
|
-
| <code><a href="#mise-projen.Settings.property.notFoundAutoInstall">notFoundAutoInstall</a></code> | <code>boolean</code> |
|
|
5891
|
-
| <code><a href="#mise-projen.Settings.property.notFoundAutoInstallRegistry">notFoundAutoInstallRegistry</a></code> | <code>boolean</code> |
|
|
5892
|
-
| <code><a href="#mise-projen.Settings.property.notFoundSystemFallback">notFoundSystemFallback</a></code> | <code>boolean</code> |
|
|
5950
|
+
| <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. |
|
|
5951
|
+
| <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. |
|
|
5952
|
+
| <code><a href="#mise-projen.Settings.property.notFoundSystemFallback">notFoundSystemFallback</a></code> | <code>boolean</code> | Let a shim run a same-named executable from elsewhere on `PATH` when mise cannot resolve the tool. |
|
|
5893
5953
|
| <code><a href="#mise-projen.Settings.property.npm">npm</a></code> | <code><a href="#mise-projen.SettingsNpm">SettingsNpm</a></code> | *No description.* |
|
|
5894
5954
|
| <code><a href="#mise-projen.Settings.property.oci">oci</a></code> | <code><a href="#mise-projen.SettingsOci">SettingsOci</a></code> | *No description.* |
|
|
5895
|
-
| <code><a href="#mise-projen.Settings.property.offline">offline</a></code> | <code>boolean</code> |
|
|
5896
|
-
| <code><a href="#mise-projen.Settings.property.os">os</a></code> | <code>string</code> |
|
|
5955
|
+
| <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. |
|
|
5956
|
+
| <code><a href="#mise-projen.Settings.property.os">os</a></code> | <code>string</code> | Operating system of the precompiled binaries mise downloads. |
|
|
5897
5957
|
| <code><a href="#mise-projen.Settings.property.otel">otel</a></code> | <code><a href="#mise-projen.SettingsOtel">SettingsOtel</a></code> | *No description.* |
|
|
5898
|
-
| <code><a href="#mise-projen.Settings.property.overrideConfigFilenames">overrideConfigFilenames</a></code> | <code>string[]</code> |
|
|
5899
|
-
| <code><a href="#mise-projen.Settings.property.overrideToolVersionsFilenames">overrideToolVersionsFilenames</a></code> | <code>string[]</code> |
|
|
5958
|
+
| <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. |
|
|
5959
|
+
| <code><a href="#mise-projen.Settings.property.overrideToolVersionsFilenames">overrideToolVersionsFilenames</a></code> | <code>string[]</code> | Filenames that mise reads as `.tool-versions` files instead of `.tool-versions`. |
|
|
5900
5960
|
| <code><a href="#mise-projen.Settings.property.packslip">packslip</a></code> | <code><a href="#mise-projen.SettingsPackslip">SettingsPackslip</a></code> | *No description.* |
|
|
5901
|
-
| <code><a href="#mise-projen.Settings.property.paranoid">paranoid</a></code> | <code>boolean</code> |
|
|
5902
|
-
| <code><a href="#mise-projen.Settings.property.pin">pin</a></code> | <code>boolean</code> |
|
|
5961
|
+
| <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. |
|
|
5962
|
+
| <code><a href="#mise-projen.Settings.property.pin">pin</a></code> | <code>boolean</code> | Make `mise use` write the resolved version, such as `24.14.0` for `node@24`, instead of the requested one. |
|
|
5903
5963
|
| <code><a href="#mise-projen.Settings.property.pipx">pipx</a></code> | <code><a href="#mise-projen.SettingsPipx">SettingsPipx</a></code> | *No description.* |
|
|
5904
|
-
| <code><a href="#mise-projen.Settings.property.pluginAutoupdateLastCheckDuration">pluginAutoupdateLastCheckDuration</a></code> | <code>string</code> |
|
|
5905
|
-
| <code><a href="#mise-projen.Settings.property.preferOffline">preferOffline</a></code> | <code>boolean</code> |
|
|
5906
|
-
| <code><a href="#mise-projen.Settings.property.prereleases">prereleases</a></code> | <code>boolean</code> | Include
|
|
5907
|
-
| <code><a href="#mise-projen.Settings.property.profile">profile</a></code> | <code>string</code> |
|
|
5908
|
-
| <code><a href="#mise-projen.Settings.property.provenanceApiFailuresFatal">provenanceApiFailuresFatal</a></code> | <code>boolean</code> | Fail when provenance API
|
|
5964
|
+
| <code><a href="#mise-projen.Settings.property.pluginAutoupdateLastCheckDuration">pluginAutoupdateLastCheckDuration</a></code> | <code>string</code> | [deprecated] Has no effect; |
|
|
5965
|
+
| <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. |
|
|
5966
|
+
| <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. |
|
|
5967
|
+
| <code><a href="#mise-projen.Settings.property.profile">profile</a></code> | <code>string</code> | Older name for the `env` setting; |
|
|
5968
|
+
| <code><a href="#mise-projen.Settings.property.provenanceApiFailuresFatal">provenanceApiFailuresFatal</a></code> | <code>boolean</code> | Fail an install when a provenance API, such as GitHub's attestation API, cannot be reached or queried. |
|
|
5909
5969
|
| <code><a href="#mise-projen.Settings.property.prune">prune</a></code> | <code><a href="#mise-projen.SettingsPrune">SettingsPrune</a></code> | *No description.* |
|
|
5910
5970
|
| <code><a href="#mise-projen.Settings.property.pypi">pypi</a></code> | <code><a href="#mise-projen.SettingsPypi">SettingsPypi</a></code> | *No description.* |
|
|
5911
5971
|
| <code><a href="#mise-projen.Settings.property.python">python</a></code> | <code><a href="#mise-projen.SettingsPython">SettingsPython</a></code> | *No description.* |
|
|
5912
|
-
| <code><a href="#mise-projen.Settings.property.quiet">quiet</a></code> | <code>boolean</code> |
|
|
5913
|
-
| <code><a href="#mise-projen.Settings.property.raw">raw</a></code> | <code>boolean</code> | Connect stdin
|
|
5914
|
-
| <code><a href="#mise-projen.Settings.property.registryCacheTtl">registryCacheTtl</a></code> | <code>string</code> | How long
|
|
5915
|
-
| <code><a href="#mise-projen.Settings.property.registryFloating">registryFloating</a></code> | <code>boolean</code> |
|
|
5972
|
+
| <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; |
|
|
5973
|
+
| <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. |
|
|
5974
|
+
| <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. |
|
|
5975
|
+
| <code><a href="#mise-projen.Settings.property.registryFloating">registryFloating</a></code> | <code>boolean</code> | Use the latest released mise registry and the current aqua registry, not only the copies built into mise. |
|
|
5916
5976
|
| <code><a href="#mise-projen.Settings.property.ruby">ruby</a></code> | <code><a href="#mise-projen.SettingsRuby">SettingsRuby</a></code> | *No description.* |
|
|
5917
5977
|
| <code><a href="#mise-projen.Settings.property.rust">rust</a></code> | <code><a href="#mise-projen.SettingsRust">SettingsRust</a></code> | *No description.* |
|
|
5918
|
-
| <code><a href="#mise-projen.Settings.property.safe">safe</a></code> | <code>boolean</code> |
|
|
5978
|
+
| <code><a href="#mise-projen.Settings.property.safe">safe</a></code> | <code>boolean</code> | Load project config without letting it run code or change the environment, for automation that reads untrusted config. |
|
|
5919
5979
|
| <code><a href="#mise-projen.Settings.property.sandbox">sandbox</a></code> | <code><a href="#mise-projen.SettingsSandbox">SettingsSandbox</a></code> | *No description.* |
|
|
5920
5980
|
| <code><a href="#mise-projen.Settings.property.selfUpdate">selfUpdate</a></code> | <code><a href="#mise-projen.SettingsSelfUpdate">SettingsSelfUpdate</a></code> | *No description.* |
|
|
5921
|
-
| <code><a href="#mise-projen.Settings.property.sharedInstallDirs">sharedInstallDirs</a></code> | <code>string[]</code> |
|
|
5981
|
+
| <code><a href="#mise-projen.Settings.property.sharedInstallDirs">sharedInstallDirs</a></code> | <code>string[]</code> | Extra read-only directories that mise searches for installed tool versions. |
|
|
5922
5982
|
| <code><a href="#mise-projen.Settings.property.shims">shims</a></code> | <code><a href="#mise-projen.SettingsShims">SettingsShims</a></code> | *No description.* |
|
|
5923
|
-
| <code><a href="#mise-projen.Settings.property.shimsDir">shimsDir</a></code> | <code>string</code> | Directory
|
|
5924
|
-
| <code><a href="#mise-projen.Settings.property.shorthandsFile">shorthandsFile</a></code> | <code>string</code> | [deprecated]
|
|
5925
|
-
| <code><a href="#mise-projen.Settings.property.silent">silent</a></code> | <code>boolean</code> |
|
|
5983
|
+
| <code><a href="#mise-projen.Settings.property.shimsDir">shimsDir</a></code> | <code>string</code> | Directory where mise writes user shims. |
|
|
5984
|
+
| <code><a href="#mise-projen.Settings.property.shorthandsFile">shorthandsFile</a></code> | <code>string</code> | [deprecated] File of custom tool shorthands; |
|
|
5985
|
+
| <code><a href="#mise-projen.Settings.property.silent">silent</a></code> | <code>boolean</code> | Hide all output from `mise run` and `mise watch`, including what tasks print, except errors; |
|
|
5926
5986
|
| <code><a href="#mise-projen.Settings.property.skills">skills</a></code> | <code><a href="#mise-projen.SettingsSkills">SettingsSkills</a></code> | *No description.* |
|
|
5927
|
-
| <code><a href="#mise-projen.Settings.property.slsa">slsa</a></code> | <code>boolean</code> |
|
|
5987
|
+
| <code><a href="#mise-projen.Settings.property.slsa">slsa</a></code> | <code>boolean</code> | Verify SLSA provenance of downloads whose publisher provides it. |
|
|
5928
5988
|
| <code><a href="#mise-projen.Settings.property.sops">sops</a></code> | <code><a href="#mise-projen.SettingsSops">SettingsSops</a></code> | *No description.* |
|
|
5929
5989
|
| <code><a href="#mise-projen.Settings.property.spm">spm</a></code> | <code><a href="#mise-projen.SettingsSpm">SettingsSpm</a></code> | *No description.* |
|
|
5930
5990
|
| <code><a href="#mise-projen.Settings.property.status">status</a></code> | <code><a href="#mise-projen.SettingsStatus">SettingsStatus</a></code> | *No description.* |
|
|
5931
5991
|
| <code><a href="#mise-projen.Settings.property.swift">swift</a></code> | <code><a href="#mise-projen.SettingsSwift">SettingsSwift</a></code> | *No description.* |
|
|
5932
|
-
| <code><a href="#mise-projen.Settings.property.systemConfigFile">systemConfigFile</a></code> | <code>string</code> |
|
|
5933
|
-
| <code><a href="#mise-projen.Settings.property.systemDeps">systemDeps</a></code> | <code><a href="#mise-projen.SettingsSystemDeps">SettingsSystemDeps</a></code> |
|
|
5934
|
-
| <code><a href="#mise-projen.Settings.property.systemInstallsDir">systemInstallsDir</a></code> | <code>string</code> | Directory
|
|
5992
|
+
| <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`. |
|
|
5993
|
+
| <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. |
|
|
5994
|
+
| <code><a href="#mise-projen.Settings.property.systemInstallsDir">systemInstallsDir</a></code> | <code>string</code> | Directory that `mise install --system` installs into. |
|
|
5935
5995
|
| <code><a href="#mise-projen.Settings.property.systemPackages">systemPackages</a></code> | <code><a href="#mise-projen.SettingsSystemPackages">SettingsSystemPackages</a></code> | *No description.* |
|
|
5936
|
-
| <code><a href="#mise-projen.Settings.property.systemShimsDir">systemShimsDir</a></code> | <code>string</code> | Directory
|
|
5996
|
+
| <code><a href="#mise-projen.Settings.property.systemShimsDir">systemShimsDir</a></code> | <code>string</code> | Directory where `mise reshim --system` writes shims for system installs. |
|
|
5937
5997
|
| <code><a href="#mise-projen.Settings.property.task">task</a></code> | <code><a href="#mise-projen.SettingsTask">SettingsTask</a></code> | *No description.* |
|
|
5938
|
-
| <code><a href="#mise-projen.Settings.property.taskDisablePaths">taskDisablePaths</a></code> | <code>string[]</code> |
|
|
5939
|
-
| <code><a href="#mise-projen.Settings.property.taskOutput">taskOutput</a></code> | <code>string</code> |
|
|
5940
|
-
| <code><a href="#mise-projen.Settings.property.taskRemoteNoCache">taskRemoteNoCache</a></code> | <code>boolean</code> |
|
|
5941
|
-
| <code><a href="#mise-projen.Settings.property.taskRunAutoInstall">taskRunAutoInstall</a></code> | <code>boolean</code> |
|
|
5942
|
-
| <code><a href="#mise-projen.Settings.property.taskShowFullCmd">taskShowFullCmd</a></code> | <code>boolean</code> |
|
|
5943
|
-
| <code><a href="#mise-projen.Settings.property.taskSkip">taskSkip</a></code> | <code>string[]</code> |
|
|
5944
|
-
| <code><a href="#mise-projen.Settings.property.taskSkipDepends">taskSkipDepends</a></code> | <code>boolean</code> |
|
|
5945
|
-
| <code><a href="#mise-projen.Settings.property.taskTimeout">taskTimeout</a></code> | <code>string</code> |
|
|
5946
|
-
| <code><a href="#mise-projen.Settings.property.taskTimings">taskTimings</a></code> | <code>boolean</code> |
|
|
5947
|
-
| <code><a href="#mise-projen.Settings.property.teraV1">teraV1</a></code> | <code>boolean</code> |
|
|
5948
|
-
| <code><a href="#mise-projen.Settings.property.terminalProgress">terminalProgress</a></code> | <code>boolean</code> |
|
|
5998
|
+
| <code><a href="#mise-projen.Settings.property.taskDisablePaths">taskDisablePaths</a></code> | <code>string[]</code> | Deprecated alias for `task.disable_paths`. |
|
|
5999
|
+
| <code><a href="#mise-projen.Settings.property.taskOutput">taskOutput</a></code> | <code>string</code> | Deprecated alias for `task.output`. |
|
|
6000
|
+
| <code><a href="#mise-projen.Settings.property.taskRemoteNoCache">taskRemoteNoCache</a></code> | <code>boolean</code> | Deprecated alias for `task.remote_no_cache`. |
|
|
6001
|
+
| <code><a href="#mise-projen.Settings.property.taskRunAutoInstall">taskRunAutoInstall</a></code> | <code>boolean</code> | Deprecated alias for `task.run_auto_install`. |
|
|
6002
|
+
| <code><a href="#mise-projen.Settings.property.taskShowFullCmd">taskShowFullCmd</a></code> | <code>boolean</code> | Deprecated alias for `task.show_full_cmd`. |
|
|
6003
|
+
| <code><a href="#mise-projen.Settings.property.taskSkip">taskSkip</a></code> | <code>string[]</code> | Deprecated alias for `task.skip`. |
|
|
6004
|
+
| <code><a href="#mise-projen.Settings.property.taskSkipDepends">taskSkipDepends</a></code> | <code>boolean</code> | Deprecated alias for `task.skip_depends`. |
|
|
6005
|
+
| <code><a href="#mise-projen.Settings.property.taskTimeout">taskTimeout</a></code> | <code>string</code> | Deprecated alias for `task.timeout`. |
|
|
6006
|
+
| <code><a href="#mise-projen.Settings.property.taskTimings">taskTimings</a></code> | <code>boolean</code> | Deprecated alias for `task.timings`. |
|
|
6007
|
+
| <code><a href="#mise-projen.Settings.property.teraV1">teraV1</a></code> | <code>boolean</code> | [deprecated] Render templates with Tera v1 instead of Tera v2. |
|
|
6008
|
+
| <code><a href="#mise-projen.Settings.property.terminalProgress">terminalProgress</a></code> | <code>boolean</code> | Show install progress in the terminal window's own progress indicator, with OSC 9;4 escape sequences. |
|
|
5949
6009
|
| <code><a href="#mise-projen.Settings.property.toolUpdate">toolUpdate</a></code> | <code><a href="#mise-projen.SettingsToolUpdate">SettingsToolUpdate</a></code> | *No description.* |
|
|
5950
|
-
| <code><a href="#mise-projen.Settings.property.trace">trace</a></code> | <code>boolean</code> |
|
|
6010
|
+
| <code><a href="#mise-projen.Settings.property.trace">trace</a></code> | <code>boolean</code> | Set the log level to trace. |
|
|
5951
6011
|
| <code><a href="#mise-projen.Settings.property.truncate">truncate</a></code> | <code>boolean</code> | Truncate long terminal output to fit the available width. |
|
|
5952
|
-
| <code><a href="#mise-projen.Settings.property.trustedConfigPaths">trustedConfigPaths</a></code> | <code>string[]</code> |
|
|
5953
|
-
| <code><a href="#mise-projen.Settings.property.unixDefaultFileShellArgs">unixDefaultFileShellArgs</a></code> | <code>string</code> |
|
|
5954
|
-
| <code><a href="#mise-projen.Settings.property.unixDefaultInlineShellArgs">unixDefaultInlineShellArgs</a></code> | <code>string</code> |
|
|
6012
|
+
| <code><a href="#mise-projen.Settings.property.trustedConfigPaths">trustedConfigPaths</a></code> | <code>string[]</code> | Directories whose config files mise trusts without asking. |
|
|
6013
|
+
| <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. |
|
|
6014
|
+
| <code><a href="#mise-projen.Settings.property.unixDefaultInlineShellArgs">unixDefaultInlineShellArgs</a></code> | <code>string</code> | Shell and arguments that run inline scripts on Unix, such as a task's `run`, hooks and `postinstall`. |
|
|
5955
6015
|
| <code><a href="#mise-projen.Settings.property.upgrade">upgrade</a></code> | <code><a href="#mise-projen.SettingsUpgrade">SettingsUpgrade</a></code> | *No description.* |
|
|
5956
|
-
| <code><a href="#mise-projen.Settings.property.urlReplacements">urlReplacements</a></code> | <code>{[ key: string ]: string}</code> |
|
|
5957
|
-
| <code><a href="#mise-projen.Settings.property.useFileShellForExecutableTasks">useFileShellForExecutableTasks</a></code> | <code>boolean</code> |
|
|
5958
|
-
| <code><a href="#mise-projen.Settings.property.useVersionsHost">useVersionsHost</a></code> | <code>boolean</code> |
|
|
5959
|
-
| <code><a href="#mise-projen.Settings.property.useVersionsHostTrack">useVersionsHostTrack</a></code> | <code>boolean</code> | Send anonymous download statistics
|
|
5960
|
-
| <code><a href="#mise-projen.Settings.property.verbose">verbose</a></code> | <code>boolean</code> |
|
|
5961
|
-
| <code><a href="#mise-projen.Settings.property.windowsDefaultFileShellArgs">windowsDefaultFileShellArgs</a></code> | <code>string</code> |
|
|
5962
|
-
| <code><a href="#mise-projen.Settings.property.windowsDefaultInlineShellArgs">windowsDefaultInlineShellArgs</a></code> | <code>string</code> |
|
|
5963
|
-
| <code><a href="#mise-projen.Settings.property.windowsExecutableExtensions">windowsExecutableExtensions</a></code> | <code>string[]</code> |
|
|
5964
|
-
| <code><a href="#mise-projen.Settings.property.windowsPowershellNoProfile">windowsPowershellNoProfile</a></code> | <code>boolean</code> | Pass `-NoProfile` to PowerShell (`pwsh
|
|
5965
|
-
| <code><a href="#mise-projen.Settings.property.windowsShimMode">windowsShimMode</a></code> | <code>
|
|
6016
|
+
| <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. |
|
|
6017
|
+
| <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. |
|
|
6018
|
+
| <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. |
|
|
6019
|
+
| <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. |
|
|
6020
|
+
| <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; |
|
|
6021
|
+
| <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. |
|
|
6022
|
+
| <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`. |
|
|
6023
|
+
| <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. |
|
|
6024
|
+
| <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. |
|
|
6025
|
+
| <code><a href="#mise-projen.Settings.property.windowsShimMode">windowsShimMode</a></code> | <code><a href="#mise-projen.SettingsWindowsShimMode">SettingsWindowsShimMode</a></code> | How mise creates shims on Windows. |
|
|
5966
6026
|
| <code><a href="#mise-projen.Settings.property.writeTargets">writeTargets</a></code> | <code><a href="#mise-projen.SettingsWriteTargets">SettingsWriteTargets</a></code> | *No description.* |
|
|
5967
|
-
| <code><a href="#mise-projen.Settings.property.yes">yes</a></code> | <code>boolean</code> |
|
|
6027
|
+
| <code><a href="#mise-projen.Settings.property.yes">yes</a></code> | <code>boolean</code> | Answer yes to every confirmation prompt, as `--yes` does. |
|
|
5968
6028
|
| <code><a href="#mise-projen.Settings.property.zig">zig</a></code> | <code><a href="#mise-projen.SettingsZig">SettingsZig</a></code> | *No description.* |
|
|
5969
6029
|
|
|
5970
6030
|
---
|
|
@@ -5977,7 +6037,7 @@ public readonly activateAggressive: boolean;
|
|
|
5977
6037
|
|
|
5978
6038
|
- *Type:* boolean
|
|
5979
6039
|
|
|
5980
|
-
|
|
6040
|
+
Keep mise's tool directories ahead of `PATH` entries added after `mise activate`.
|
|
5981
6041
|
|
|
5982
6042
|
---
|
|
5983
6043
|
|
|
@@ -5989,7 +6049,7 @@ public readonly activateShims: boolean;
|
|
|
5989
6049
|
|
|
5990
6050
|
- *Type:* boolean
|
|
5991
6051
|
|
|
5992
|
-
|
|
6052
|
+
Let `mise activate` add the shims directories to `PATH` for auto-install and lazy tools.
|
|
5993
6053
|
|
|
5994
6054
|
---
|
|
5995
6055
|
|
|
@@ -6011,7 +6071,7 @@ public readonly allCompile: boolean;
|
|
|
6011
6071
|
|
|
6012
6072
|
- *Type:* boolean
|
|
6013
6073
|
|
|
6014
|
-
|
|
6074
|
+
Compile Node.js, Python, Ruby and Erlang from source instead of using precompiled builds.
|
|
6015
6075
|
|
|
6016
6076
|
---
|
|
6017
6077
|
|
|
@@ -6023,7 +6083,7 @@ public readonly alwaysKeepDownload: boolean;
|
|
|
6023
6083
|
|
|
6024
6084
|
- *Type:* boolean
|
|
6025
6085
|
|
|
6026
|
-
|
|
6086
|
+
[deprecated] Keep downloaded archives and sources after installing, for debugging.
|
|
6027
6087
|
|
|
6028
6088
|
---
|
|
6029
6089
|
|
|
@@ -6035,7 +6095,7 @@ public readonly alwaysKeepInstall: boolean;
|
|
|
6035
6095
|
|
|
6036
6096
|
- *Type:* boolean
|
|
6037
6097
|
|
|
6038
|
-
|
|
6098
|
+
Keep a failed installation's partial install directory and downloads, for debugging.
|
|
6039
6099
|
|
|
6040
6100
|
---
|
|
6041
6101
|
|
|
@@ -6057,7 +6117,7 @@ public readonly arch: string;
|
|
|
6057
6117
|
|
|
6058
6118
|
- *Type:* string
|
|
6059
6119
|
|
|
6060
|
-
Architecture
|
|
6120
|
+
Architecture of the precompiled binaries mise downloads.
|
|
6061
6121
|
|
|
6062
6122
|
---
|
|
6063
6123
|
|
|
@@ -6069,7 +6129,7 @@ public readonly asdfCompat: boolean;
|
|
|
6069
6129
|
|
|
6070
6130
|
- *Type:* boolean
|
|
6071
6131
|
|
|
6072
|
-
|
|
6132
|
+
Write `.tool-versions` files that asdf can read, with exact versions.
|
|
6073
6133
|
|
|
6074
6134
|
---
|
|
6075
6135
|
|
|
@@ -6093,7 +6153,7 @@ public readonly autoInstall: boolean;
|
|
|
6093
6153
|
|
|
6094
6154
|
- *Type:* boolean
|
|
6095
6155
|
|
|
6096
|
-
|
|
6156
|
+
Install missing tools automatically when a command needs them.
|
|
6097
6157
|
|
|
6098
6158
|
---
|
|
6099
6159
|
|
|
@@ -6105,7 +6165,7 @@ public readonly autoInstallDisableTools: string[];
|
|
|
6105
6165
|
|
|
6106
6166
|
- *Type:* string[]
|
|
6107
6167
|
|
|
6108
|
-
|
|
6168
|
+
Tools that automatic installs skip, such as `node`.
|
|
6109
6169
|
|
|
6110
6170
|
---
|
|
6111
6171
|
|
|
@@ -6117,7 +6177,7 @@ public readonly autoUpdate: boolean;
|
|
|
6117
6177
|
|
|
6118
6178
|
- *Type:* boolean
|
|
6119
6179
|
|
|
6120
|
-
[deprecated]
|
|
6180
|
+
[deprecated] Old name for `self_update.auto`.
|
|
6121
6181
|
|
|
6122
6182
|
---
|
|
6123
6183
|
|
|
@@ -6129,7 +6189,7 @@ public readonly autoUpdateCheckDuration: string;
|
|
|
6129
6189
|
|
|
6130
6190
|
- *Type:* string
|
|
6131
6191
|
|
|
6132
|
-
[deprecated]
|
|
6192
|
+
[deprecated] Old name for `self_update.check_duration`.
|
|
6133
6193
|
|
|
6134
6194
|
---
|
|
6135
6195
|
|
|
@@ -6141,7 +6201,7 @@ public readonly cachePruneAge: string;
|
|
|
6141
6201
|
|
|
6142
6202
|
- *Type:* string
|
|
6143
6203
|
|
|
6144
|
-
Delete files
|
|
6204
|
+
Delete cache files that have not been accessed for this long.
|
|
6145
6205
|
|
|
6146
6206
|
---
|
|
6147
6207
|
|
|
@@ -6163,7 +6223,7 @@ public readonly cd: string;
|
|
|
6163
6223
|
|
|
6164
6224
|
- *Type:* string
|
|
6165
6225
|
|
|
6166
|
-
|
|
6226
|
+
Directory to change to after mise starts.
|
|
6167
6227
|
|
|
6168
6228
|
---
|
|
6169
6229
|
|
|
@@ -6175,7 +6235,7 @@ public readonly ceilingPaths: string[];
|
|
|
6175
6235
|
|
|
6176
6236
|
- *Type:* string[]
|
|
6177
6237
|
|
|
6178
|
-
Directories where mise stops searching for config files.
|
|
6238
|
+
Directories where mise stops searching parent directories for config files.
|
|
6179
6239
|
|
|
6180
6240
|
---
|
|
6181
6241
|
|
|
@@ -6187,7 +6247,9 @@ public readonly ci: boolean;
|
|
|
6187
6247
|
|
|
6188
6248
|
- *Type:* boolean
|
|
6189
6249
|
|
|
6190
|
-
|
|
6250
|
+
Behave as in CI, which answers yes to confirmation prompts;
|
|
6251
|
+
|
|
6252
|
+
read from the `CI` variable.
|
|
6191
6253
|
|
|
6192
6254
|
---
|
|
6193
6255
|
|
|
@@ -6199,7 +6261,7 @@ public readonly color: boolean;
|
|
|
6199
6261
|
|
|
6200
6262
|
- *Type:* boolean
|
|
6201
6263
|
|
|
6202
|
-
Use color in mise terminal output.
|
|
6264
|
+
Use color in mise's terminal output.
|
|
6203
6265
|
|
|
6204
6266
|
---
|
|
6205
6267
|
|
|
@@ -6211,7 +6273,7 @@ public readonly colorTheme: SettingsColorTheme;
|
|
|
6211
6273
|
|
|
6212
6274
|
- *Type:* <a href="#mise-projen.SettingsColorTheme">SettingsColorTheme</a>
|
|
6213
6275
|
|
|
6214
|
-
|
|
6276
|
+
Color theme for interactive prompts, such as the task picker in `mise run`.
|
|
6215
6277
|
|
|
6216
6278
|
---
|
|
6217
6279
|
|
|
@@ -6233,7 +6295,7 @@ public readonly debug: boolean;
|
|
|
6233
6295
|
|
|
6234
6296
|
- *Type:* boolean
|
|
6235
6297
|
|
|
6236
|
-
|
|
6298
|
+
Set the log level to debug.
|
|
6237
6299
|
|
|
6238
6300
|
---
|
|
6239
6301
|
|
|
@@ -6245,9 +6307,7 @@ public readonly defaultConfigFilename: string;
|
|
|
6245
6307
|
|
|
6246
6308
|
- *Type:* string
|
|
6247
6309
|
|
|
6248
|
-
|
|
6249
|
-
|
|
6250
|
-
`mise use` and other commands that create new config files will use this value. This must be an env var.
|
|
6310
|
+
Extra project config filename mise reads, and the name it gives new config files.
|
|
6251
6311
|
|
|
6252
6312
|
---
|
|
6253
6313
|
|
|
@@ -6259,7 +6319,7 @@ public readonly defaultToolVersionsFilename: string;
|
|
|
6259
6319
|
|
|
6260
6320
|
- *Type:* string
|
|
6261
6321
|
|
|
6262
|
-
|
|
6322
|
+
Extra filename mise reads as a `.tool-versions` file.
|
|
6263
6323
|
|
|
6264
6324
|
---
|
|
6265
6325
|
|
|
@@ -6271,9 +6331,7 @@ public readonly disableBackends: string[];
|
|
|
6271
6331
|
|
|
6272
6332
|
- *Type:* string[]
|
|
6273
6333
|
|
|
6274
|
-
Backends
|
|
6275
|
-
|
|
6276
|
-
Existing installations are left on disk and become available again if the backend is re-enabled.
|
|
6334
|
+
Backends mise ignores when resolving and installing tools, such as `asdf` or `pypi`.
|
|
6277
6335
|
|
|
6278
6336
|
---
|
|
6279
6337
|
|
|
@@ -6285,9 +6343,7 @@ public readonly disableDefaultRegistry: boolean;
|
|
|
6285
6343
|
|
|
6286
6344
|
- *Type:* boolean
|
|
6287
6345
|
|
|
6288
|
-
|
|
6289
|
-
|
|
6290
|
-
This parameter disables only for the backends `vfox` and `asdf`.
|
|
6346
|
+
Stop mapping short names such as `php` to the asdf and vfox plugins listed in the registry.
|
|
6291
6347
|
|
|
6292
6348
|
---
|
|
6293
6349
|
|
|
@@ -6299,7 +6355,9 @@ public readonly disableHints: string[];
|
|
|
6299
6355
|
|
|
6300
6356
|
- *Type:* string[]
|
|
6301
6357
|
|
|
6302
|
-
|
|
6358
|
+
Hints to stop showing, by ID;
|
|
6359
|
+
|
|
6360
|
+
`*` turns off every hint.
|
|
6303
6361
|
|
|
6304
6362
|
---
|
|
6305
6363
|
|
|
@@ -6311,7 +6369,7 @@ public readonly disableTools: string[];
|
|
|
6311
6369
|
|
|
6312
6370
|
- *Type:* string[]
|
|
6313
6371
|
|
|
6314
|
-
Tools
|
|
6372
|
+
Tools mise ignores even when a config file lists them.
|
|
6315
6373
|
|
|
6316
6374
|
---
|
|
6317
6375
|
|
|
@@ -6347,6 +6405,30 @@ public readonly dotnet: SettingsDotnet;
|
|
|
6347
6405
|
|
|
6348
6406
|
---
|
|
6349
6407
|
|
|
6408
|
+
##### `downloadCache`<sup>Optional</sup> <a name="downloadCache" id="mise-projen.Settings.property.downloadCache"></a>
|
|
6409
|
+
|
|
6410
|
+
```typescript
|
|
6411
|
+
public readonly downloadCache: boolean;
|
|
6412
|
+
```
|
|
6413
|
+
|
|
6414
|
+
- *Type:* boolean
|
|
6415
|
+
|
|
6416
|
+
Reuse finished downloads instead of fetching them again.
|
|
6417
|
+
|
|
6418
|
+
---
|
|
6419
|
+
|
|
6420
|
+
##### `downloadCacheMaxSize`<sup>Optional</sup> <a name="downloadCacheMaxSize" id="mise-projen.Settings.property.downloadCacheMaxSize"></a>
|
|
6421
|
+
|
|
6422
|
+
```typescript
|
|
6423
|
+
public readonly downloadCacheMaxSize: string;
|
|
6424
|
+
```
|
|
6425
|
+
|
|
6426
|
+
- *Type:* string
|
|
6427
|
+
|
|
6428
|
+
Maximum total size of the download cache, such as `500MB` or `10GiB`.
|
|
6429
|
+
|
|
6430
|
+
---
|
|
6431
|
+
|
|
6350
6432
|
##### `enableTools`<sup>Optional</sup> <a name="enableTools" id="mise-projen.Settings.property.enableTools"></a>
|
|
6351
6433
|
|
|
6352
6434
|
```typescript
|
|
@@ -6355,7 +6437,9 @@ public readonly enableTools: string[];
|
|
|
6355
6437
|
|
|
6356
6438
|
- *Type:* string[]
|
|
6357
6439
|
|
|
6358
|
-
|
|
6440
|
+
Allowlist of configured tools mise uses;
|
|
6441
|
+
|
|
6442
|
+
other tools are ignored.
|
|
6359
6443
|
|
|
6360
6444
|
---
|
|
6361
6445
|
|
|
@@ -6367,7 +6451,7 @@ public readonly env: string[];
|
|
|
6367
6451
|
|
|
6368
6452
|
- *Type:* string[]
|
|
6369
6453
|
|
|
6370
|
-
|
|
6454
|
+
Config environments to load, such as `development` for `mise.development.toml`.
|
|
6371
6455
|
|
|
6372
6456
|
---
|
|
6373
6457
|
|
|
@@ -6379,7 +6463,7 @@ public readonly envCache: boolean;
|
|
|
6379
6463
|
|
|
6380
6464
|
- *Type:* boolean
|
|
6381
6465
|
|
|
6382
|
-
[experimental]
|
|
6466
|
+
[experimental] Cache computed environments on disk for nested mise commands.
|
|
6383
6467
|
|
|
6384
6468
|
---
|
|
6385
6469
|
|
|
@@ -6391,7 +6475,7 @@ public readonly envCacheTtl: string;
|
|
|
6391
6475
|
|
|
6392
6476
|
- *Type:* string
|
|
6393
6477
|
|
|
6394
|
-
|
|
6478
|
+
How long a cached environment stays valid.
|
|
6395
6479
|
|
|
6396
6480
|
---
|
|
6397
6481
|
|
|
@@ -6415,7 +6499,7 @@ public readonly envFile: string;
|
|
|
6415
6499
|
|
|
6416
6500
|
- *Type:* string
|
|
6417
6501
|
|
|
6418
|
-
|
|
6502
|
+
Dotenv file name to load from the current directory and each parent directory.
|
|
6419
6503
|
|
|
6420
6504
|
---
|
|
6421
6505
|
|
|
@@ -6427,7 +6511,7 @@ public readonly envShellExpand: boolean;
|
|
|
6427
6511
|
|
|
6428
6512
|
- *Type:* boolean
|
|
6429
6513
|
|
|
6430
|
-
|
|
6514
|
+
Expand shell-style variables such as `$FOO` and `${BAR:-default}` in `[env]` values.
|
|
6431
6515
|
|
|
6432
6516
|
---
|
|
6433
6517
|
|
|
@@ -6449,7 +6533,7 @@ public readonly execAutoInstall: boolean;
|
|
|
6449
6533
|
|
|
6450
6534
|
- *Type:* boolean
|
|
6451
6535
|
|
|
6452
|
-
|
|
6536
|
+
Install missing tools automatically when you run `mise exec`.
|
|
6453
6537
|
|
|
6454
6538
|
---
|
|
6455
6539
|
|
|
@@ -6461,7 +6545,7 @@ public readonly experimental: boolean;
|
|
|
6461
6545
|
|
|
6462
6546
|
- *Type:* boolean
|
|
6463
6547
|
|
|
6464
|
-
Enable experimental
|
|
6548
|
+
Enable experimental features, which may change or be removed in any release.
|
|
6465
6549
|
|
|
6466
6550
|
---
|
|
6467
6551
|
|
|
@@ -6473,7 +6557,7 @@ public readonly fetchRemoteVersionsCache: string;
|
|
|
6473
6557
|
|
|
6474
6558
|
- *Type:* string
|
|
6475
6559
|
|
|
6476
|
-
How long
|
|
6560
|
+
How long a tool's cached list of available versions stays fresh.
|
|
6477
6561
|
|
|
6478
6562
|
---
|
|
6479
6563
|
|
|
@@ -6485,7 +6569,7 @@ public readonly fetchRemoteVersionsTimeout: string;
|
|
|
6485
6569
|
|
|
6486
6570
|
- *Type:* string
|
|
6487
6571
|
|
|
6488
|
-
Timeout
|
|
6572
|
+
Timeout for looking up a tool's available versions.
|
|
6489
6573
|
|
|
6490
6574
|
---
|
|
6491
6575
|
|
|
@@ -6517,7 +6601,7 @@ public readonly githubAttestations: boolean;
|
|
|
6517
6601
|
|
|
6518
6602
|
- *Type:* boolean
|
|
6519
6603
|
|
|
6520
|
-
|
|
6604
|
+
Verify GitHub artifact attestations for downloads whose publisher provides them.
|
|
6521
6605
|
|
|
6522
6606
|
---
|
|
6523
6607
|
|
|
@@ -6549,7 +6633,7 @@ public readonly gix: boolean;
|
|
|
6549
6633
|
|
|
6550
6634
|
- *Type:* boolean
|
|
6551
6635
|
|
|
6552
|
-
|
|
6636
|
+
Clone Git repositories with the built-in gix library instead of running `git`.
|
|
6553
6637
|
|
|
6554
6638
|
---
|
|
6555
6639
|
|
|
@@ -6560,11 +6644,8 @@ public readonly globalConfigFile: string;
|
|
|
6560
6644
|
```
|
|
6561
6645
|
|
|
6562
6646
|
- *Type:* string
|
|
6563
|
-
- *Default:* config/mise/config.toml`. This must be an env var.
|
|
6564
6647
|
|
|
6565
|
-
|
|
6566
|
-
|
|
6567
|
-
Default is `~/.config/mise/config.toml`. This must be an env var.
|
|
6648
|
+
One file to use as the global config instead of the config files in `~/.config/mise`.
|
|
6568
6649
|
|
|
6569
6650
|
---
|
|
6570
6651
|
|
|
@@ -6575,11 +6656,8 @@ public readonly globalConfigRoot: string;
|
|
|
6575
6656
|
```
|
|
6576
6657
|
|
|
6577
6658
|
- *Type:* string
|
|
6578
|
-
- *Default:* HOME`. This must be an env var.
|
|
6579
|
-
|
|
6580
|
-
Path which is used as `{{config_root}}` for the global config file.
|
|
6581
6659
|
|
|
6582
|
-
|
|
6660
|
+
Directory used as `config_root` for the global config, such as for `{{config_root}}` in templates.
|
|
6583
6661
|
|
|
6584
6662
|
---
|
|
6585
6663
|
|
|
@@ -6601,7 +6679,7 @@ public readonly goDefaultPackagesFile: string;
|
|
|
6601
6679
|
|
|
6602
6680
|
- *Type:* string
|
|
6603
6681
|
|
|
6604
|
-
|
|
6682
|
+
File listing Go packages to install with every Go version.
|
|
6605
6683
|
|
|
6606
6684
|
---
|
|
6607
6685
|
|
|
@@ -6613,7 +6691,7 @@ public readonly goDownloadMirror: string;
|
|
|
6613
6691
|
|
|
6614
6692
|
- *Type:* string
|
|
6615
6693
|
|
|
6616
|
-
|
|
6694
|
+
Base URL that mise downloads Go archives and their checksums from.
|
|
6617
6695
|
|
|
6618
6696
|
---
|
|
6619
6697
|
|
|
@@ -6625,7 +6703,7 @@ public readonly goRepo: string;
|
|
|
6625
6703
|
|
|
6626
6704
|
- *Type:* string
|
|
6627
6705
|
|
|
6628
|
-
|
|
6706
|
+
Git repository mise lists Go versions from.
|
|
6629
6707
|
|
|
6630
6708
|
---
|
|
6631
6709
|
|
|
@@ -6637,7 +6715,7 @@ public readonly goSetGobin: boolean;
|
|
|
6637
6715
|
|
|
6638
6716
|
- *Type:* boolean
|
|
6639
6717
|
|
|
6640
|
-
|
|
6718
|
+
Set `GOBIN` so `go install` puts binaries in the active Go version's directory.
|
|
6641
6719
|
|
|
6642
6720
|
---
|
|
6643
6721
|
|
|
@@ -6649,7 +6727,7 @@ public readonly goSetGopath: boolean;
|
|
|
6649
6727
|
|
|
6650
6728
|
- *Type:* boolean
|
|
6651
6729
|
|
|
6652
|
-
[deprecated] Set to
|
|
6730
|
+
[deprecated] Set `GOPATH` to the `packages` directory inside the active Go install.
|
|
6653
6731
|
|
|
6654
6732
|
---
|
|
6655
6733
|
|
|
@@ -6661,7 +6739,7 @@ public readonly goSetGoroot: boolean;
|
|
|
6661
6739
|
|
|
6662
6740
|
- *Type:* boolean
|
|
6663
6741
|
|
|
6664
|
-
|
|
6742
|
+
Set `GOROOT` to the active Go version's install directory.
|
|
6665
6743
|
|
|
6666
6744
|
---
|
|
6667
6745
|
|
|
@@ -6673,7 +6751,7 @@ public readonly goSkipChecksum: boolean;
|
|
|
6673
6751
|
|
|
6674
6752
|
- *Type:* boolean
|
|
6675
6753
|
|
|
6676
|
-
|
|
6754
|
+
Skip SHA-256 verification of Go downloads.
|
|
6677
6755
|
|
|
6678
6756
|
---
|
|
6679
6757
|
|
|
@@ -6685,9 +6763,7 @@ public readonly gpgVerify: boolean;
|
|
|
6685
6763
|
|
|
6686
6764
|
- *Type:* boolean
|
|
6687
6765
|
|
|
6688
|
-
Verify OpenPGP signatures
|
|
6689
|
-
|
|
6690
|
-
Set to false to disable.
|
|
6766
|
+
Verify OpenPGP signatures of Node.js and Swift downloads.
|
|
6691
6767
|
|
|
6692
6768
|
---
|
|
6693
6769
|
|
|
@@ -6719,7 +6795,7 @@ public readonly httpDownloadTimeout: string;
|
|
|
6719
6795
|
|
|
6720
6796
|
- *Type:* string
|
|
6721
6797
|
|
|
6722
|
-
Total time allowed
|
|
6798
|
+
Total time allowed to download one file, including retries.
|
|
6723
6799
|
|
|
6724
6800
|
---
|
|
6725
6801
|
|
|
@@ -6731,7 +6807,7 @@ public readonly httpRetries: number;
|
|
|
6731
6807
|
|
|
6732
6808
|
- *Type:* number
|
|
6733
6809
|
|
|
6734
|
-
Number of retries
|
|
6810
|
+
Number of retries after a transient HTTP failure.
|
|
6735
6811
|
|
|
6736
6812
|
---
|
|
6737
6813
|
|
|
@@ -6755,7 +6831,9 @@ public readonly idiomaticVersionFile: boolean;
|
|
|
6755
6831
|
|
|
6756
6832
|
- *Type:* boolean
|
|
6757
6833
|
|
|
6758
|
-
|
|
6834
|
+
[deprecated] No effect;
|
|
6835
|
+
|
|
6836
|
+
enable idiomatic version files per tool with `idiomatic_version_file_enable_tools`.
|
|
6759
6837
|
|
|
6760
6838
|
---
|
|
6761
6839
|
|
|
@@ -6767,7 +6845,7 @@ public readonly idiomaticVersionFileDisableFiles: string[];
|
|
|
6767
6845
|
|
|
6768
6846
|
- *Type:* string[]
|
|
6769
6847
|
|
|
6770
|
-
|
|
6848
|
+
Idiomatic version files to ignore for one tool, as `tool:filename` pairs.
|
|
6771
6849
|
|
|
6772
6850
|
---
|
|
6773
6851
|
|
|
@@ -6779,7 +6857,9 @@ public readonly idiomaticVersionFileDisableTools: string[];
|
|
|
6779
6857
|
|
|
6780
6858
|
- *Type:* string[]
|
|
6781
6859
|
|
|
6782
|
-
|
|
6860
|
+
[deprecated] No effect;
|
|
6861
|
+
|
|
6862
|
+
idiomatic version files are off unless enabled with `idiomatic_version_file_enable_tools`.
|
|
6783
6863
|
|
|
6784
6864
|
---
|
|
6785
6865
|
|
|
@@ -6791,7 +6871,7 @@ public readonly idiomaticVersionFileEnableTools: string[];
|
|
|
6791
6871
|
|
|
6792
6872
|
- *Type:* string[]
|
|
6793
6873
|
|
|
6794
|
-
|
|
6874
|
+
Tools that read idiomatic version files such as `.node-version` or `.ruby-version`.
|
|
6795
6875
|
|
|
6796
6876
|
---
|
|
6797
6877
|
|
|
@@ -6815,7 +6895,7 @@ public readonly ignoredConfigPaths: string[];
|
|
|
6815
6895
|
|
|
6816
6896
|
- *Type:* string[]
|
|
6817
6897
|
|
|
6818
|
-
|
|
6898
|
+
Config files and directories mise does not load.
|
|
6819
6899
|
|
|
6820
6900
|
---
|
|
6821
6901
|
|
|
@@ -6827,7 +6907,9 @@ public readonly installBefore: string;
|
|
|
6827
6907
|
|
|
6828
6908
|
- *Type:* string
|
|
6829
6909
|
|
|
6830
|
-
|
|
6910
|
+
[deprecated] Install only versions released before this date;
|
|
6911
|
+
|
|
6912
|
+
use `minimum_release_age` instead.
|
|
6831
6913
|
|
|
6832
6914
|
---
|
|
6833
6915
|
|
|
@@ -6875,7 +6957,9 @@ public readonly legacyVersionFile: boolean;
|
|
|
6875
6957
|
|
|
6876
6958
|
- *Type:* boolean
|
|
6877
6959
|
|
|
6878
|
-
|
|
6960
|
+
[deprecated] No effect;
|
|
6961
|
+
|
|
6962
|
+
enable idiomatic version files per tool with `idiomatic_version_file_enable_tools`.
|
|
6879
6963
|
|
|
6880
6964
|
---
|
|
6881
6965
|
|
|
@@ -6887,7 +6971,9 @@ public readonly legacyVersionFileDisableTools: string[];
|
|
|
6887
6971
|
|
|
6888
6972
|
- *Type:* string[]
|
|
6889
6973
|
|
|
6890
|
-
|
|
6974
|
+
[deprecated] No effect;
|
|
6975
|
+
|
|
6976
|
+
idiomatic version files are off unless enabled with `idiomatic_version_file_enable_tools`.
|
|
6891
6977
|
|
|
6892
6978
|
---
|
|
6893
6979
|
|
|
@@ -6899,7 +6985,7 @@ public readonly libc: SettingsLibc;
|
|
|
6899
6985
|
|
|
6900
6986
|
- *Type:* <a href="#mise-projen.SettingsLibc">SettingsLibc</a>
|
|
6901
6987
|
|
|
6902
|
-
Libc
|
|
6988
|
+
Libc build to install on Linux when a tool publishes both glibc and musl builds.
|
|
6903
6989
|
|
|
6904
6990
|
---
|
|
6905
6991
|
|
|
@@ -6911,7 +6997,9 @@ public readonly libgit2: boolean;
|
|
|
6911
6997
|
|
|
6912
6998
|
- *Type:* boolean
|
|
6913
6999
|
|
|
6914
|
-
|
|
7000
|
+
Clone Git repositories with the built-in gix library instead of running `git`;
|
|
7001
|
+
|
|
7002
|
+
same as `gix`.
|
|
6915
7003
|
|
|
6916
7004
|
---
|
|
6917
7005
|
|
|
@@ -6923,7 +7011,7 @@ public readonly locked: boolean;
|
|
|
6923
7011
|
|
|
6924
7012
|
- *Type:* boolean
|
|
6925
7013
|
|
|
6926
|
-
Require
|
|
7014
|
+
Require tool versions and download URLs to come from the lockfile.
|
|
6927
7015
|
|
|
6928
7016
|
---
|
|
6929
7017
|
|
|
@@ -6947,7 +7035,7 @@ public readonly lockedVerifyProvenance: boolean;
|
|
|
6947
7035
|
|
|
6948
7036
|
- *Type:* boolean
|
|
6949
7037
|
|
|
6950
|
-
Re-verify provenance at install time even when the lockfile already
|
|
7038
|
+
Re-verify provenance at install time even when the lockfile already records it.
|
|
6951
7039
|
|
|
6952
7040
|
---
|
|
6953
7041
|
|
|
@@ -6959,7 +7047,7 @@ public readonly lockfile: boolean;
|
|
|
6959
7047
|
|
|
6960
7048
|
- *Type:* boolean
|
|
6961
7049
|
|
|
6962
|
-
Create and
|
|
7050
|
+
Create, read and update `mise.lock` lockfiles for tool versions.
|
|
6963
7051
|
|
|
6964
7052
|
---
|
|
6965
7053
|
|
|
@@ -6983,7 +7071,7 @@ public readonly lockfileMode: SettingsLockfileMode;
|
|
|
6983
7071
|
|
|
6984
7072
|
- *Type:* <a href="#mise-projen.SettingsLockfileMode">SettingsLockfileMode</a>
|
|
6985
7073
|
|
|
6986
|
-
|
|
7074
|
+
How lockfiles are written: entry by entry, or rebuilt from the current requests.
|
|
6987
7075
|
|
|
6988
7076
|
---
|
|
6989
7077
|
|
|
@@ -6995,7 +7083,7 @@ public readonly lockfilePlatforms: string[];
|
|
|
6995
7083
|
|
|
6996
7084
|
- *Type:* string[]
|
|
6997
7085
|
|
|
6998
|
-
Platforms to
|
|
7086
|
+
Platforms to resolve lockfile URLs and checksums for.
|
|
6999
7087
|
|
|
7000
7088
|
---
|
|
7001
7089
|
|
|
@@ -7007,7 +7095,7 @@ public readonly logLevel: SettingsLogLevel;
|
|
|
7007
7095
|
|
|
7008
7096
|
- *Type:* <a href="#mise-projen.SettingsLogLevel">SettingsLogLevel</a>
|
|
7009
7097
|
|
|
7010
|
-
|
|
7098
|
+
Log level for mise's own output.
|
|
7011
7099
|
|
|
7012
7100
|
---
|
|
7013
7101
|
|
|
@@ -7019,7 +7107,7 @@ public readonly minimumReleaseAge: string;
|
|
|
7019
7107
|
|
|
7020
7108
|
- *Type:* string
|
|
7021
7109
|
|
|
7022
|
-
|
|
7110
|
+
Skip versions published more recently than this duration or date.
|
|
7023
7111
|
|
|
7024
7112
|
---
|
|
7025
7113
|
|
|
@@ -7031,7 +7119,7 @@ public readonly minimumReleaseAgeExcludes: string[];
|
|
|
7031
7119
|
|
|
7032
7120
|
- *Type:* string[]
|
|
7033
7121
|
|
|
7034
|
-
Tools and backends
|
|
7122
|
+
Tools and backends that the configured and default `minimum_release_age` do not apply to.
|
|
7035
7123
|
|
|
7036
7124
|
---
|
|
7037
7125
|
|
|
@@ -7055,7 +7143,7 @@ public readonly netrcFile: string;
|
|
|
7055
7143
|
|
|
7056
7144
|
- *Type:* string
|
|
7057
7145
|
|
|
7058
|
-
Path
|
|
7146
|
+
Path of the netrc file to use instead of `~/.netrc` (`%USERPROFILE%\_netrc` on Windows).
|
|
7059
7147
|
|
|
7060
7148
|
---
|
|
7061
7149
|
|
|
@@ -7101,7 +7189,7 @@ public readonly notFoundAutoInstall: boolean;
|
|
|
7101
7189
|
|
|
7102
7190
|
- *Type:* boolean
|
|
7103
7191
|
|
|
7104
|
-
|
|
7192
|
+
Install the tool that provides a command when your shell cannot find that command.
|
|
7105
7193
|
|
|
7106
7194
|
---
|
|
7107
7195
|
|
|
@@ -7113,7 +7201,7 @@ public readonly notFoundAutoInstallRegistry: boolean;
|
|
|
7113
7201
|
|
|
7114
7202
|
- *Type:* boolean
|
|
7115
7203
|
|
|
7116
|
-
|
|
7204
|
+
Install an unconfigured tool when exactly one registry entry provides a command your shell cannot find.
|
|
7117
7205
|
|
|
7118
7206
|
---
|
|
7119
7207
|
|
|
@@ -7125,7 +7213,7 @@ public readonly notFoundSystemFallback: boolean;
|
|
|
7125
7213
|
|
|
7126
7214
|
- *Type:* boolean
|
|
7127
7215
|
|
|
7128
|
-
|
|
7216
|
+
Let a shim run a same-named executable from elsewhere on `PATH` when mise cannot resolve the tool.
|
|
7129
7217
|
|
|
7130
7218
|
---
|
|
7131
7219
|
|
|
@@ -7157,9 +7245,7 @@ public readonly offline: boolean;
|
|
|
7157
7245
|
|
|
7158
7246
|
- *Type:* boolean
|
|
7159
7247
|
|
|
7160
|
-
|
|
7161
|
-
|
|
7162
|
-
Tools will only use locally cached data.
|
|
7248
|
+
Block every HTTP request, so mise uses only installed tools and cached data.
|
|
7163
7249
|
|
|
7164
7250
|
---
|
|
7165
7251
|
|
|
@@ -7171,7 +7257,7 @@ public readonly os: string;
|
|
|
7171
7257
|
|
|
7172
7258
|
- *Type:* string
|
|
7173
7259
|
|
|
7174
|
-
|
|
7260
|
+
Operating system of the precompiled binaries mise downloads.
|
|
7175
7261
|
|
|
7176
7262
|
---
|
|
7177
7263
|
|
|
@@ -7193,7 +7279,7 @@ public readonly overrideConfigFilenames: string[];
|
|
|
7193
7279
|
|
|
7194
7280
|
- *Type:* string[]
|
|
7195
7281
|
|
|
7196
|
-
|
|
7282
|
+
Project config filenames that mise looks for instead of `mise.toml`, `.mise.toml` and the other standard names.
|
|
7197
7283
|
|
|
7198
7284
|
---
|
|
7199
7285
|
|
|
@@ -7205,7 +7291,7 @@ public readonly overrideToolVersionsFilenames: string[];
|
|
|
7205
7291
|
|
|
7206
7292
|
- *Type:* string[]
|
|
7207
7293
|
|
|
7208
|
-
|
|
7294
|
+
Filenames that mise reads as `.tool-versions` files instead of `.tool-versions`.
|
|
7209
7295
|
|
|
7210
7296
|
---
|
|
7211
7297
|
|
|
@@ -7227,7 +7313,7 @@ public readonly paranoid: boolean;
|
|
|
7227
7313
|
|
|
7228
7314
|
- *Type:* boolean
|
|
7229
7315
|
|
|
7230
|
-
|
|
7316
|
+
Require explicit, content-bound trust for project config, and re-verify provenance on every install.
|
|
7231
7317
|
|
|
7232
7318
|
---
|
|
7233
7319
|
|
|
@@ -7238,9 +7324,8 @@ public readonly pin: boolean;
|
|
|
7238
7324
|
```
|
|
7239
7325
|
|
|
7240
7326
|
- *Type:* boolean
|
|
7241
|
-
- *Default:* pinning versions when running `mise use` in mise.toml files.
|
|
7242
7327
|
|
|
7243
|
-
|
|
7328
|
+
Make `mise use` write the resolved version, such as `24.14.0` for `node@24`, instead of the requested one.
|
|
7244
7329
|
|
|
7245
7330
|
---
|
|
7246
7331
|
|
|
@@ -7262,7 +7347,9 @@ public readonly pluginAutoupdateLastCheckDuration: string;
|
|
|
7262
7347
|
|
|
7263
7348
|
- *Type:* string
|
|
7264
7349
|
|
|
7265
|
-
|
|
7350
|
+
[deprecated] Has no effect;
|
|
7351
|
+
|
|
7352
|
+
it was never implemented.
|
|
7266
7353
|
|
|
7267
7354
|
---
|
|
7268
7355
|
|
|
@@ -7274,7 +7361,7 @@ public readonly preferOffline: boolean;
|
|
|
7274
7361
|
|
|
7275
7362
|
- *Type:* boolean
|
|
7276
7363
|
|
|
7277
|
-
|
|
7364
|
+
Use cached version lists instead of fetching new ones, and go to the network only when nothing is cached.
|
|
7278
7365
|
|
|
7279
7366
|
---
|
|
7280
7367
|
|
|
@@ -7286,7 +7373,7 @@ public readonly prereleases: boolean;
|
|
|
7286
7373
|
|
|
7287
7374
|
- *Type:* boolean
|
|
7288
7375
|
|
|
7289
|
-
Include
|
|
7376
|
+
Include prereleases in `mise ls-remote`, `latest` and prefix matching for every tool.
|
|
7290
7377
|
|
|
7291
7378
|
---
|
|
7292
7379
|
|
|
@@ -7298,7 +7385,9 @@ public readonly profile: string;
|
|
|
7298
7385
|
|
|
7299
7386
|
- *Type:* string
|
|
7300
7387
|
|
|
7301
|
-
|
|
7388
|
+
Older name for the `env` setting;
|
|
7389
|
+
|
|
7390
|
+
use `MISE_ENV` instead.
|
|
7302
7391
|
|
|
7303
7392
|
---
|
|
7304
7393
|
|
|
@@ -7310,7 +7399,7 @@ public readonly provenanceApiFailuresFatal: boolean;
|
|
|
7310
7399
|
|
|
7311
7400
|
- *Type:* boolean
|
|
7312
7401
|
|
|
7313
|
-
Fail when provenance API
|
|
7402
|
+
Fail an install when a provenance API, such as GitHub's attestation API, cannot be reached or queried.
|
|
7314
7403
|
|
|
7315
7404
|
---
|
|
7316
7405
|
|
|
@@ -7352,7 +7441,9 @@ public readonly quiet: boolean;
|
|
|
7352
7441
|
|
|
7353
7442
|
- *Type:* boolean
|
|
7354
7443
|
|
|
7355
|
-
|
|
7444
|
+
Hide mise's own non-error messages, such as progress and task headers;
|
|
7445
|
+
|
|
7446
|
+
same as `--quiet`.
|
|
7356
7447
|
|
|
7357
7448
|
---
|
|
7358
7449
|
|
|
@@ -7364,7 +7455,7 @@ public readonly raw: boolean;
|
|
|
7364
7455
|
|
|
7365
7456
|
- *Type:* boolean
|
|
7366
7457
|
|
|
7367
|
-
Connect stdin
|
|
7458
|
+
Connect tasks and install commands directly to the terminal's stdin, stdout and stderr.
|
|
7368
7459
|
|
|
7369
7460
|
---
|
|
7370
7461
|
|
|
@@ -7376,7 +7467,7 @@ public readonly registryCacheTtl: string;
|
|
|
7376
7467
|
|
|
7377
7468
|
- *Type:* string
|
|
7378
7469
|
|
|
7379
|
-
How long
|
|
7470
|
+
How long a downloaded mise registry stays fresh when `registry_floating` is on.
|
|
7380
7471
|
|
|
7381
7472
|
---
|
|
7382
7473
|
|
|
@@ -7388,7 +7479,7 @@ public readonly registryFloating: boolean;
|
|
|
7388
7479
|
|
|
7389
7480
|
- *Type:* boolean
|
|
7390
7481
|
|
|
7391
|
-
|
|
7482
|
+
Use the latest released mise registry and the current aqua registry, not only the copies built into mise.
|
|
7392
7483
|
|
|
7393
7484
|
---
|
|
7394
7485
|
|
|
@@ -7420,7 +7511,7 @@ public readonly safe: boolean;
|
|
|
7420
7511
|
|
|
7421
7512
|
- *Type:* boolean
|
|
7422
7513
|
|
|
7423
|
-
|
|
7514
|
+
Load project config without letting it run code or change the environment, for automation that reads untrusted config.
|
|
7424
7515
|
|
|
7425
7516
|
---
|
|
7426
7517
|
|
|
@@ -7452,7 +7543,7 @@ public readonly sharedInstallDirs: string[];
|
|
|
7452
7543
|
|
|
7453
7544
|
- *Type:* string[]
|
|
7454
7545
|
|
|
7455
|
-
|
|
7546
|
+
Extra read-only directories that mise searches for installed tool versions.
|
|
7456
7547
|
|
|
7457
7548
|
---
|
|
7458
7549
|
|
|
@@ -7474,7 +7565,7 @@ public readonly shimsDir: string;
|
|
|
7474
7565
|
|
|
7475
7566
|
- *Type:* string
|
|
7476
7567
|
|
|
7477
|
-
Directory
|
|
7568
|
+
Directory where mise writes user shims.
|
|
7478
7569
|
|
|
7479
7570
|
---
|
|
7480
7571
|
|
|
@@ -7486,7 +7577,9 @@ public readonly shorthandsFile: string;
|
|
|
7486
7577
|
|
|
7487
7578
|
- *Type:* string
|
|
7488
7579
|
|
|
7489
|
-
[deprecated]
|
|
7580
|
+
[deprecated] File of custom tool shorthands;
|
|
7581
|
+
|
|
7582
|
+
use `[plugins]` instead.
|
|
7490
7583
|
|
|
7491
7584
|
---
|
|
7492
7585
|
|
|
@@ -7498,7 +7591,9 @@ public readonly silent: boolean;
|
|
|
7498
7591
|
|
|
7499
7592
|
- *Type:* boolean
|
|
7500
7593
|
|
|
7501
|
-
|
|
7594
|
+
Hide all output from `mise run` and `mise watch`, including what tasks print, except errors;
|
|
7595
|
+
|
|
7596
|
+
same as `--silent`.
|
|
7502
7597
|
|
|
7503
7598
|
---
|
|
7504
7599
|
|
|
@@ -7520,7 +7615,7 @@ public readonly slsa: boolean;
|
|
|
7520
7615
|
|
|
7521
7616
|
- *Type:* boolean
|
|
7522
7617
|
|
|
7523
|
-
|
|
7618
|
+
Verify SLSA provenance of downloads whose publisher provides it.
|
|
7524
7619
|
|
|
7525
7620
|
---
|
|
7526
7621
|
|
|
@@ -7571,11 +7666,8 @@ public readonly systemConfigFile: string;
|
|
|
7571
7666
|
```
|
|
7572
7667
|
|
|
7573
7668
|
- *Type:* string
|
|
7574
|
-
- *Default:* etc/mise/config.toml`. This must be an env var.
|
|
7575
7669
|
|
|
7576
|
-
|
|
7577
|
-
|
|
7578
|
-
Default is `/etc/mise/config.toml`. This must be an env var.
|
|
7670
|
+
One file to use as the system config instead of the config files in `/etc/mise`.
|
|
7579
7671
|
|
|
7580
7672
|
---
|
|
7581
7673
|
|
|
@@ -7587,7 +7679,7 @@ public readonly systemDeps: SettingsSystemDeps;
|
|
|
7587
7679
|
|
|
7588
7680
|
- *Type:* <a href="#mise-projen.SettingsSystemDeps">SettingsSystemDeps</a>
|
|
7589
7681
|
|
|
7590
|
-
|
|
7682
|
+
What mise does when a plugin's declared system dependencies are missing before it installs a tool.
|
|
7591
7683
|
|
|
7592
7684
|
---
|
|
7593
7685
|
|
|
@@ -7599,7 +7691,7 @@ public readonly systemInstallsDir: string;
|
|
|
7599
7691
|
|
|
7600
7692
|
- *Type:* string
|
|
7601
7693
|
|
|
7602
|
-
Directory
|
|
7694
|
+
Directory that `mise install --system` installs into.
|
|
7603
7695
|
|
|
7604
7696
|
---
|
|
7605
7697
|
|
|
@@ -7621,7 +7713,7 @@ public readonly systemShimsDir: string;
|
|
|
7621
7713
|
|
|
7622
7714
|
- *Type:* string
|
|
7623
7715
|
|
|
7624
|
-
Directory
|
|
7716
|
+
Directory where `mise reshim --system` writes shims for system installs.
|
|
7625
7717
|
|
|
7626
7718
|
---
|
|
7627
7719
|
|
|
@@ -7643,7 +7735,7 @@ public readonly taskDisablePaths: string[];
|
|
|
7643
7735
|
|
|
7644
7736
|
- *Type:* string[]
|
|
7645
7737
|
|
|
7646
|
-
|
|
7738
|
+
Deprecated alias for `task.disable_paths`.
|
|
7647
7739
|
|
|
7648
7740
|
---
|
|
7649
7741
|
|
|
@@ -7655,7 +7747,7 @@ public readonly taskOutput: string;
|
|
|
7655
7747
|
|
|
7656
7748
|
- *Type:* string
|
|
7657
7749
|
|
|
7658
|
-
|
|
7750
|
+
Deprecated alias for `task.output`.
|
|
7659
7751
|
|
|
7660
7752
|
---
|
|
7661
7753
|
|
|
@@ -7667,7 +7759,7 @@ public readonly taskRemoteNoCache: boolean;
|
|
|
7667
7759
|
|
|
7668
7760
|
- *Type:* boolean
|
|
7669
7761
|
|
|
7670
|
-
|
|
7762
|
+
Deprecated alias for `task.remote_no_cache`.
|
|
7671
7763
|
|
|
7672
7764
|
---
|
|
7673
7765
|
|
|
@@ -7679,7 +7771,7 @@ public readonly taskRunAutoInstall: boolean;
|
|
|
7679
7771
|
|
|
7680
7772
|
- *Type:* boolean
|
|
7681
7773
|
|
|
7682
|
-
|
|
7774
|
+
Deprecated alias for `task.run_auto_install`.
|
|
7683
7775
|
|
|
7684
7776
|
---
|
|
7685
7777
|
|
|
@@ -7691,9 +7783,7 @@ public readonly taskShowFullCmd: boolean;
|
|
|
7691
7783
|
|
|
7692
7784
|
- *Type:* boolean
|
|
7693
7785
|
|
|
7694
|
-
|
|
7695
|
-
|
|
7696
|
-
When true, the full command line will be shown.
|
|
7786
|
+
Deprecated alias for `task.show_full_cmd`.
|
|
7697
7787
|
|
|
7698
7788
|
---
|
|
7699
7789
|
|
|
@@ -7705,7 +7795,7 @@ public readonly taskSkip: string[];
|
|
|
7705
7795
|
|
|
7706
7796
|
- *Type:* string[]
|
|
7707
7797
|
|
|
7708
|
-
|
|
7798
|
+
Deprecated alias for `task.skip`.
|
|
7709
7799
|
|
|
7710
7800
|
---
|
|
7711
7801
|
|
|
@@ -7717,7 +7807,7 @@ public readonly taskSkipDepends: boolean;
|
|
|
7717
7807
|
|
|
7718
7808
|
- *Type:* boolean
|
|
7719
7809
|
|
|
7720
|
-
|
|
7810
|
+
Deprecated alias for `task.skip_depends`.
|
|
7721
7811
|
|
|
7722
7812
|
---
|
|
7723
7813
|
|
|
@@ -7729,9 +7819,7 @@ public readonly taskTimeout: string;
|
|
|
7729
7819
|
|
|
7730
7820
|
- *Type:* string
|
|
7731
7821
|
|
|
7732
|
-
|
|
7733
|
-
|
|
7734
|
-
Can be overridden by individual tasks.
|
|
7822
|
+
Deprecated alias for `task.timeout`.
|
|
7735
7823
|
|
|
7736
7824
|
---
|
|
7737
7825
|
|
|
@@ -7743,9 +7831,7 @@ public readonly taskTimings: boolean;
|
|
|
7743
7831
|
|
|
7744
7832
|
- *Type:* boolean
|
|
7745
7833
|
|
|
7746
|
-
|
|
7747
|
-
|
|
7748
|
-
Default shows when output type is `prefix`.
|
|
7834
|
+
Deprecated alias for `task.timings`.
|
|
7749
7835
|
|
|
7750
7836
|
---
|
|
7751
7837
|
|
|
@@ -7757,7 +7843,7 @@ public readonly teraV1: boolean;
|
|
|
7757
7843
|
|
|
7758
7844
|
- *Type:* boolean
|
|
7759
7845
|
|
|
7760
|
-
|
|
7846
|
+
[deprecated] Render templates with Tera v1 instead of Tera v2.
|
|
7761
7847
|
|
|
7762
7848
|
---
|
|
7763
7849
|
|
|
@@ -7769,7 +7855,7 @@ public readonly terminalProgress: boolean;
|
|
|
7769
7855
|
|
|
7770
7856
|
- *Type:* boolean
|
|
7771
7857
|
|
|
7772
|
-
|
|
7858
|
+
Show install progress in the terminal window's own progress indicator, with OSC 9;4 escape sequences.
|
|
7773
7859
|
|
|
7774
7860
|
---
|
|
7775
7861
|
|
|
@@ -7791,7 +7877,7 @@ public readonly trace: boolean;
|
|
|
7791
7877
|
|
|
7792
7878
|
- *Type:* boolean
|
|
7793
7879
|
|
|
7794
|
-
|
|
7880
|
+
Set the log level to trace.
|
|
7795
7881
|
|
|
7796
7882
|
---
|
|
7797
7883
|
|
|
@@ -7815,9 +7901,7 @@ public readonly trustedConfigPaths: string[];
|
|
|
7815
7901
|
|
|
7816
7902
|
- *Type:* string[]
|
|
7817
7903
|
|
|
7818
|
-
|
|
7819
|
-
|
|
7820
|
-
Any config files under these paths will be trusted without prompting. Set to `["/"]` to trust all config files, effectively disabling the trust mechanism. Paths are separated by the OS path separator when using the environment variable, `mise settings set`, or `mise settings add` (`:` on Unix, `;` on Windows).
|
|
7904
|
+
Directories whose config files mise trusts without asking.
|
|
7821
7905
|
|
|
7822
7906
|
---
|
|
7823
7907
|
|
|
@@ -7829,9 +7913,7 @@ public readonly unixDefaultFileShellArgs: string;
|
|
|
7829
7913
|
|
|
7830
7914
|
- *Type:* string
|
|
7831
7915
|
|
|
7832
|
-
|
|
7833
|
-
|
|
7834
|
-
For example, `sh` for sh.
|
|
7916
|
+
Shell that runs a file task on Unix when the task sets no `shell` and the file has no shebang or known extension.
|
|
7835
7917
|
|
|
7836
7918
|
---
|
|
7837
7919
|
|
|
@@ -7843,9 +7925,7 @@ public readonly unixDefaultInlineShellArgs: string;
|
|
|
7843
7925
|
|
|
7844
7926
|
- *Type:* string
|
|
7845
7927
|
|
|
7846
|
-
|
|
7847
|
-
|
|
7848
|
-
For example, `sh -c` for sh.
|
|
7928
|
+
Shell and arguments that run inline scripts on Unix, such as a task's `run`, hooks and `postinstall`.
|
|
7849
7929
|
|
|
7850
7930
|
---
|
|
7851
7931
|
|
|
@@ -7867,7 +7947,7 @@ public readonly urlReplacements: {[ key: string ]: string};
|
|
|
7867
7947
|
|
|
7868
7948
|
- *Type:* {[ key: string ]: string}
|
|
7869
7949
|
|
|
7870
|
-
|
|
7950
|
+
URL patterns and replacements that mise's HTTP client applies before sending a request, for mirrors and proxies.
|
|
7871
7951
|
|
|
7872
7952
|
---
|
|
7873
7953
|
|
|
@@ -7879,9 +7959,7 @@ public readonly useFileShellForExecutableTasks: boolean;
|
|
|
7879
7959
|
|
|
7880
7960
|
- *Type:* boolean
|
|
7881
7961
|
|
|
7882
|
-
|
|
7883
|
-
|
|
7884
|
-
When set to true, the shell defined in the file will be used, or the default shell specified by `windows_default_file_shell_args` or `unix_default_file_shell_args` will be applied. If set to false, tasks will be executed directly as programs.
|
|
7962
|
+
Run executable file tasks through a shell instead of executing them directly.
|
|
7885
7963
|
|
|
7886
7964
|
---
|
|
7887
7965
|
|
|
@@ -7893,7 +7971,7 @@ public readonly useVersionsHost: boolean;
|
|
|
7893
7971
|
|
|
7894
7972
|
- *Type:* boolean
|
|
7895
7973
|
|
|
7896
|
-
|
|
7974
|
+
Get version lists, public GitHub release metadata and attestations from mise-versions instead of upstream APIs.
|
|
7897
7975
|
|
|
7898
7976
|
---
|
|
7899
7977
|
|
|
@@ -7905,7 +7983,7 @@ public readonly useVersionsHostTrack: boolean;
|
|
|
7905
7983
|
|
|
7906
7984
|
- *Type:* boolean
|
|
7907
7985
|
|
|
7908
|
-
Send anonymous download statistics
|
|
7986
|
+
Send anonymous download statistics to mise-versions after installing a tool.
|
|
7909
7987
|
|
|
7910
7988
|
---
|
|
7911
7989
|
|
|
@@ -7917,7 +7995,9 @@ public readonly verbose: boolean;
|
|
|
7917
7995
|
|
|
7918
7996
|
- *Type:* boolean
|
|
7919
7997
|
|
|
7920
|
-
|
|
7998
|
+
Show extra output, such as installation logs, and set the log level to debug;
|
|
7999
|
+
|
|
8000
|
+
same as `--verbose`.
|
|
7921
8001
|
|
|
7922
8002
|
---
|
|
7923
8003
|
|
|
@@ -7929,9 +8009,7 @@ public readonly windowsDefaultFileShellArgs: string;
|
|
|
7929
8009
|
|
|
7930
8010
|
- *Type:* string
|
|
7931
8011
|
|
|
7932
|
-
|
|
7933
|
-
|
|
7934
|
-
For example, `cmd /c` for cmd.exe.
|
|
8012
|
+
Shell that runs a file task on Windows when the task sets no `shell` and the file has no shebang or known extension.
|
|
7935
8013
|
|
|
7936
8014
|
---
|
|
7937
8015
|
|
|
@@ -7943,9 +8021,7 @@ public readonly windowsDefaultInlineShellArgs: string;
|
|
|
7943
8021
|
|
|
7944
8022
|
- *Type:* string
|
|
7945
8023
|
|
|
7946
|
-
|
|
7947
|
-
|
|
7948
|
-
For example, `cmd /c` for cmd.exe.
|
|
8024
|
+
Shell and arguments that run inline scripts on Windows, such as a task's `run`, hooks and `postinstall`.
|
|
7949
8025
|
|
|
7950
8026
|
---
|
|
7951
8027
|
|
|
@@ -7957,9 +8033,7 @@ public readonly windowsExecutableExtensions: string[];
|
|
|
7957
8033
|
|
|
7958
8034
|
- *Type:* string[]
|
|
7959
8035
|
|
|
7960
|
-
|
|
7961
|
-
|
|
7962
|
-
For example, `exe` for .exe files, `bat` for .bat files, and so on.
|
|
8036
|
+
File extensions, without the dot, that mise treats as executable on Windows.
|
|
7963
8037
|
|
|
7964
8038
|
---
|
|
7965
8039
|
|
|
@@ -7971,21 +8045,19 @@ public readonly windowsPowershellNoProfile: boolean;
|
|
|
7971
8045
|
|
|
7972
8046
|
- *Type:* boolean
|
|
7973
8047
|
|
|
7974
|
-
Pass `-NoProfile` to PowerShell (`pwsh
|
|
8048
|
+
Pass `-NoProfile` to the PowerShell (`pwsh` or `powershell`) that mise starts, so startup profiles are skipped.
|
|
7975
8049
|
|
|
7976
8050
|
---
|
|
7977
8051
|
|
|
7978
8052
|
##### `windowsShimMode`<sup>Optional</sup> <a name="windowsShimMode" id="mise-projen.Settings.property.windowsShimMode"></a>
|
|
7979
8053
|
|
|
7980
8054
|
```typescript
|
|
7981
|
-
public readonly windowsShimMode:
|
|
8055
|
+
public readonly windowsShimMode: SettingsWindowsShimMode;
|
|
7982
8056
|
```
|
|
7983
8057
|
|
|
7984
|
-
- *Type:*
|
|
7985
|
-
|
|
7986
|
-
Shim file mode for Windows.
|
|
8058
|
+
- *Type:* <a href="#mise-projen.SettingsWindowsShimMode">SettingsWindowsShimMode</a>
|
|
7987
8059
|
|
|
7988
|
-
|
|
8060
|
+
How mise creates shims on Windows.
|
|
7989
8061
|
|
|
7990
8062
|
---
|
|
7991
8063
|
|
|
@@ -8007,9 +8079,7 @@ public readonly yes: boolean;
|
|
|
8007
8079
|
|
|
8008
8080
|
- *Type:* boolean
|
|
8009
8081
|
|
|
8010
|
-
|
|
8011
|
-
|
|
8012
|
-
This is useful for scripting.
|
|
8082
|
+
Answer yes to every confirmation prompt, as `--yes` does.
|
|
8013
8083
|
|
|
8014
8084
|
---
|
|
8015
8085
|
|
|
@@ -8037,10 +8107,10 @@ const settingsAge: SettingsAge = { ... }
|
|
|
8037
8107
|
|
|
8038
8108
|
| **Name** | **Type** | **Description** |
|
|
8039
8109
|
| --- | --- | --- |
|
|
8040
|
-
| <code><a href="#mise-projen.SettingsAge.property.identityFiles">identityFiles</a></code> | <code>string[]</code> |
|
|
8041
|
-
| <code><a href="#mise-projen.SettingsAge.property.keyFile">keyFile</a></code> | <code>string</code> |
|
|
8042
|
-
| <code><a href="#mise-projen.SettingsAge.property.sshIdentityFiles">sshIdentityFiles</a></code> | <code>string[]</code> |
|
|
8043
|
-
| <code><a href="#mise-projen.SettingsAge.property.strict">strict</a></code> | <code>boolean</code> |
|
|
8110
|
+
| <code><a href="#mise-projen.SettingsAge.property.identityFiles">identityFiles</a></code> | <code>string[]</code> | Age identity files to try when decrypting. |
|
|
8111
|
+
| <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. |
|
|
8112
|
+
| <code><a href="#mise-projen.SettingsAge.property.sshIdentityFiles">sshIdentityFiles</a></code> | <code>string[]</code> | SSH private keys to try when decrypting age values. |
|
|
8113
|
+
| <code><a href="#mise-projen.SettingsAge.property.strict">strict</a></code> | <code>boolean</code> | Fail when an `[env]` age value cannot be decrypted, instead of skipping it. |
|
|
8044
8114
|
|
|
8045
8115
|
---
|
|
8046
8116
|
|
|
@@ -8052,7 +8122,7 @@ public readonly identityFiles: string[];
|
|
|
8052
8122
|
|
|
8053
8123
|
- *Type:* string[]
|
|
8054
8124
|
|
|
8055
|
-
|
|
8125
|
+
Age identity files to try when decrypting.
|
|
8056
8126
|
|
|
8057
8127
|
---
|
|
8058
8128
|
|
|
@@ -8064,7 +8134,7 @@ public readonly keyFile: string;
|
|
|
8064
8134
|
|
|
8065
8135
|
- *Type:* string
|
|
8066
8136
|
|
|
8067
|
-
|
|
8137
|
+
Age private key file used to decrypt and as the default recipient when encrypting.
|
|
8068
8138
|
|
|
8069
8139
|
---
|
|
8070
8140
|
|
|
@@ -8076,7 +8146,7 @@ public readonly sshIdentityFiles: string[];
|
|
|
8076
8146
|
|
|
8077
8147
|
- *Type:* string[]
|
|
8078
8148
|
|
|
8079
|
-
|
|
8149
|
+
SSH private keys to try when decrypting age values.
|
|
8080
8150
|
|
|
8081
8151
|
---
|
|
8082
8152
|
|
|
@@ -8088,9 +8158,7 @@ public readonly strict: boolean;
|
|
|
8088
8158
|
|
|
8089
8159
|
- *Type:* boolean
|
|
8090
8160
|
|
|
8091
|
-
|
|
8092
|
-
|
|
8093
|
-
If false, skip decryption and continue in these cases.
|
|
8161
|
+
Fail when an `[env]` age value cannot be decrypted, instead of skipping it.
|
|
8094
8162
|
|
|
8095
8163
|
---
|
|
8096
8164
|
|
|
@@ -8108,14 +8176,14 @@ const settingsAqua: SettingsAqua = { ... }
|
|
|
8108
8176
|
|
|
8109
8177
|
| **Name** | **Type** | **Description** |
|
|
8110
8178
|
| --- | --- | --- |
|
|
8111
|
-
| <code><a href="#mise-projen.SettingsAqua.property.bakedRegistry">bakedRegistry</a></code> | <code>boolean</code> | Use
|
|
8112
|
-
| <code><a href="#mise-projen.SettingsAqua.property.cosign">cosign</a></code> | <code>boolean</code> |
|
|
8113
|
-
| <code><a href="#mise-projen.SettingsAqua.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> |
|
|
8114
|
-
| <code><a href="#mise-projen.SettingsAqua.property.minisign">minisign</a></code> | <code>boolean</code> |
|
|
8115
|
-
| <code><a href="#mise-projen.SettingsAqua.property.registries">registries</a></code> | <code>string[]</code> | Aqua
|
|
8116
|
-
| <code><a href="#mise-projen.SettingsAqua.property.registryCacheTtl">registryCacheTtl</a></code> | <code>string</code> | How long
|
|
8117
|
-
| <code><a href="#mise-projen.SettingsAqua.property.registryUrl">registryUrl</a></code> | <code>string</code> | [deprecated] URL of
|
|
8118
|
-
| <code><a href="#mise-projen.SettingsAqua.property.slsa">slsa</a></code> | <code>boolean</code> |
|
|
8179
|
+
| <code><a href="#mise-projen.SettingsAqua.property.bakedRegistry">bakedRegistry</a></code> | <code>boolean</code> | Use the aqua registry built into mise. |
|
|
8180
|
+
| <code><a href="#mise-projen.SettingsAqua.property.cosign">cosign</a></code> | <code>boolean</code> | Verify Cosign signatures for aqua packages that declare them. |
|
|
8181
|
+
| <code><a href="#mise-projen.SettingsAqua.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Verify GitHub artifact attestations for aqua packages that declare them. |
|
|
8182
|
+
| <code><a href="#mise-projen.SettingsAqua.property.minisign">minisign</a></code> | <code>boolean</code> | Verify Minisign signatures for aqua packages that declare them. |
|
|
8183
|
+
| <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. |
|
|
8184
|
+
| <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. |
|
|
8185
|
+
| <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. |
|
|
8186
|
+
| <code><a href="#mise-projen.SettingsAqua.property.slsa">slsa</a></code> | <code>boolean</code> | Verify SLSA provenance for aqua packages that declare it. |
|
|
8119
8187
|
|
|
8120
8188
|
---
|
|
8121
8189
|
|
|
@@ -8127,7 +8195,7 @@ public readonly bakedRegistry: boolean;
|
|
|
8127
8195
|
|
|
8128
8196
|
- *Type:* boolean
|
|
8129
8197
|
|
|
8130
|
-
Use
|
|
8198
|
+
Use the aqua registry built into mise.
|
|
8131
8199
|
|
|
8132
8200
|
---
|
|
8133
8201
|
|
|
@@ -8139,7 +8207,7 @@ public readonly cosign: boolean;
|
|
|
8139
8207
|
|
|
8140
8208
|
- *Type:* boolean
|
|
8141
8209
|
|
|
8142
|
-
|
|
8210
|
+
Verify Cosign signatures for aqua packages that declare them.
|
|
8143
8211
|
|
|
8144
8212
|
---
|
|
8145
8213
|
|
|
@@ -8151,7 +8219,7 @@ public readonly githubAttestations: boolean;
|
|
|
8151
8219
|
|
|
8152
8220
|
- *Type:* boolean
|
|
8153
8221
|
|
|
8154
|
-
|
|
8222
|
+
Verify GitHub artifact attestations for aqua packages that declare them.
|
|
8155
8223
|
|
|
8156
8224
|
---
|
|
8157
8225
|
|
|
@@ -8163,7 +8231,7 @@ public readonly minisign: boolean;
|
|
|
8163
8231
|
|
|
8164
8232
|
- *Type:* boolean
|
|
8165
8233
|
|
|
8166
|
-
|
|
8234
|
+
Verify Minisign signatures for aqua packages that declare them.
|
|
8167
8235
|
|
|
8168
8236
|
---
|
|
8169
8237
|
|
|
@@ -8175,7 +8243,7 @@ public readonly registries: string[];
|
|
|
8175
8243
|
|
|
8176
8244
|
- *Type:* string[]
|
|
8177
8245
|
|
|
8178
|
-
Aqua
|
|
8246
|
+
Aqua registries to search, in order, before the baked-in registry.
|
|
8179
8247
|
|
|
8180
8248
|
---
|
|
8181
8249
|
|
|
@@ -8187,7 +8255,7 @@ public readonly registryCacheTtl: string;
|
|
|
8187
8255
|
|
|
8188
8256
|
- *Type:* string
|
|
8189
8257
|
|
|
8190
|
-
How long
|
|
8258
|
+
How long a downloaded aqua registry stays fresh before mise downloads it again.
|
|
8191
8259
|
|
|
8192
8260
|
---
|
|
8193
8261
|
|
|
@@ -8199,7 +8267,7 @@ public readonly registryUrl: string;
|
|
|
8199
8267
|
|
|
8200
8268
|
- *Type:* string
|
|
8201
8269
|
|
|
8202
|
-
[deprecated] URL of
|
|
8270
|
+
[deprecated] URL of one aqua registry repository to search before the baked-in registry.
|
|
8203
8271
|
|
|
8204
8272
|
---
|
|
8205
8273
|
|
|
@@ -8211,7 +8279,7 @@ public readonly slsa: boolean;
|
|
|
8211
8279
|
|
|
8212
8280
|
- *Type:* boolean
|
|
8213
8281
|
|
|
8214
|
-
|
|
8282
|
+
Verify SLSA provenance for aqua packages that declare it.
|
|
8215
8283
|
|
|
8216
8284
|
---
|
|
8217
8285
|
|
|
@@ -8229,11 +8297,11 @@ const settingsCargo: SettingsCargo = { ... }
|
|
|
8229
8297
|
|
|
8230
8298
|
| **Name** | **Type** | **Description** |
|
|
8231
8299
|
| --- | --- | --- |
|
|
8232
|
-
| <code><a href="#mise-projen.SettingsCargo.property.binstall">binstall</a></code> | <code>boolean</code> |
|
|
8233
|
-
| <code><a href="#mise-projen.SettingsCargo.property.binstallNative">binstallNative</a></code> | <code>boolean</code> | Use mise's
|
|
8234
|
-
| <code><a href="#mise-projen.SettingsCargo.property.binstallOnly">binstallOnly</a></code> | <code>boolean</code> | Require cargo-binstall
|
|
8235
|
-
| <code><a href="#mise-projen.SettingsCargo.property.binstallQuickinstall">binstallQuickinstall</a></code> | <code>boolean</code> |
|
|
8236
|
-
| <code><a href="#mise-projen.SettingsCargo.property.registryName">registryName</a></code> | <code>string</code> |
|
|
8300
|
+
| <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. |
|
|
8301
|
+
| <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. |
|
|
8302
|
+
| <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`. |
|
|
8303
|
+
| <code><a href="#mise-projen.SettingsCargo.property.binstallQuickinstall">binstallQuickinstall</a></code> | <code>boolean</code> | Let cargo-binstall download third-party artifacts from cargo-quickinstall. |
|
|
8304
|
+
| <code><a href="#mise-projen.SettingsCargo.property.registryName">registryName</a></code> | <code>string</code> | Cargo registry to install crates from instead of crates.io. |
|
|
8237
8305
|
|
|
8238
8306
|
---
|
|
8239
8307
|
|
|
@@ -8245,7 +8313,7 @@ public readonly binstall: boolean;
|
|
|
8245
8313
|
|
|
8246
8314
|
- *Type:* boolean
|
|
8247
8315
|
|
|
8248
|
-
|
|
8316
|
+
Install Cargo tools from cargo-binstall's prebuilt binaries when cargo-binstall is installed.
|
|
8249
8317
|
|
|
8250
8318
|
---
|
|
8251
8319
|
|
|
@@ -8257,7 +8325,7 @@ public readonly binstallNative: boolean;
|
|
|
8257
8325
|
|
|
8258
8326
|
- *Type:* boolean
|
|
8259
8327
|
|
|
8260
|
-
Use mise's
|
|
8328
|
+
Use mise's own prebuilt-binary installer for Cargo tools when cargo-binstall is not installed.
|
|
8261
8329
|
|
|
8262
8330
|
---
|
|
8263
8331
|
|
|
@@ -8269,9 +8337,7 @@ public readonly binstallOnly: boolean;
|
|
|
8269
8337
|
|
|
8270
8338
|
- *Type:* boolean
|
|
8271
8339
|
|
|
8272
|
-
Require cargo-binstall
|
|
8273
|
-
|
|
8274
|
-
Fail if no prebuilt binary is available or if tool options require cargo install.
|
|
8340
|
+
Require prebuilt binaries from cargo-binstall instead of falling back to `cargo install`.
|
|
8275
8341
|
|
|
8276
8342
|
---
|
|
8277
8343
|
|
|
@@ -8283,7 +8349,7 @@ public readonly binstallQuickinstall: boolean;
|
|
|
8283
8349
|
|
|
8284
8350
|
- *Type:* boolean
|
|
8285
8351
|
|
|
8286
|
-
|
|
8352
|
+
Let cargo-binstall download third-party artifacts from cargo-quickinstall.
|
|
8287
8353
|
|
|
8288
8354
|
---
|
|
8289
8355
|
|
|
@@ -8295,7 +8361,7 @@ public readonly registryName: string;
|
|
|
8295
8361
|
|
|
8296
8362
|
- *Type:* string
|
|
8297
8363
|
|
|
8298
|
-
|
|
8364
|
+
Cargo registry to install crates from instead of crates.io.
|
|
8299
8365
|
|
|
8300
8366
|
---
|
|
8301
8367
|
|
|
@@ -8313,7 +8379,7 @@ const settingsConda: SettingsConda = { ... }
|
|
|
8313
8379
|
|
|
8314
8380
|
| **Name** | **Type** | **Description** |
|
|
8315
8381
|
| --- | --- | --- |
|
|
8316
|
-
| <code><a href="#mise-projen.SettingsConda.property.channel">channel</a></code> | <code>string</code> |
|
|
8382
|
+
| <code><a href="#mise-projen.SettingsConda.property.channel">channel</a></code> | <code>string</code> | Channel for `conda:` tools that do not set their own. |
|
|
8317
8383
|
|
|
8318
8384
|
---
|
|
8319
8385
|
|
|
@@ -8325,7 +8391,7 @@ public readonly channel: string;
|
|
|
8325
8391
|
|
|
8326
8392
|
- *Type:* string
|
|
8327
8393
|
|
|
8328
|
-
|
|
8394
|
+
Channel for `conda:` tools that do not set their own.
|
|
8329
8395
|
|
|
8330
8396
|
---
|
|
8331
8397
|
|
|
@@ -8343,23 +8409,21 @@ const settingsDotfiles: SettingsDotfiles = { ... }
|
|
|
8343
8409
|
|
|
8344
8410
|
| **Name** | **Type** | **Description** |
|
|
8345
8411
|
| --- | --- | --- |
|
|
8346
|
-
| <code><a href="#mise-projen.SettingsDotfiles.property.defaultMode">defaultMode</a></code> | <code>
|
|
8412
|
+
| <code><a href="#mise-projen.SettingsDotfiles.property.defaultMode">defaultMode</a></code> | <code><a href="#mise-projen.SettingsDotfilesDefaultMode">SettingsDotfilesDefaultMode</a></code> | Mode for `[dotfiles]` entries that do not set `mode`. |
|
|
8347
8413
|
| <code><a href="#mise-projen.SettingsDotfiles.property.relativeSymlinks">relativeSymlinks</a></code> | <code>boolean</code> | Create dotfile symlinks with relative targets instead of absolute ones. |
|
|
8348
|
-
| <code><a href="#mise-projen.SettingsDotfiles.property.root">root</a></code> | <code>string</code> |
|
|
8414
|
+
| <code><a href="#mise-projen.SettingsDotfiles.property.root">root</a></code> | <code>string</code> | Directory that holds dotfile sources for entries without a `source`. |
|
|
8349
8415
|
|
|
8350
8416
|
---
|
|
8351
8417
|
|
|
8352
8418
|
##### `defaultMode`<sup>Optional</sup> <a name="defaultMode" id="mise-projen.SettingsDotfiles.property.defaultMode"></a>
|
|
8353
8419
|
|
|
8354
8420
|
```typescript
|
|
8355
|
-
public readonly defaultMode:
|
|
8421
|
+
public readonly defaultMode: SettingsDotfilesDefaultMode;
|
|
8356
8422
|
```
|
|
8357
8423
|
|
|
8358
|
-
- *Type:*
|
|
8359
|
-
|
|
8360
|
-
Default mode for dotfile entries when mode is omitted.
|
|
8424
|
+
- *Type:* <a href="#mise-projen.SettingsDotfilesDefaultMode">SettingsDotfilesDefaultMode</a>
|
|
8361
8425
|
|
|
8362
|
-
|
|
8426
|
+
Mode for `[dotfiles]` entries that do not set `mode`.
|
|
8363
8427
|
|
|
8364
8428
|
---
|
|
8365
8429
|
|
|
@@ -8383,7 +8447,7 @@ public readonly root: string;
|
|
|
8383
8447
|
|
|
8384
8448
|
- *Type:* string
|
|
8385
8449
|
|
|
8386
|
-
|
|
8450
|
+
Directory that holds dotfile sources for entries without a `source`.
|
|
8387
8451
|
|
|
8388
8452
|
---
|
|
8389
8453
|
|
|
@@ -8401,10 +8465,10 @@ const settingsDotnet: SettingsDotnet = { ... }
|
|
|
8401
8465
|
|
|
8402
8466
|
| **Name** | **Type** | **Description** |
|
|
8403
8467
|
| --- | --- | --- |
|
|
8404
|
-
| <code><a href="#mise-projen.SettingsDotnet.property.cliTelemetryOptout">cliTelemetryOptout</a></code> | <code>boolean</code> | Set DOTNET_CLI_TELEMETRY_OPTOUT to opt out of .NET CLI telemetry. |
|
|
8405
|
-
| <code><a href="#mise-projen.SettingsDotnet.property.dotnetRoot">dotnetRoot</a></code> | <code>string</code> |
|
|
8468
|
+
| <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. |
|
|
8469
|
+
| <code><a href="#mise-projen.SettingsDotnet.property.dotnetRoot">dotnetRoot</a></code> | <code>string</code> | Shared directory that every .NET SDK version installs into. |
|
|
8406
8470
|
| <code><a href="#mise-projen.SettingsDotnet.property.isolated">isolated</a></code> | <code>boolean</code> | Install each .NET SDK version in its own isolated directory. |
|
|
8407
|
-
| <code><a href="#mise-projen.SettingsDotnet.property.packageFlags">packageFlags</a></code> | <code>string[]</code> | [deprecated]
|
|
8471
|
+
| <code><a href="#mise-projen.SettingsDotnet.property.packageFlags">packageFlags</a></code> | <code>string[]</code> | [deprecated] Flags for every `dotnet:` tool; |
|
|
8408
8472
|
| <code><a href="#mise-projen.SettingsDotnet.property.registryUrl">registryUrl</a></code> | <code>string</code> | NuGet service index used to discover dotnet tool versions. |
|
|
8409
8473
|
|
|
8410
8474
|
---
|
|
@@ -8417,7 +8481,7 @@ public readonly cliTelemetryOptout: boolean;
|
|
|
8417
8481
|
|
|
8418
8482
|
- *Type:* boolean
|
|
8419
8483
|
|
|
8420
|
-
Set DOTNET_CLI_TELEMETRY_OPTOUT to opt out of .NET CLI telemetry.
|
|
8484
|
+
Set `DOTNET_CLI_TELEMETRY_OPTOUT` to opt out of .NET CLI telemetry.
|
|
8421
8485
|
|
|
8422
8486
|
---
|
|
8423
8487
|
|
|
@@ -8429,7 +8493,7 @@ public readonly dotnetRoot: string;
|
|
|
8429
8493
|
|
|
8430
8494
|
- *Type:* string
|
|
8431
8495
|
|
|
8432
|
-
|
|
8496
|
+
Shared directory that every .NET SDK version installs into.
|
|
8433
8497
|
|
|
8434
8498
|
---
|
|
8435
8499
|
|
|
@@ -8453,7 +8517,9 @@ public readonly packageFlags: string[];
|
|
|
8453
8517
|
|
|
8454
8518
|
- *Type:* string[]
|
|
8455
8519
|
|
|
8456
|
-
[deprecated]
|
|
8520
|
+
[deprecated] Flags for every `dotnet:` tool;
|
|
8521
|
+
|
|
8522
|
+
the only flag, `prerelease`, includes prereleases.
|
|
8457
8523
|
|
|
8458
8524
|
---
|
|
8459
8525
|
|
|
@@ -8483,8 +8549,8 @@ const settingsErlang: SettingsErlang = { ... }
|
|
|
8483
8549
|
|
|
8484
8550
|
| **Name** | **Type** | **Description** |
|
|
8485
8551
|
| --- | --- | --- |
|
|
8486
|
-
| <code><a href="#mise-projen.SettingsErlang.property.compile">compile</a></code> | <code>boolean</code> |
|
|
8487
|
-
| <code><a href="#mise-projen.SettingsErlang.property.precompiledOs">precompiledOs</a></code> | <code>
|
|
8552
|
+
| <code><a href="#mise-projen.SettingsErlang.property.compile">compile</a></code> | <code>boolean</code> | Compile Erlang from source instead of using a precompiled build. |
|
|
8553
|
+
| <code><a href="#mise-projen.SettingsErlang.property.precompiledOs">precompiledOs</a></code> | <code><a href="#mise-projen.SettingsErlangPrecompiledOs">SettingsErlangPrecompiledOs</a></code> | Ubuntu release whose precompiled Erlang build from builds.hex.pm mise installs on Linux. |
|
|
8488
8554
|
|
|
8489
8555
|
---
|
|
8490
8556
|
|
|
@@ -8496,21 +8562,19 @@ public readonly compile: boolean;
|
|
|
8496
8562
|
|
|
8497
8563
|
- *Type:* boolean
|
|
8498
8564
|
|
|
8499
|
-
|
|
8500
|
-
|
|
8501
|
-
If false, use precompiled binaries. If not set, use precompiled binaries if available.
|
|
8565
|
+
Compile Erlang from source instead of using a precompiled build.
|
|
8502
8566
|
|
|
8503
8567
|
---
|
|
8504
8568
|
|
|
8505
8569
|
##### `precompiledOs`<sup>Optional</sup> <a name="precompiledOs" id="mise-projen.SettingsErlang.property.precompiledOs"></a>
|
|
8506
8570
|
|
|
8507
8571
|
```typescript
|
|
8508
|
-
public readonly precompiledOs:
|
|
8572
|
+
public readonly precompiledOs: SettingsErlangPrecompiledOs;
|
|
8509
8573
|
```
|
|
8510
8574
|
|
|
8511
|
-
- *Type:*
|
|
8575
|
+
- *Type:* <a href="#mise-projen.SettingsErlangPrecompiledOs">SettingsErlangPrecompiledOs</a>
|
|
8512
8576
|
|
|
8513
|
-
Ubuntu release
|
|
8577
|
+
Ubuntu release whose precompiled Erlang build from builds.hex.pm mise installs on Linux.
|
|
8514
8578
|
|
|
8515
8579
|
---
|
|
8516
8580
|
|
|
@@ -8528,9 +8592,9 @@ const settingsForgejo: SettingsForgejo = { ... }
|
|
|
8528
8592
|
|
|
8529
8593
|
| **Name** | **Type** | **Description** |
|
|
8530
8594
|
| --- | --- | --- |
|
|
8531
|
-
| <code><a href="#mise-projen.SettingsForgejo.property.credentialCommand">credentialCommand</a></code> | <code>string</code> |
|
|
8532
|
-
| <code><a href="#mise-projen.SettingsForgejo.property.fjCliTokens">fjCliTokens</a></code> | <code>boolean</code> | Read Forgejo tokens
|
|
8533
|
-
| <code><a href="#mise-projen.SettingsForgejo.property.useGitCredentials">useGitCredentials</a></code> | <code>boolean</code> |
|
|
8595
|
+
| <code><a href="#mise-projen.SettingsForgejo.property.credentialCommand">credentialCommand</a></code> | <code>string</code> | Command that prints a Forgejo token on stdout. |
|
|
8596
|
+
| <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. |
|
|
8597
|
+
| <code><a href="#mise-projen.SettingsForgejo.property.useGitCredentials">useGitCredentials</a></code> | <code>boolean</code> | Get Forgejo tokens from your Git credential helpers with `git credential fill`. |
|
|
8534
8598
|
|
|
8535
8599
|
---
|
|
8536
8600
|
|
|
@@ -8542,7 +8606,7 @@ public readonly credentialCommand: string;
|
|
|
8542
8606
|
|
|
8543
8607
|
- *Type:* string
|
|
8544
8608
|
|
|
8545
|
-
|
|
8609
|
+
Command that prints a Forgejo token on stdout.
|
|
8546
8610
|
|
|
8547
8611
|
---
|
|
8548
8612
|
|
|
@@ -8554,7 +8618,7 @@ public readonly fjCliTokens: boolean;
|
|
|
8554
8618
|
|
|
8555
8619
|
- *Type:* boolean
|
|
8556
8620
|
|
|
8557
|
-
Read Forgejo tokens
|
|
8621
|
+
Read Forgejo tokens that the fj CLI stores in its `keys.json` file.
|
|
8558
8622
|
|
|
8559
8623
|
---
|
|
8560
8624
|
|
|
@@ -8566,7 +8630,7 @@ public readonly useGitCredentials: boolean;
|
|
|
8566
8630
|
|
|
8567
8631
|
- *Type:* boolean
|
|
8568
8632
|
|
|
8569
|
-
|
|
8633
|
+
Get Forgejo tokens from your Git credential helpers with `git credential fill`.
|
|
8570
8634
|
|
|
8571
8635
|
---
|
|
8572
8636
|
|
|
@@ -8584,17 +8648,17 @@ const settingsGithub: SettingsGithub = { ... }
|
|
|
8584
8648
|
|
|
8585
8649
|
| **Name** | **Type** | **Description** |
|
|
8586
8650
|
| --- | --- | --- |
|
|
8587
|
-
| <code><a href="#mise-projen.SettingsGithub.property.credentialCommand">credentialCommand</a></code> | <code>string</code> |
|
|
8588
|
-
| <code><a href="#mise-projen.SettingsGithub.property.ghCliTokens">ghCliTokens</a></code> | <code>boolean</code> | Read GitHub tokens
|
|
8589
|
-
| <code><a href="#mise-projen.SettingsGithub.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> |
|
|
8590
|
-
| <code><a href="#mise-projen.SettingsGithub.property.oauthApiUrl">oauthApiUrl</a></code> | <code>string</code> | GitHub API base URL
|
|
8591
|
-
| <code><a href="#mise-projen.SettingsGithub.property.oauthAuthUrl">oauthAuthUrl</a></code> | <code>string</code> | GitHub OAuth endpoint base URL for native device
|
|
8592
|
-
| <code><a href="#mise-projen.SettingsGithub.property.oauthClientId">oauthClientId</a></code> | <code>string</code> | GitHub App client ID
|
|
8593
|
-
| <code><a href="#mise-projen.SettingsGithub.property.oauthExportEnv">oauthExportEnv</a></code> | <code>string</code> | Environment variable
|
|
8594
|
-
| <code><a href="#mise-projen.SettingsGithub.property.oauthOpenBrowser">oauthOpenBrowser</a></code> | <code>boolean</code> | Open the browser during native GitHub OAuth device flow. |
|
|
8651
|
+
| <code><a href="#mise-projen.SettingsGithub.property.credentialCommand">credentialCommand</a></code> | <code>string</code> | Command that prints a GitHub token on stdout. |
|
|
8652
|
+
| <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. |
|
|
8653
|
+
| <code><a href="#mise-projen.SettingsGithub.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Verify GitHub artifact attestations for github backend tools. |
|
|
8654
|
+
| <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. |
|
|
8655
|
+
| <code><a href="#mise-projen.SettingsGithub.property.oauthAuthUrl">oauthAuthUrl</a></code> | <code>string</code> | GitHub OAuth endpoint base URL for the native device flow. |
|
|
8656
|
+
| <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. |
|
|
8657
|
+
| <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; |
|
|
8658
|
+
| <code><a href="#mise-projen.SettingsGithub.property.oauthOpenBrowser">oauthOpenBrowser</a></code> | <code>boolean</code> | Open the verification page in your browser during the native GitHub OAuth device flow. |
|
|
8595
8659
|
| <code><a href="#mise-projen.SettingsGithub.property.oauthScopes">oauthScopes</a></code> | <code>string</code> | OAuth scopes requested for native GitHub device-flow tokens. |
|
|
8596
|
-
| <code><a href="#mise-projen.SettingsGithub.property.slsa">slsa</a></code> | <code>boolean</code> |
|
|
8597
|
-
| <code><a href="#mise-projen.SettingsGithub.property.useGitCredentials">useGitCredentials</a></code> | <code>boolean</code> |
|
|
8660
|
+
| <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. |
|
|
8661
|
+
| <code><a href="#mise-projen.SettingsGithub.property.useGitCredentials">useGitCredentials</a></code> | <code>boolean</code> | Get GitHub tokens from your Git credential helpers with `git credential fill`. |
|
|
8598
8662
|
|
|
8599
8663
|
---
|
|
8600
8664
|
|
|
@@ -8606,7 +8670,7 @@ public readonly credentialCommand: string;
|
|
|
8606
8670
|
|
|
8607
8671
|
- *Type:* string
|
|
8608
8672
|
|
|
8609
|
-
|
|
8673
|
+
Command that prints a GitHub token on stdout.
|
|
8610
8674
|
|
|
8611
8675
|
---
|
|
8612
8676
|
|
|
@@ -8618,7 +8682,7 @@ public readonly ghCliTokens: boolean;
|
|
|
8618
8682
|
|
|
8619
8683
|
- *Type:* boolean
|
|
8620
8684
|
|
|
8621
|
-
Read GitHub tokens
|
|
8685
|
+
Read GitHub tokens that the gh CLI stores in its `hosts.yml` file.
|
|
8622
8686
|
|
|
8623
8687
|
---
|
|
8624
8688
|
|
|
@@ -8630,7 +8694,7 @@ public readonly githubAttestations: boolean;
|
|
|
8630
8694
|
|
|
8631
8695
|
- *Type:* boolean
|
|
8632
8696
|
|
|
8633
|
-
|
|
8697
|
+
Verify GitHub artifact attestations for github backend tools.
|
|
8634
8698
|
|
|
8635
8699
|
---
|
|
8636
8700
|
|
|
@@ -8642,7 +8706,7 @@ public readonly oauthApiUrl: string;
|
|
|
8642
8706
|
|
|
8643
8707
|
- *Type:* string
|
|
8644
8708
|
|
|
8645
|
-
GitHub API base URL
|
|
8709
|
+
GitHub API base URL mise uses to validate native OAuth tokens.
|
|
8646
8710
|
|
|
8647
8711
|
---
|
|
8648
8712
|
|
|
@@ -8654,7 +8718,7 @@ public readonly oauthAuthUrl: string;
|
|
|
8654
8718
|
|
|
8655
8719
|
- *Type:* string
|
|
8656
8720
|
|
|
8657
|
-
GitHub OAuth endpoint base URL for native device
|
|
8721
|
+
GitHub OAuth endpoint base URL for the native device flow.
|
|
8658
8722
|
|
|
8659
8723
|
---
|
|
8660
8724
|
|
|
@@ -8666,7 +8730,7 @@ public readonly oauthClientId: string;
|
|
|
8666
8730
|
|
|
8667
8731
|
- *Type:* string
|
|
8668
8732
|
|
|
8669
|
-
GitHub App client ID
|
|
8733
|
+
GitHub App client ID that turns on native OAuth device-flow tokens.
|
|
8670
8734
|
|
|
8671
8735
|
---
|
|
8672
8736
|
|
|
@@ -8678,7 +8742,9 @@ public readonly oauthExportEnv: string;
|
|
|
8678
8742
|
|
|
8679
8743
|
- *Type:* string
|
|
8680
8744
|
|
|
8681
|
-
Environment variable
|
|
8745
|
+
Environment variable that mise exports the native GitHub OAuth token under;
|
|
8746
|
+
|
|
8747
|
+
empty turns the export off.
|
|
8682
8748
|
|
|
8683
8749
|
---
|
|
8684
8750
|
|
|
@@ -8690,7 +8756,7 @@ public readonly oauthOpenBrowser: boolean;
|
|
|
8690
8756
|
|
|
8691
8757
|
- *Type:* boolean
|
|
8692
8758
|
|
|
8693
|
-
Open the browser during native GitHub OAuth device flow.
|
|
8759
|
+
Open the verification page in your browser during the native GitHub OAuth device flow.
|
|
8694
8760
|
|
|
8695
8761
|
---
|
|
8696
8762
|
|
|
@@ -8714,7 +8780,7 @@ public readonly slsa: boolean;
|
|
|
8714
8780
|
|
|
8715
8781
|
- *Type:* boolean
|
|
8716
8782
|
|
|
8717
|
-
|
|
8783
|
+
Verify SLSA provenance for github backend tools that name a signer.
|
|
8718
8784
|
|
|
8719
8785
|
---
|
|
8720
8786
|
|
|
@@ -8726,7 +8792,7 @@ public readonly useGitCredentials: boolean;
|
|
|
8726
8792
|
|
|
8727
8793
|
- *Type:* boolean
|
|
8728
8794
|
|
|
8729
|
-
|
|
8795
|
+
Get GitHub tokens from your Git credential helpers with `git credential fill`.
|
|
8730
8796
|
|
|
8731
8797
|
---
|
|
8732
8798
|
|
|
@@ -8744,11 +8810,11 @@ const settingsGithubRelay: SettingsGithubRelay = { ... }
|
|
|
8744
8810
|
|
|
8745
8811
|
| **Name** | **Type** | **Description** |
|
|
8746
8812
|
| --- | --- | --- |
|
|
8747
|
-
| <code><a href="#mise-projen.SettingsGithubRelay.property.concurrency">concurrency</a></code> | <code>number</code> | Maximum
|
|
8748
|
-
| <code><a href="#mise-projen.SettingsGithubRelay.property.logFormat">logFormat</a></code> | <code>
|
|
8749
|
-
| <code><a href="#mise-projen.SettingsGithubRelay.property.logRequests">logRequests</a></code> | <code>boolean</code> | Log
|
|
8750
|
-
| <code><a href="#mise-projen.SettingsGithubRelay.property.maxDuration">maxDuration</a></code> | <code>string</code> |
|
|
8751
|
-
| <code><a href="#mise-projen.SettingsGithubRelay.property.requestTimeout">requestTimeout</a></code> | <code>string</code> |
|
|
8813
|
+
| <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; |
|
|
8814
|
+
| <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. |
|
|
8815
|
+
| <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. |
|
|
8816
|
+
| <code><a href="#mise-projen.SettingsGithubRelay.property.maxDuration">maxDuration</a></code> | <code>string</code> | How long a GitHub relay lends access; |
|
|
8817
|
+
| <code><a href="#mise-projen.SettingsGithubRelay.property.requestTimeout">requestTimeout</a></code> | <code>string</code> | Time limit for one relayed GitHub request, including streaming its response. |
|
|
8752
8818
|
|
|
8753
8819
|
---
|
|
8754
8820
|
|
|
@@ -8760,21 +8826,21 @@ public readonly concurrency: number;
|
|
|
8760
8826
|
|
|
8761
8827
|
- *Type:* number
|
|
8762
8828
|
|
|
8763
|
-
Maximum
|
|
8829
|
+
Maximum relayed GitHub requests that run at once, from 1 to 32;
|
|
8764
8830
|
|
|
8765
|
-
|
|
8831
|
+
more requests fail instead of waiting.
|
|
8766
8832
|
|
|
8767
8833
|
---
|
|
8768
8834
|
|
|
8769
8835
|
##### `logFormat`<sup>Optional</sup> <a name="logFormat" id="mise-projen.SettingsGithubRelay.property.logFormat"></a>
|
|
8770
8836
|
|
|
8771
8837
|
```typescript
|
|
8772
|
-
public readonly logFormat:
|
|
8838
|
+
public readonly logFormat: SettingsGithubRelayLogFormat;
|
|
8773
8839
|
```
|
|
8774
8840
|
|
|
8775
|
-
- *Type:*
|
|
8841
|
+
- *Type:* <a href="#mise-projen.SettingsGithubRelayLogFormat">SettingsGithubRelayLogFormat</a>
|
|
8776
8842
|
|
|
8777
|
-
GitHub relay request and
|
|
8843
|
+
Format of GitHub relay request logs and the end-of-session summary.
|
|
8778
8844
|
|
|
8779
8845
|
---
|
|
8780
8846
|
|
|
@@ -8786,7 +8852,7 @@ public readonly logRequests: boolean;
|
|
|
8786
8852
|
|
|
8787
8853
|
- *Type:* boolean
|
|
8788
8854
|
|
|
8789
|
-
Log
|
|
8855
|
+
Log each relayed GitHub request, without credentials, on this machine's stderr.
|
|
8790
8856
|
|
|
8791
8857
|
---
|
|
8792
8858
|
|
|
@@ -8798,9 +8864,9 @@ public readonly maxDuration: string;
|
|
|
8798
8864
|
|
|
8799
8865
|
- *Type:* string
|
|
8800
8866
|
|
|
8801
|
-
|
|
8867
|
+
How long a GitHub relay lends access;
|
|
8802
8868
|
|
|
8803
|
-
0s
|
|
8869
|
+
`0s` lasts until the session ends.
|
|
8804
8870
|
|
|
8805
8871
|
---
|
|
8806
8872
|
|
|
@@ -8812,7 +8878,7 @@ public readonly requestTimeout: string;
|
|
|
8812
8878
|
|
|
8813
8879
|
- *Type:* string
|
|
8814
8880
|
|
|
8815
|
-
|
|
8881
|
+
Time limit for one relayed GitHub request, including streaming its response.
|
|
8816
8882
|
|
|
8817
8883
|
---
|
|
8818
8884
|
|
|
@@ -8830,9 +8896,9 @@ const settingsGitlab: SettingsGitlab = { ... }
|
|
|
8830
8896
|
|
|
8831
8897
|
| **Name** | **Type** | **Description** |
|
|
8832
8898
|
| --- | --- | --- |
|
|
8833
|
-
| <code><a href="#mise-projen.SettingsGitlab.property.credentialCommand">credentialCommand</a></code> | <code>string</code> |
|
|
8834
|
-
| <code><a href="#mise-projen.SettingsGitlab.property.glabCliTokens">glabCliTokens</a></code> | <code>boolean</code> | Read GitLab tokens
|
|
8835
|
-
| <code><a href="#mise-projen.SettingsGitlab.property.useGitCredentials">useGitCredentials</a></code> | <code>boolean</code> |
|
|
8899
|
+
| <code><a href="#mise-projen.SettingsGitlab.property.credentialCommand">credentialCommand</a></code> | <code>string</code> | Command that prints a GitLab token on stdout. |
|
|
8900
|
+
| <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. |
|
|
8901
|
+
| <code><a href="#mise-projen.SettingsGitlab.property.useGitCredentials">useGitCredentials</a></code> | <code>boolean</code> | Get GitLab tokens from your Git credential helpers with `git credential fill`. |
|
|
8836
8902
|
|
|
8837
8903
|
---
|
|
8838
8904
|
|
|
@@ -8844,7 +8910,7 @@ public readonly credentialCommand: string;
|
|
|
8844
8910
|
|
|
8845
8911
|
- *Type:* string
|
|
8846
8912
|
|
|
8847
|
-
|
|
8913
|
+
Command that prints a GitLab token on stdout.
|
|
8848
8914
|
|
|
8849
8915
|
---
|
|
8850
8916
|
|
|
@@ -8856,7 +8922,7 @@ public readonly glabCliTokens: boolean;
|
|
|
8856
8922
|
|
|
8857
8923
|
- *Type:* boolean
|
|
8858
8924
|
|
|
8859
|
-
Read GitLab tokens
|
|
8925
|
+
Read GitLab tokens that the glab CLI stores in its `config.yml` file.
|
|
8860
8926
|
|
|
8861
8927
|
---
|
|
8862
8928
|
|
|
@@ -8868,7 +8934,7 @@ public readonly useGitCredentials: boolean;
|
|
|
8868
8934
|
|
|
8869
8935
|
- *Type:* boolean
|
|
8870
8936
|
|
|
8871
|
-
|
|
8937
|
+
Get GitLab tokens from your Git credential helpers with `git credential fill`.
|
|
8872
8938
|
|
|
8873
8939
|
---
|
|
8874
8940
|
|
|
@@ -8886,13 +8952,13 @@ const settingsGo: SettingsGo = { ... }
|
|
|
8886
8952
|
|
|
8887
8953
|
| **Name** | **Type** | **Description** |
|
|
8888
8954
|
| --- | --- | --- |
|
|
8889
|
-
| <code><a href="#mise-projen.SettingsGo.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> |
|
|
8890
|
-
| <code><a href="#mise-projen.SettingsGo.property.downloadMirror">downloadMirror</a></code> | <code>string</code> |
|
|
8891
|
-
| <code><a href="#mise-projen.SettingsGo.property.repo">repo</a></code> | <code>string</code> |
|
|
8892
|
-
| <code><a href="#mise-projen.SettingsGo.property.setGobin">setGobin</a></code> | <code>boolean</code> |
|
|
8893
|
-
| <code><a href="#mise-projen.SettingsGo.property.setGopath">setGopath</a></code> | <code>boolean</code> | [deprecated] Set to
|
|
8894
|
-
| <code><a href="#mise-projen.SettingsGo.property.setGoroot">setGoroot</a></code> | <code>boolean</code> |
|
|
8895
|
-
| <code><a href="#mise-projen.SettingsGo.property.skipChecksum">skipChecksum</a></code> | <code>boolean</code> |
|
|
8955
|
+
| <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. |
|
|
8956
|
+
| <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. |
|
|
8957
|
+
| <code><a href="#mise-projen.SettingsGo.property.repo">repo</a></code> | <code>string</code> | Git repository mise lists Go versions from. |
|
|
8958
|
+
| <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. |
|
|
8959
|
+
| <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. |
|
|
8960
|
+
| <code><a href="#mise-projen.SettingsGo.property.setGoroot">setGoroot</a></code> | <code>boolean</code> | Set `GOROOT` to the active Go version's install directory. |
|
|
8961
|
+
| <code><a href="#mise-projen.SettingsGo.property.skipChecksum">skipChecksum</a></code> | <code>boolean</code> | Skip SHA-256 verification of Go downloads. |
|
|
8896
8962
|
|
|
8897
8963
|
---
|
|
8898
8964
|
|
|
@@ -8904,7 +8970,7 @@ public readonly defaultPackagesFile: string;
|
|
|
8904
8970
|
|
|
8905
8971
|
- *Type:* string
|
|
8906
8972
|
|
|
8907
|
-
|
|
8973
|
+
[deprecated] File listing Go packages to install with every Go version.
|
|
8908
8974
|
|
|
8909
8975
|
---
|
|
8910
8976
|
|
|
@@ -8916,7 +8982,7 @@ public readonly downloadMirror: string;
|
|
|
8916
8982
|
|
|
8917
8983
|
- *Type:* string
|
|
8918
8984
|
|
|
8919
|
-
|
|
8985
|
+
Base URL that mise downloads Go archives and their checksums from.
|
|
8920
8986
|
|
|
8921
8987
|
---
|
|
8922
8988
|
|
|
@@ -8928,7 +8994,7 @@ public readonly repo: string;
|
|
|
8928
8994
|
|
|
8929
8995
|
- *Type:* string
|
|
8930
8996
|
|
|
8931
|
-
|
|
8997
|
+
Git repository mise lists Go versions from.
|
|
8932
8998
|
|
|
8933
8999
|
---
|
|
8934
9000
|
|
|
@@ -8940,7 +9006,7 @@ public readonly setGobin: boolean;
|
|
|
8940
9006
|
|
|
8941
9007
|
- *Type:* boolean
|
|
8942
9008
|
|
|
8943
|
-
|
|
9009
|
+
Set `GOBIN` so `go install` puts binaries in the active Go version's directory.
|
|
8944
9010
|
|
|
8945
9011
|
---
|
|
8946
9012
|
|
|
@@ -8952,7 +9018,7 @@ public readonly setGopath: boolean;
|
|
|
8952
9018
|
|
|
8953
9019
|
- *Type:* boolean
|
|
8954
9020
|
|
|
8955
|
-
[deprecated] Set to
|
|
9021
|
+
[deprecated] Set `GOPATH` to the `packages` directory inside the active Go install.
|
|
8956
9022
|
|
|
8957
9023
|
---
|
|
8958
9024
|
|
|
@@ -8964,7 +9030,7 @@ public readonly setGoroot: boolean;
|
|
|
8964
9030
|
|
|
8965
9031
|
- *Type:* boolean
|
|
8966
9032
|
|
|
8967
|
-
|
|
9033
|
+
Set `GOROOT` to the active Go version's install directory.
|
|
8968
9034
|
|
|
8969
9035
|
---
|
|
8970
9036
|
|
|
@@ -8976,7 +9042,7 @@ public readonly skipChecksum: boolean;
|
|
|
8976
9042
|
|
|
8977
9043
|
- *Type:* boolean
|
|
8978
9044
|
|
|
8979
|
-
|
|
9045
|
+
Skip SHA-256 verification of Go downloads.
|
|
8980
9046
|
|
|
8981
9047
|
---
|
|
8982
9048
|
|
|
@@ -8994,13 +9060,13 @@ const settingsHistory: SettingsHistory = { ... }
|
|
|
8994
9060
|
|
|
8995
9061
|
| **Name** | **Type** | **Description** |
|
|
8996
9062
|
| --- | --- | --- |
|
|
8997
|
-
| <code><a href="#mise-projen.SettingsHistory.property.allowPlaintextHistory">allowPlaintextHistory</a></code> | <code>boolean</code> | Allow publishing history that
|
|
8998
|
-
| <code><a href="#mise-projen.SettingsHistory.property.describeCommand">describeCommand</a></code> | <code>string</code> |
|
|
8999
|
-
| <code><a href="#mise-projen.SettingsHistory.property.enabled">enabled</a></code> | <code>boolean</code> | Record
|
|
9000
|
-
| <code><a href="#mise-projen.SettingsHistory.property.fetchInterval">fetchInterval</a></code> | <code>string</code> | How often the history watcher fetches the
|
|
9001
|
-
| <code><a href="#mise-projen.SettingsHistory.property.notify">notify</a></code> | <code>boolean</code> | Show a desktop notification when
|
|
9002
|
-
| <code><a href="#mise-projen.SettingsHistory.property.sync">sync</a></code> | <code><a href="#mise-projen.SettingsHistorySync">SettingsHistorySync</a></code> | What the history watcher
|
|
9003
|
-
| <code><a href="#mise-projen.SettingsHistory.property.syncInterval">syncInterval</a></code> | <code>string</code> |
|
|
9063
|
+
| <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. |
|
|
9064
|
+
| <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. |
|
|
9065
|
+
| <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. |
|
|
9066
|
+
| <code><a href="#mise-projen.SettingsHistory.property.fetchInterval">fetchInterval</a></code> | <code>string</code> | How often the history watcher fetches from the setup repository. |
|
|
9067
|
+
| <code><a href="#mise-projen.SettingsHistory.property.notify">notify</a></code> | <code>boolean</code> | Show a desktop notification when a sync conflict pauses sharing. |
|
|
9068
|
+
| <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. |
|
|
9069
|
+
| <code><a href="#mise-projen.SettingsHistory.property.syncInterval">syncInterval</a></code> | <code>string</code> | Minimum time between automatic publishes to the setup repository after a save. |
|
|
9004
9070
|
| <code><a href="#mise-projen.SettingsHistory.property.watch">watch</a></code> | <code><a href="#mise-projen.SettingsHistoryWatch">SettingsHistoryWatch</a></code> | *No description.* |
|
|
9005
9071
|
|
|
9006
9072
|
---
|
|
@@ -9013,7 +9079,7 @@ public readonly allowPlaintextHistory: boolean;
|
|
|
9013
9079
|
|
|
9014
9080
|
- *Type:* boolean
|
|
9015
9081
|
|
|
9016
|
-
Allow publishing history that
|
|
9082
|
+
Allow publishing or applying history that holds plaintext copies of files now marked for encryption, or publishing versions that look like they contain secrets.
|
|
9017
9083
|
|
|
9018
9084
|
---
|
|
9019
9085
|
|
|
@@ -9025,9 +9091,7 @@ public readonly describeCommand: string;
|
|
|
9025
9091
|
|
|
9026
9092
|
- *Type:* string
|
|
9027
9093
|
|
|
9028
|
-
|
|
9029
|
-
|
|
9030
|
-
Empty: computed descriptions only.
|
|
9094
|
+
Command, such as an AI agent, that writes the description of each checkpoint the history watcher saves.
|
|
9031
9095
|
|
|
9032
9096
|
---
|
|
9033
9097
|
|
|
@@ -9039,7 +9103,7 @@ public readonly enabled: boolean;
|
|
|
9039
9103
|
|
|
9040
9104
|
- *Type:* boolean
|
|
9041
9105
|
|
|
9042
|
-
Record
|
|
9106
|
+
Record Git checkpoints of tracked files around bootstrap operations and on explicit saves.
|
|
9043
9107
|
|
|
9044
9108
|
---
|
|
9045
9109
|
|
|
@@ -9051,9 +9115,7 @@ public readonly fetchInterval: string;
|
|
|
9051
9115
|
|
|
9052
9116
|
- *Type:* string
|
|
9053
9117
|
|
|
9054
|
-
How often the history watcher fetches the
|
|
9055
|
-
|
|
9056
|
-
Values below one second use one second; use history.sync = 'manual' to disable automatic synchronization.
|
|
9118
|
+
How often the history watcher fetches from the setup repository.
|
|
9057
9119
|
|
|
9058
9120
|
---
|
|
9059
9121
|
|
|
@@ -9065,9 +9127,7 @@ public readonly notify: boolean;
|
|
|
9065
9127
|
|
|
9066
9128
|
- *Type:* boolean
|
|
9067
9129
|
|
|
9068
|
-
Show a desktop notification when
|
|
9069
|
-
|
|
9070
|
-
Enabled by default; retries stay silent until sharing recovers, and a notifier that is missing or failing never holds up history or sync.
|
|
9130
|
+
Show a desktop notification when a sync conflict pauses sharing.
|
|
9071
9131
|
|
|
9072
9132
|
---
|
|
9073
9133
|
|
|
@@ -9079,9 +9139,7 @@ public readonly sync: SettingsHistorySync;
|
|
|
9079
9139
|
|
|
9080
9140
|
- *Type:* <a href="#mise-projen.SettingsHistorySync">SettingsHistorySync</a>
|
|
9081
9141
|
|
|
9082
|
-
What the history watcher
|
|
9083
|
-
|
|
9084
|
-
Any conflict pauses publication and incoming application for the entire setup; local commits and fetching continue. `fetch-only` only fetches; `manual` does nothing automatically. `mise bootstrap dotfiles sync` and `pull` work on request in every mode.
|
|
9142
|
+
What the history watcher shares with a connected setup repository on its own.
|
|
9085
9143
|
|
|
9086
9144
|
---
|
|
9087
9145
|
|
|
@@ -9093,7 +9151,7 @@ public readonly syncInterval: string;
|
|
|
9093
9151
|
|
|
9094
9152
|
- *Type:* string
|
|
9095
9153
|
|
|
9096
|
-
|
|
9154
|
+
Minimum time between automatic publishes to the setup repository after a save.
|
|
9097
9155
|
|
|
9098
9156
|
---
|
|
9099
9157
|
|
|
@@ -9121,9 +9179,9 @@ const settingsHistoryWatch: SettingsHistoryWatch = { ... }
|
|
|
9121
9179
|
|
|
9122
9180
|
| **Name** | **Type** | **Description** |
|
|
9123
9181
|
| --- | --- | --- |
|
|
9124
|
-
| <code><a href="#mise-projen.SettingsHistoryWatch.property.debounce">debounce</a></code> | <code>string</code> | How long a changed file must stay
|
|
9125
|
-
| <code><a href="#mise-projen.SettingsHistoryWatch.property.maxInterval">maxInterval</a></code> | <code>string</code> |
|
|
9126
|
-
| <code><a href="#mise-projen.SettingsHistoryWatch.property.reconcile">reconcile</a></code> | <code>string</code> | How often the history watcher rescans
|
|
9182
|
+
| <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. |
|
|
9183
|
+
| <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. |
|
|
9184
|
+
| <code><a href="#mise-projen.SettingsHistoryWatch.property.reconcile">reconcile</a></code> | <code>string</code> | How often the history watcher rescans all tracked files for changes it missed. |
|
|
9127
9185
|
|
|
9128
9186
|
---
|
|
9129
9187
|
|
|
@@ -9135,9 +9193,7 @@ public readonly debounce: string;
|
|
|
9135
9193
|
|
|
9136
9194
|
- *Type:* string
|
|
9137
9195
|
|
|
9138
|
-
How long a changed file must stay
|
|
9139
|
-
|
|
9140
|
-
A file that keeps changing is stretched on its own and never delays the others.
|
|
9196
|
+
How long a changed file must stay unchanged before the history watcher saves it.
|
|
9141
9197
|
|
|
9142
9198
|
---
|
|
9143
9199
|
|
|
@@ -9149,9 +9205,7 @@ public readonly maxInterval: string;
|
|
|
9149
9205
|
|
|
9150
9206
|
- *Type:* string
|
|
9151
9207
|
|
|
9152
|
-
|
|
9153
|
-
|
|
9154
|
-
Sustained churn doubles a file's own interval up to this; a settled file is saved promptly again, and a sustained quiet period resets it.
|
|
9208
|
+
Longest save interval the history watcher uses for a file that changes constantly.
|
|
9155
9209
|
|
|
9156
9210
|
---
|
|
9157
9211
|
|
|
@@ -9163,9 +9217,7 @@ public readonly reconcile: string;
|
|
|
9163
9217
|
|
|
9164
9218
|
- *Type:* string
|
|
9165
9219
|
|
|
9166
|
-
How often the history watcher rescans
|
|
9167
|
-
|
|
9168
|
-
`0` disables periodic reconciliation (startup and configuration changes still reconcile).
|
|
9220
|
+
How often the history watcher rescans all tracked files for changes it missed.
|
|
9169
9221
|
|
|
9170
9222
|
---
|
|
9171
9223
|
|
|
@@ -9183,8 +9235,8 @@ const settingsHookEnv: SettingsHookEnv = { ... }
|
|
|
9183
9235
|
|
|
9184
9236
|
| **Name** | **Type** | **Description** |
|
|
9185
9237
|
| --- | --- | --- |
|
|
9186
|
-
| <code><a href="#mise-projen.SettingsHookEnv.property.cacheTtl">cacheTtl</a></code> | <code>string</code> |
|
|
9187
|
-
| <code><a href="#mise-projen.SettingsHookEnv.property.chpwdOnly">chpwdOnly</a></code> | <code>boolean</code> |
|
|
9238
|
+
| <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. |
|
|
9239
|
+
| <code><a href="#mise-projen.SettingsHookEnv.property.chpwdOnly">chpwdOnly</a></code> | <code>boolean</code> | Run the shell hook's full config check only when you change directories, not at every prompt. |
|
|
9188
9240
|
|
|
9189
9241
|
---
|
|
9190
9242
|
|
|
@@ -9196,9 +9248,7 @@ public readonly cacheTtl: string;
|
|
|
9196
9248
|
|
|
9197
9249
|
- *Type:* string
|
|
9198
9250
|
|
|
9199
|
-
|
|
9200
|
-
|
|
9201
|
-
Useful for slow filesystems like NFS.
|
|
9251
|
+
How long the shell hook reuses its last config file check, for slow filesystems such as NFS.
|
|
9202
9252
|
|
|
9203
9253
|
---
|
|
9204
9254
|
|
|
@@ -9210,7 +9260,7 @@ public readonly chpwdOnly: boolean;
|
|
|
9210
9260
|
|
|
9211
9261
|
- *Type:* boolean
|
|
9212
9262
|
|
|
9213
|
-
|
|
9263
|
+
Run the shell hook's full config check only when you change directories, not at every prompt.
|
|
9214
9264
|
|
|
9215
9265
|
---
|
|
9216
9266
|
|
|
@@ -9228,7 +9278,7 @@ const settingsJava: SettingsJava = { ... }
|
|
|
9228
9278
|
|
|
9229
9279
|
| **Name** | **Type** | **Description** |
|
|
9230
9280
|
| --- | --- | --- |
|
|
9231
|
-
| <code><a href="#mise-projen.SettingsJava.property.shorthandVendor">shorthandVendor</a></code> | <code>string</code> |
|
|
9281
|
+
| <code><a href="#mise-projen.SettingsJava.property.shorthandVendor">shorthandVendor</a></code> | <code>string</code> | Vendor used for a Java version without a vendor prefix, such as `java@21`. |
|
|
9232
9282
|
|
|
9233
9283
|
---
|
|
9234
9284
|
|
|
@@ -9240,9 +9290,7 @@ public readonly shorthandVendor: string;
|
|
|
9240
9290
|
|
|
9241
9291
|
- *Type:* string
|
|
9242
9292
|
|
|
9243
|
-
|
|
9244
|
-
|
|
9245
|
-
Used when installing Java without a vendor prefix.
|
|
9293
|
+
Vendor used for a Java version without a vendor prefix, such as `java@21`.
|
|
9246
9294
|
|
|
9247
9295
|
---
|
|
9248
9296
|
|
|
@@ -9260,24 +9308,24 @@ const settingsNode: SettingsNode = { ... }
|
|
|
9260
9308
|
|
|
9261
9309
|
| **Name** | **Type** | **Description** |
|
|
9262
9310
|
| --- | --- | --- |
|
|
9263
|
-
| <code><a href="#mise-projen.SettingsNode.property.applyPatches">applyPatches</a></code> | <code>string</code> |
|
|
9264
|
-
| <code><a href="#mise-projen.SettingsNode.property.cflags">cflags</a></code> | <code>string</code> |
|
|
9265
|
-
| <code><a href="#mise-projen.SettingsNode.property.compile">compile</a></code> | <code>boolean</code> | Compile
|
|
9266
|
-
| <code><a href="#mise-projen.SettingsNode.property.concurrency">concurrency</a></code> | <code>number</code> |
|
|
9267
|
-
| <code><a href="#mise-projen.SettingsNode.property.configureOpts">configureOpts</a></code> | <code>string</code> |
|
|
9268
|
-
| <code><a href="#mise-projen.SettingsNode.property.corepack">corepack</a></code> | <code>boolean</code> |
|
|
9269
|
-
| <code><a href="#mise-projen.SettingsNode.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> |
|
|
9270
|
-
| <code><a href="#mise-projen.SettingsNode.property.flavor">flavor</a></code> | <code>string</code> |
|
|
9271
|
-
| <code><a href="#mise-projen.SettingsNode.property.gpgVerify">gpgVerify</a></code> | <code>boolean</code> |
|
|
9272
|
-
| <code><a href="#mise-projen.SettingsNode.property.make">make</a></code> | <code>string</code> |
|
|
9273
|
-
| <code><a href="#mise-projen.SettingsNode.property.makeInstallOpts">makeInstallOpts</a></code> | <code>string</code> |
|
|
9274
|
-
| <code><a href="#mise-projen.SettingsNode.property.makeOpts">makeOpts</a></code> | <code>string</code> |
|
|
9275
|
-
| <code><a href="#mise-projen.SettingsNode.property.mirrorUrl">mirrorUrl</a></code> | <code>string</code> |
|
|
9276
|
-
| <code><a href="#mise-projen.SettingsNode.property.ninja">ninja</a></code> | <code>boolean</code> |
|
|
9277
|
-
| <code><a href="#mise-projen.SettingsNode.property.nodenvRoot">nodenvRoot</a></code> | <code>string</code> |
|
|
9278
|
-
| <code><a href="#mise-projen.SettingsNode.property.npmShim">npmShim</a></code> | <code>boolean</code> |
|
|
9279
|
-
| <code><a href="#mise-projen.SettingsNode.property.nvmDir">nvmDir</a></code> | <code>string</code> | Directory
|
|
9280
|
-
| <code><a href="#mise-projen.SettingsNode.property.verify">verify</a></code> | <code>boolean</code> | Verify the
|
|
9311
|
+
| <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. |
|
|
9312
|
+
| <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`. |
|
|
9313
|
+
| <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. |
|
|
9314
|
+
| <code><a href="#mise-projen.SettingsNode.property.concurrency">concurrency</a></code> | <code>number</code> | Number of parallel jobs (`make -j`) when compiling Node.js. |
|
|
9315
|
+
| <code><a href="#mise-projen.SettingsNode.property.configureOpts">configureOpts</a></code> | <code>string</code> | Extra arguments for `./configure` when compiling Node.js. |
|
|
9316
|
+
| <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. |
|
|
9317
|
+
| <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. |
|
|
9318
|
+
| <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`. |
|
|
9319
|
+
| <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. |
|
|
9320
|
+
| <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`. |
|
|
9321
|
+
| <code><a href="#mise-projen.SettingsNode.property.makeInstallOpts">makeInstallOpts</a></code> | <code>string</code> | Extra arguments for `make install` when compiling Node.js. |
|
|
9322
|
+
| <code><a href="#mise-projen.SettingsNode.property.makeOpts">makeOpts</a></code> | <code>string</code> | Extra arguments for `make` when compiling Node.js. |
|
|
9323
|
+
| <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. |
|
|
9324
|
+
| <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. |
|
|
9325
|
+
| <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. |
|
|
9326
|
+
| <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. |
|
|
9327
|
+
| <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. |
|
|
9328
|
+
| <code><a href="#mise-projen.SettingsNode.property.verify">verify</a></code> | <code>boolean</code> | Verify downloaded Node.js archives against the SHA-256 checksums in `SHASUMS256.txt`. |
|
|
9281
9329
|
|
|
9282
9330
|
---
|
|
9283
9331
|
|
|
@@ -9289,7 +9337,7 @@ public readonly applyPatches: string;
|
|
|
9289
9337
|
|
|
9290
9338
|
- *Type:* string
|
|
9291
9339
|
|
|
9292
|
-
|
|
9340
|
+
Patch files or URLs to apply to the Node.js source before building it.
|
|
9293
9341
|
|
|
9294
9342
|
---
|
|
9295
9343
|
|
|
@@ -9301,7 +9349,7 @@ public readonly cflags: string;
|
|
|
9301
9349
|
|
|
9302
9350
|
- *Type:* string
|
|
9303
9351
|
|
|
9304
|
-
|
|
9352
|
+
Extra `CFLAGS` for compiling Node.js, for example to replace `-O3`.
|
|
9305
9353
|
|
|
9306
9354
|
---
|
|
9307
9355
|
|
|
@@ -9313,7 +9361,7 @@ public readonly compile: boolean;
|
|
|
9313
9361
|
|
|
9314
9362
|
- *Type:* boolean
|
|
9315
9363
|
|
|
9316
|
-
Compile
|
|
9364
|
+
Compile Node.js from source instead of using a precompiled build.
|
|
9317
9365
|
|
|
9318
9366
|
---
|
|
9319
9367
|
|
|
@@ -9325,7 +9373,7 @@ public readonly concurrency: number;
|
|
|
9325
9373
|
|
|
9326
9374
|
- *Type:* number
|
|
9327
9375
|
|
|
9328
|
-
|
|
9376
|
+
Number of parallel jobs (`make -j`) when compiling Node.js.
|
|
9329
9377
|
|
|
9330
9378
|
---
|
|
9331
9379
|
|
|
@@ -9337,7 +9385,7 @@ public readonly configureOpts: string;
|
|
|
9337
9385
|
|
|
9338
9386
|
- *Type:* string
|
|
9339
9387
|
|
|
9340
|
-
|
|
9388
|
+
Extra arguments for `./configure` when compiling Node.js.
|
|
9341
9389
|
|
|
9342
9390
|
---
|
|
9343
9391
|
|
|
@@ -9349,7 +9397,7 @@ public readonly corepack: boolean;
|
|
|
9349
9397
|
|
|
9350
9398
|
- *Type:* boolean
|
|
9351
9399
|
|
|
9352
|
-
|
|
9400
|
+
Run `corepack enable` after installing a Node.js version, so `yarn` and `pnpm` go through Corepack.
|
|
9353
9401
|
|
|
9354
9402
|
---
|
|
9355
9403
|
|
|
@@ -9361,7 +9409,7 @@ public readonly defaultPackagesFile: string;
|
|
|
9361
9409
|
|
|
9362
9410
|
- *Type:* string
|
|
9363
9411
|
|
|
9364
|
-
|
|
9412
|
+
[deprecated] File listing npm packages to install globally into each new Node.js version.
|
|
9365
9413
|
|
|
9366
9414
|
---
|
|
9367
9415
|
|
|
@@ -9373,9 +9421,7 @@ public readonly flavor: string;
|
|
|
9373
9421
|
|
|
9374
9422
|
- *Type:* string
|
|
9375
9423
|
|
|
9376
|
-
|
|
9377
|
-
|
|
9378
|
-
Use with unofficial node build repo.
|
|
9424
|
+
Linux build flavor of Node.js to download, such as `musl` or `glibc-217`.
|
|
9379
9425
|
|
|
9380
9426
|
---
|
|
9381
9427
|
|
|
@@ -9387,9 +9433,7 @@ public readonly gpgVerify: boolean;
|
|
|
9387
9433
|
|
|
9388
9434
|
- *Type:* boolean
|
|
9389
9435
|
|
|
9390
|
-
|
|
9391
|
-
|
|
9392
|
-
Set to false to disable.
|
|
9436
|
+
Check the OpenPGP signature of the `SHASUMS256.txt` file that `node.verify` checks downloads against.
|
|
9393
9437
|
|
|
9394
9438
|
---
|
|
9395
9439
|
|
|
@@ -9401,7 +9445,7 @@ public readonly make: string;
|
|
|
9401
9445
|
|
|
9402
9446
|
- *Type:* string
|
|
9403
9447
|
|
|
9404
|
-
|
|
9448
|
+
Command to run instead of `make` when compiling Node.js, such as `gmake`.
|
|
9405
9449
|
|
|
9406
9450
|
---
|
|
9407
9451
|
|
|
@@ -9413,7 +9457,7 @@ public readonly makeInstallOpts: string;
|
|
|
9413
9457
|
|
|
9414
9458
|
- *Type:* string
|
|
9415
9459
|
|
|
9416
|
-
|
|
9460
|
+
Extra arguments for `make install` when compiling Node.js.
|
|
9417
9461
|
|
|
9418
9462
|
---
|
|
9419
9463
|
|
|
@@ -9425,7 +9469,7 @@ public readonly makeOpts: string;
|
|
|
9425
9469
|
|
|
9426
9470
|
- *Type:* string
|
|
9427
9471
|
|
|
9428
|
-
|
|
9472
|
+
Extra arguments for `make` when compiling Node.js.
|
|
9429
9473
|
|
|
9430
9474
|
---
|
|
9431
9475
|
|
|
@@ -9437,7 +9481,7 @@ public readonly mirrorUrl: string;
|
|
|
9437
9481
|
|
|
9438
9482
|
- *Type:* string
|
|
9439
9483
|
|
|
9440
|
-
|
|
9484
|
+
Base URL that mise downloads Node.js archives and their `SHASUMS256.txt` checksums from.
|
|
9441
9485
|
|
|
9442
9486
|
---
|
|
9443
9487
|
|
|
@@ -9449,7 +9493,7 @@ public readonly ninja: boolean;
|
|
|
9449
9493
|
|
|
9450
9494
|
- *Type:* boolean
|
|
9451
9495
|
|
|
9452
|
-
|
|
9496
|
+
Build Node.js with ninja instead of make when compiling from source.
|
|
9453
9497
|
|
|
9454
9498
|
---
|
|
9455
9499
|
|
|
@@ -9461,7 +9505,7 @@ public readonly nodenvRoot: string;
|
|
|
9461
9505
|
|
|
9462
9506
|
- *Type:* string
|
|
9463
9507
|
|
|
9464
|
-
|
|
9508
|
+
Root directory of nodenv, which `mise sync node --nodenv` imports Node.js versions from.
|
|
9465
9509
|
|
|
9466
9510
|
---
|
|
9467
9511
|
|
|
@@ -9473,9 +9517,7 @@ public readonly npmShim: boolean;
|
|
|
9473
9517
|
|
|
9474
9518
|
- *Type:* boolean
|
|
9475
9519
|
|
|
9476
|
-
|
|
9477
|
-
|
|
9478
|
-
Disable to let corepack or a global `npm install -g npm@...` manage `bin/npm` directly.
|
|
9520
|
+
Wrap each Node.js version's `npm` so that `npm install -g` runs `mise reshim` afterwards.
|
|
9479
9521
|
|
|
9480
9522
|
---
|
|
9481
9523
|
|
|
@@ -9487,7 +9529,7 @@ public readonly nvmDir: string;
|
|
|
9487
9529
|
|
|
9488
9530
|
- *Type:* string
|
|
9489
9531
|
|
|
9490
|
-
Directory
|
|
9532
|
+
Directory of nvm, which `mise sync node --nvm` imports Node.js versions from.
|
|
9491
9533
|
|
|
9492
9534
|
---
|
|
9493
9535
|
|
|
@@ -9499,7 +9541,7 @@ public readonly verify: boolean;
|
|
|
9499
9541
|
|
|
9500
9542
|
- *Type:* boolean
|
|
9501
9543
|
|
|
9502
|
-
Verify the
|
|
9544
|
+
Verify downloaded Node.js archives against the SHA-256 checksums in `SHASUMS256.txt`.
|
|
9503
9545
|
|
|
9504
9546
|
---
|
|
9505
9547
|
|
|
@@ -9517,9 +9559,9 @@ const settingsNpm: SettingsNpm = { ... }
|
|
|
9517
9559
|
|
|
9518
9560
|
| **Name** | **Type** | **Description** |
|
|
9519
9561
|
| --- | --- | --- |
|
|
9520
|
-
| <code><a href="#mise-projen.SettingsNpm.property.bun">bun</a></code> | <code>boolean</code> |
|
|
9521
|
-
| <code><a href="#mise-projen.SettingsNpm.property.packageManager">packageManager</a></code> | <code><a href="#mise-projen.SettingsNpmPackageManager">SettingsNpmPackageManager</a></code> | Package manager
|
|
9522
|
-
| <code><a href="#mise-projen.SettingsNpm.property.shellOut">shellOut</a></code> | <code>boolean</code> |
|
|
9562
|
+
| <code><a href="#mise-projen.SettingsNpm.property.bun">bun</a></code> | <code>boolean</code> | [deprecated] Install `npm:` tools with bun; |
|
|
9563
|
+
| <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. |
|
|
9564
|
+
| <code><a href="#mise-projen.SettingsNpm.property.shellOut">shellOut</a></code> | <code>boolean</code> | Use the npm CLI instead of mise's built-in client for `npm:` version metadata and default installs. |
|
|
9523
9565
|
|
|
9524
9566
|
---
|
|
9525
9567
|
|
|
@@ -9531,7 +9573,9 @@ public readonly bun: boolean;
|
|
|
9531
9573
|
|
|
9532
9574
|
- *Type:* boolean
|
|
9533
9575
|
|
|
9534
|
-
|
|
9576
|
+
[deprecated] Install `npm:` tools with bun;
|
|
9577
|
+
|
|
9578
|
+
same as `npm.package_manager = "bun"`.
|
|
9535
9579
|
|
|
9536
9580
|
---
|
|
9537
9581
|
|
|
@@ -9543,7 +9587,7 @@ public readonly packageManager: SettingsNpmPackageManager;
|
|
|
9543
9587
|
|
|
9544
9588
|
- *Type:* <a href="#mise-projen.SettingsNpmPackageManager">SettingsNpmPackageManager</a>
|
|
9545
9589
|
|
|
9546
|
-
Package manager
|
|
9590
|
+
Package manager that installs `npm:` tools.
|
|
9547
9591
|
|
|
9548
9592
|
---
|
|
9549
9593
|
|
|
@@ -9555,7 +9599,7 @@ public readonly shellOut: boolean;
|
|
|
9555
9599
|
|
|
9556
9600
|
- *Type:* boolean
|
|
9557
9601
|
|
|
9558
|
-
|
|
9602
|
+
Use the npm CLI instead of mise's built-in client for `npm:` version metadata and default installs.
|
|
9559
9603
|
|
|
9560
9604
|
---
|
|
9561
9605
|
|
|
@@ -9573,9 +9617,9 @@ const settingsOci: SettingsOci = { ... }
|
|
|
9573
9617
|
|
|
9574
9618
|
| **Name** | **Type** | **Description** |
|
|
9575
9619
|
| --- | --- | --- |
|
|
9576
|
-
| <code><a href="#mise-projen.SettingsOci.property.defaultFrom">defaultFrom</a></code> | <code>string</code> |
|
|
9577
|
-
| <code><a href="#mise-projen.SettingsOci.property.defaultMountPoint">defaultMountPoint</a></code> | <code>string</code> |
|
|
9578
|
-
| <code><a href="#mise-projen.SettingsOci.property.insecureRegistries">insecureRegistries</a></code> | <code>string[]</code> | Registries
|
|
9620
|
+
| <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. |
|
|
9621
|
+
| <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. |
|
|
9622
|
+
| <code><a href="#mise-projen.SettingsOci.property.insecureRegistries">insecureRegistries</a></code> | <code>string[]</code> | Registries, as `host` or `host:port`, that mise contacts over plain HTTP instead of HTTPS. |
|
|
9579
9623
|
|
|
9580
9624
|
---
|
|
9581
9625
|
|
|
@@ -9587,7 +9631,7 @@ public readonly defaultFrom: string;
|
|
|
9587
9631
|
|
|
9588
9632
|
- *Type:* string
|
|
9589
9633
|
|
|
9590
|
-
|
|
9634
|
+
[experimental] Base image for `mise oci` builds when neither `[oci].from` nor `--from` sets one.
|
|
9591
9635
|
|
|
9592
9636
|
---
|
|
9593
9637
|
|
|
@@ -9599,7 +9643,7 @@ public readonly defaultMountPoint: string;
|
|
|
9599
9643
|
|
|
9600
9644
|
- *Type:* string
|
|
9601
9645
|
|
|
9602
|
-
|
|
9646
|
+
[experimental] Directory inside `mise oci` images that holds tool installs, unless `[oci].mount_point` sets one.
|
|
9603
9647
|
|
|
9604
9648
|
---
|
|
9605
9649
|
|
|
@@ -9611,7 +9655,7 @@ public readonly insecureRegistries: string[];
|
|
|
9611
9655
|
|
|
9612
9656
|
- *Type:* string[]
|
|
9613
9657
|
|
|
9614
|
-
Registries
|
|
9658
|
+
Registries, as `host` or `host:port`, that mise contacts over plain HTTP instead of HTTPS.
|
|
9615
9659
|
|
|
9616
9660
|
---
|
|
9617
9661
|
|
|
@@ -9629,8 +9673,8 @@ const settingsOtel: SettingsOtel = { ... }
|
|
|
9629
9673
|
|
|
9630
9674
|
| **Name** | **Type** | **Description** |
|
|
9631
9675
|
| --- | --- | --- |
|
|
9632
|
-
| <code><a href="#mise-projen.SettingsOtel.property.enabled">enabled</a></code> | <code>boolean</code> | [experimental]
|
|
9633
|
-
| <code><a href="#mise-projen.SettingsOtel.property.logs">logs</a></code> | <code>boolean</code> | [experimental]
|
|
9676
|
+
| <code><a href="#mise-projen.SettingsOtel.property.enabled">enabled</a></code> | <code>boolean</code> | [experimental] Export OpenTelemetry traces of `mise run`. |
|
|
9677
|
+
| <code><a href="#mise-projen.SettingsOtel.property.logs">logs</a></code> | <code>boolean</code> | [experimental] Export each line of task stdout and stderr as an OpenTelemetry log record. |
|
|
9634
9678
|
|
|
9635
9679
|
---
|
|
9636
9680
|
|
|
@@ -9642,7 +9686,7 @@ public readonly enabled: boolean;
|
|
|
9642
9686
|
|
|
9643
9687
|
- *Type:* boolean
|
|
9644
9688
|
|
|
9645
|
-
[experimental]
|
|
9689
|
+
[experimental] Export OpenTelemetry traces of `mise run`.
|
|
9646
9690
|
|
|
9647
9691
|
---
|
|
9648
9692
|
|
|
@@ -9654,7 +9698,7 @@ public readonly logs: boolean;
|
|
|
9654
9698
|
|
|
9655
9699
|
- *Type:* boolean
|
|
9656
9700
|
|
|
9657
|
-
[experimental]
|
|
9701
|
+
[experimental] Export each line of task stdout and stderr as an OpenTelemetry log record.
|
|
9658
9702
|
|
|
9659
9703
|
---
|
|
9660
9704
|
|
|
@@ -9672,8 +9716,8 @@ const settingsPackslip: SettingsPackslip = { ... }
|
|
|
9672
9716
|
|
|
9673
9717
|
| **Name** | **Type** | **Description** |
|
|
9674
9718
|
| --- | --- | --- |
|
|
9675
|
-
| <code><a href="#mise-projen.SettingsPackslip.property.exec">exec</a></code> | <code>boolean</code> |
|
|
9676
|
-
| <code><a href="#mise-projen.SettingsPackslip.property.stampers">stampers</a></code> | <code>string[]</code> | Hosts
|
|
9719
|
+
| <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. |
|
|
9720
|
+
| <code><a href="#mise-projen.SettingsPackslip.property.stampers">stampers</a></code> | <code>string[]</code> | Hosts that must approve a packslip release before mise lists or installs it, each as `host=PIN`. |
|
|
9677
9721
|
|
|
9678
9722
|
---
|
|
9679
9723
|
|
|
@@ -9685,7 +9729,7 @@ public readonly exec: boolean;
|
|
|
9685
9729
|
|
|
9686
9730
|
- *Type:* boolean
|
|
9687
9731
|
|
|
9688
|
-
|
|
9732
|
+
Let packslip tools run their own executable at install time to generate resources, such as an agent skill.
|
|
9689
9733
|
|
|
9690
9734
|
---
|
|
9691
9735
|
|
|
@@ -9697,7 +9741,7 @@ public readonly stampers: string[];
|
|
|
9697
9741
|
|
|
9698
9742
|
- *Type:* string[]
|
|
9699
9743
|
|
|
9700
|
-
Hosts
|
|
9744
|
+
Hosts that must approve a packslip release before mise lists or installs it, each as `host=PIN`.
|
|
9701
9745
|
|
|
9702
9746
|
---
|
|
9703
9747
|
|
|
@@ -9715,8 +9759,8 @@ const settingsPipx: SettingsPipx = { ... }
|
|
|
9715
9759
|
|
|
9716
9760
|
| **Name** | **Type** | **Description** |
|
|
9717
9761
|
| --- | --- | --- |
|
|
9718
|
-
| <code><a href="#mise-projen.SettingsPipx.property.registryUrl">registryUrl</a></code> | <code>string</code> |
|
|
9719
|
-
| <code><a href="#mise-projen.SettingsPipx.property.uvx">uvx</a></code> | <code>boolean</code> |
|
|
9762
|
+
| <code><a href="#mise-projen.SettingsPipx.property.registryUrl">registryUrl</a></code> | <code>string</code> | Older name for `pypi.registry_url`. |
|
|
9763
|
+
| <code><a href="#mise-projen.SettingsPipx.property.uvx">uvx</a></code> | <code>boolean</code> | Older name for `pypi.uvx`. |
|
|
9720
9764
|
|
|
9721
9765
|
---
|
|
9722
9766
|
|
|
@@ -9728,7 +9772,7 @@ public readonly registryUrl: string;
|
|
|
9728
9772
|
|
|
9729
9773
|
- *Type:* string
|
|
9730
9774
|
|
|
9731
|
-
|
|
9775
|
+
Older name for `pypi.registry_url`.
|
|
9732
9776
|
|
|
9733
9777
|
---
|
|
9734
9778
|
|
|
@@ -9740,7 +9784,7 @@ public readonly uvx: boolean;
|
|
|
9740
9784
|
|
|
9741
9785
|
- *Type:* boolean
|
|
9742
9786
|
|
|
9743
|
-
|
|
9787
|
+
Older name for `pypi.uvx`.
|
|
9744
9788
|
|
|
9745
9789
|
---
|
|
9746
9790
|
|
|
@@ -9788,8 +9832,8 @@ const settingsPypi: SettingsPypi = { ... }
|
|
|
9788
9832
|
|
|
9789
9833
|
| **Name** | **Type** | **Description** |
|
|
9790
9834
|
| --- | --- | --- |
|
|
9791
|
-
| <code><a href="#mise-projen.SettingsPypi.property.registryUrl">registryUrl</a></code> | <code>string</code> | Package
|
|
9792
|
-
| <code><a href="#mise-projen.SettingsPypi.property.uvx">uvx</a></code> | <code>boolean</code> |
|
|
9835
|
+
| <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. |
|
|
9836
|
+
| <code><a href="#mise-projen.SettingsPypi.property.uvx">uvx</a></code> | <code>boolean</code> | Install `pypi:` tools with uv when uv is available, and with pipx otherwise. |
|
|
9793
9837
|
|
|
9794
9838
|
---
|
|
9795
9839
|
|
|
@@ -9801,7 +9845,7 @@ public readonly registryUrl: string;
|
|
|
9801
9845
|
|
|
9802
9846
|
- *Type:* string
|
|
9803
9847
|
|
|
9804
|
-
Package
|
|
9848
|
+
Package index URL that `pypi:` tools list versions from, with `{}` in place of the package name.
|
|
9805
9849
|
|
|
9806
9850
|
---
|
|
9807
9851
|
|
|
@@ -9813,7 +9857,7 @@ public readonly uvx: boolean;
|
|
|
9813
9857
|
|
|
9814
9858
|
- *Type:* boolean
|
|
9815
9859
|
|
|
9816
|
-
|
|
9860
|
+
Install `pypi:` tools with uv when uv is available, and with pipx otherwise.
|
|
9817
9861
|
|
|
9818
9862
|
---
|
|
9819
9863
|
|
|
@@ -9831,19 +9875,19 @@ const settingsPython: SettingsPython = { ... }
|
|
|
9831
9875
|
|
|
9832
9876
|
| **Name** | **Type** | **Description** |
|
|
9833
9877
|
| --- | --- | --- |
|
|
9834
|
-
| <code><a href="#mise-projen.SettingsPython.property.compile">compile</a></code> | <code>boolean</code> |
|
|
9835
|
-
| <code><a href="#mise-projen.SettingsPython.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> |
|
|
9836
|
-
| <code><a href="#mise-projen.SettingsPython.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> |
|
|
9837
|
-
| <code><a href="#mise-projen.SettingsPython.property.patchesDirectory">patchesDirectory</a></code> | <code>string</code> | Directory
|
|
9838
|
-
| <code><a href="#mise-projen.SettingsPython.property.patchUrl">patchUrl</a></code> | <code>string</code> | URL
|
|
9839
|
-
| <code><a href="#mise-projen.SettingsPython.property.precompiledArch">precompiledArch</a></code> | <code>string</code> |
|
|
9840
|
-
| <code><a href="#mise-projen.SettingsPython.property.precompiledFlavor">precompiledFlavor</a></code> | <code>string</code> |
|
|
9841
|
-
| <code><a href="#mise-projen.SettingsPython.property.precompiledOs">precompiledOs</a></code> | <code>string</code> |
|
|
9842
|
-
| <code><a href="#mise-projen.SettingsPython.property.pyenvRepo">pyenvRepo</a></code> | <code>string</code> |
|
|
9843
|
-
| <code><a href="#mise-projen.SettingsPython.property.uvVenvAuto">uvVenvAuto</a></code> | <code><a href="#mise-projen.SettingsPythonUvVenvAuto">SettingsPythonUvVenvAuto</a></code> |
|
|
9844
|
-
| <code><a href="#mise-projen.SettingsPython.property.uvVenvCreateArgs">uvVenvCreateArgs</a></code> | <code>string[]</code> | Arguments
|
|
9845
|
-
| <code><a href="#mise-projen.SettingsPython.property.venvCreateArgs">venvCreateArgs</a></code> | <code>string[]</code> | Arguments
|
|
9846
|
-
| <code><a href="#mise-projen.SettingsPython.property.venvStdlib">venvStdlib</a></code> | <code>boolean</code> |
|
|
9878
|
+
| <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. |
|
|
9879
|
+
| <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. |
|
|
9880
|
+
| <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. |
|
|
9881
|
+
| <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. |
|
|
9882
|
+
| <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. |
|
|
9883
|
+
| <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`. |
|
|
9884
|
+
| <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`. |
|
|
9885
|
+
| <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`. |
|
|
9886
|
+
| <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. |
|
|
9887
|
+
| <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. |
|
|
9888
|
+
| <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. |
|
|
9889
|
+
| <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. |
|
|
9890
|
+
| <code><a href="#mise-projen.SettingsPython.property.venvStdlib">venvStdlib</a></code> | <code>boolean</code> | Create `_.python.venv` virtualenvs with `python -m venv` even when uv is installed. |
|
|
9847
9891
|
|
|
9848
9892
|
---
|
|
9849
9893
|
|
|
@@ -9855,9 +9899,7 @@ public readonly compile: boolean;
|
|
|
9855
9899
|
|
|
9856
9900
|
- *Type:* boolean
|
|
9857
9901
|
|
|
9858
|
-
|
|
9859
|
-
|
|
9860
|
-
If false, use precompiled binaries. If not set, use precompiled binaries if available.
|
|
9902
|
+
Compile Python from source with python-build instead of using a precompiled build.
|
|
9861
9903
|
|
|
9862
9904
|
---
|
|
9863
9905
|
|
|
@@ -9869,7 +9911,7 @@ public readonly defaultPackagesFile: string;
|
|
|
9869
9911
|
|
|
9870
9912
|
- *Type:* string
|
|
9871
9913
|
|
|
9872
|
-
|
|
9914
|
+
[deprecated] Requirements file that mise installs with pip into each new Python version.
|
|
9873
9915
|
|
|
9874
9916
|
---
|
|
9875
9917
|
|
|
@@ -9881,7 +9923,7 @@ public readonly githubAttestations: boolean;
|
|
|
9881
9923
|
|
|
9882
9924
|
- *Type:* boolean
|
|
9883
9925
|
|
|
9884
|
-
|
|
9926
|
+
Verify GitHub artifact attestations of precompiled Python builds from python-build-standalone.
|
|
9885
9927
|
|
|
9886
9928
|
---
|
|
9887
9929
|
|
|
@@ -9893,7 +9935,7 @@ public readonly patchesDirectory: string;
|
|
|
9893
9935
|
|
|
9894
9936
|
- *Type:* string
|
|
9895
9937
|
|
|
9896
|
-
Directory
|
|
9938
|
+
Directory of per-version patches for the Python versions that python-build compiles.
|
|
9897
9939
|
|
|
9898
9940
|
---
|
|
9899
9941
|
|
|
@@ -9905,7 +9947,7 @@ public readonly patchUrl: string;
|
|
|
9905
9947
|
|
|
9906
9948
|
- *Type:* string
|
|
9907
9949
|
|
|
9908
|
-
URL
|
|
9950
|
+
URL of a patch that python-build applies to every Python version it compiles.
|
|
9909
9951
|
|
|
9910
9952
|
---
|
|
9911
9953
|
|
|
@@ -9917,7 +9959,7 @@ public readonly precompiledArch: string;
|
|
|
9917
9959
|
|
|
9918
9960
|
- *Type:* string
|
|
9919
9961
|
|
|
9920
|
-
|
|
9962
|
+
Architecture of the python-build-standalone build that mise downloads, such as `x86_64_v3` or `aarch64`.
|
|
9921
9963
|
|
|
9922
9964
|
---
|
|
9923
9965
|
|
|
@@ -9929,7 +9971,7 @@ public readonly precompiledFlavor: string;
|
|
|
9929
9971
|
|
|
9930
9972
|
- *Type:* string
|
|
9931
9973
|
|
|
9932
|
-
|
|
9974
|
+
Build flavor of python-build-standalone to download, such as `install_only` or `freethreaded-install_only_stripped`.
|
|
9933
9975
|
|
|
9934
9976
|
---
|
|
9935
9977
|
|
|
@@ -9941,7 +9983,7 @@ public readonly precompiledOs: string;
|
|
|
9941
9983
|
|
|
9942
9984
|
- *Type:* string
|
|
9943
9985
|
|
|
9944
|
-
|
|
9986
|
+
OS part of the python-build-standalone build name that mise downloads, such as `unknown-linux-musl`.
|
|
9945
9987
|
|
|
9946
9988
|
---
|
|
9947
9989
|
|
|
@@ -9953,7 +9995,7 @@ public readonly pyenvRepo: string;
|
|
|
9953
9995
|
|
|
9954
9996
|
- *Type:* string
|
|
9955
9997
|
|
|
9956
|
-
|
|
9998
|
+
Git repository that mise clones pyenv from to get python-build.
|
|
9957
9999
|
|
|
9958
10000
|
---
|
|
9959
10001
|
|
|
@@ -9965,7 +10007,7 @@ public readonly uvVenvAuto: SettingsPythonUvVenvAuto;
|
|
|
9965
10007
|
|
|
9966
10008
|
- *Type:* <a href="#mise-projen.SettingsPythonUvVenvAuto">SettingsPythonUvVenvAuto</a>
|
|
9967
10009
|
|
|
9968
|
-
|
|
10010
|
+
Activate, and optionally create, the virtualenv of the uv project around the current directory.
|
|
9969
10011
|
|
|
9970
10012
|
---
|
|
9971
10013
|
|
|
@@ -9977,7 +10019,7 @@ public readonly uvVenvCreateArgs: string[];
|
|
|
9977
10019
|
|
|
9978
10020
|
- *Type:* string[]
|
|
9979
10021
|
|
|
9980
|
-
Arguments
|
|
10022
|
+
Arguments for `uv venv` when mise creates a virtualenv with uv.
|
|
9981
10023
|
|
|
9982
10024
|
---
|
|
9983
10025
|
|
|
@@ -9989,9 +10031,7 @@ public readonly venvCreateArgs: string[];
|
|
|
9989
10031
|
|
|
9990
10032
|
- *Type:* string[]
|
|
9991
10033
|
|
|
9992
|
-
Arguments
|
|
9993
|
-
|
|
9994
|
-
(not used for uv venv creation)
|
|
10034
|
+
Arguments for `python -m venv` when `_.python.venv` creates a virtualenv without uv.
|
|
9995
10035
|
|
|
9996
10036
|
---
|
|
9997
10037
|
|
|
@@ -10003,7 +10043,7 @@ public readonly venvStdlib: boolean;
|
|
|
10003
10043
|
|
|
10004
10044
|
- *Type:* boolean
|
|
10005
10045
|
|
|
10006
|
-
|
|
10046
|
+
Create `_.python.venv` virtualenvs with `python -m venv` even when uv is installed.
|
|
10007
10047
|
|
|
10008
10048
|
---
|
|
10009
10049
|
|
|
@@ -10021,20 +10061,20 @@ const settingsRuby: SettingsRuby = { ... }
|
|
|
10021
10061
|
|
|
10022
10062
|
| **Name** | **Type** | **Description** |
|
|
10023
10063
|
| --- | --- | --- |
|
|
10024
|
-
| <code><a href="#mise-projen.SettingsRuby.property.applyPatches">applyPatches</a></code> | <code>string</code> |
|
|
10025
|
-
| <code><a href="#mise-projen.SettingsRuby.property.compile">compile</a></code> | <code>boolean</code> |
|
|
10026
|
-
| <code><a href="#mise-projen.SettingsRuby.property.defaultPackagesFile">defaultPackagesFile</a></code> | <code>string</code> |
|
|
10027
|
-
| <code><a href="#mise-projen.SettingsRuby.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> |
|
|
10028
|
-
| <code><a href="#mise-projen.SettingsRuby.property.precompiledArch">precompiledArch</a></code> | <code>string</code> |
|
|
10029
|
-
| <code><a href="#mise-projen.SettingsRuby.property.precompiledOs">precompiledOs</a></code> | <code>string</code> |
|
|
10030
|
-
| <code><a href="#mise-projen.SettingsRuby.property.precompiledUrl">precompiledUrl</a></code> | <code>string</code> | URL template
|
|
10031
|
-
| <code><a href="#mise-projen.SettingsRuby.property.rubyBuildCliOpts">rubyBuildCliOpts</a></code> | <code>string</code> |
|
|
10032
|
-
| <code><a href="#mise-projen.SettingsRuby.property.rubyBuildOpts">rubyBuildOpts</a></code> | <code>string</code> |
|
|
10033
|
-
| <code><a href="#mise-projen.SettingsRuby.property.rubyBuildRepo">rubyBuildRepo</a></code> | <code>string</code> |
|
|
10034
|
-
| <code><a href="#mise-projen.SettingsRuby.property.rubyInstall">rubyInstall</a></code> | <code>boolean</code> |
|
|
10035
|
-
| <code><a href="#mise-projen.SettingsRuby.property.rubyInstallOpts">rubyInstallOpts</a></code> | <code>string</code> |
|
|
10036
|
-
| <code><a href="#mise-projen.SettingsRuby.property.rubyInstallRepo">rubyInstallRepo</a></code> | <code>string</code> |
|
|
10037
|
-
| <code><a href="#mise-projen.SettingsRuby.property.verboseInstall">verboseInstall</a></code> | <code>boolean</code> |
|
|
10064
|
+
| <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. |
|
|
10065
|
+
| <code><a href="#mise-projen.SettingsRuby.property.compile">compile</a></code> | <code>boolean</code> | Compile Ruby from source instead of using a precompiled build. |
|
|
10066
|
+
| <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. |
|
|
10067
|
+
| <code><a href="#mise-projen.SettingsRuby.property.githubAttestations">githubAttestations</a></code> | <code>boolean</code> | Verify GitHub artifact attestations of precompiled Ruby builds. |
|
|
10068
|
+
| <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`. |
|
|
10069
|
+
| <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`. |
|
|
10070
|
+
| <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. |
|
|
10071
|
+
| <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. |
|
|
10072
|
+
| <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. |
|
|
10073
|
+
| <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. |
|
|
10074
|
+
| <code><a href="#mise-projen.SettingsRuby.property.rubyInstall">rubyInstall</a></code> | <code>boolean</code> | Compile Ruby with ruby-install instead of ruby-build. |
|
|
10075
|
+
| <code><a href="#mise-projen.SettingsRuby.property.rubyInstallOpts">rubyInstallOpts</a></code> | <code>string</code> | Arguments for Ruby's `configure`, passed through ruby-install. |
|
|
10076
|
+
| <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. |
|
|
10077
|
+
| <code><a href="#mise-projen.SettingsRuby.property.verboseInstall">verboseInstall</a></code> | <code>boolean</code> | Show ruby-build's full output while compiling Ruby. |
|
|
10038
10078
|
|
|
10039
10079
|
---
|
|
10040
10080
|
|
|
@@ -10046,7 +10086,7 @@ public readonly applyPatches: string;
|
|
|
10046
10086
|
|
|
10047
10087
|
- *Type:* string
|
|
10048
10088
|
|
|
10049
|
-
|
|
10089
|
+
Patch files or URLs to apply to the Ruby source before compiling it, one per line.
|
|
10050
10090
|
|
|
10051
10091
|
---
|
|
10052
10092
|
|
|
@@ -10058,9 +10098,7 @@ public readonly compile: boolean;
|
|
|
10058
10098
|
|
|
10059
10099
|
- *Type:* boolean
|
|
10060
10100
|
|
|
10061
|
-
|
|
10062
|
-
|
|
10063
|
-
If false, require precompiled binaries. If not set, use precompiled binaries if available.
|
|
10101
|
+
Compile Ruby from source instead of using a precompiled build.
|
|
10064
10102
|
|
|
10065
10103
|
---
|
|
10066
10104
|
|
|
@@ -10072,7 +10110,7 @@ public readonly defaultPackagesFile: string;
|
|
|
10072
10110
|
|
|
10073
10111
|
- *Type:* string
|
|
10074
10112
|
|
|
10075
|
-
|
|
10113
|
+
[deprecated] File listing gems to install into each new Ruby version.
|
|
10076
10114
|
|
|
10077
10115
|
---
|
|
10078
10116
|
|
|
@@ -10084,7 +10122,7 @@ public readonly githubAttestations: boolean;
|
|
|
10084
10122
|
|
|
10085
10123
|
- *Type:* boolean
|
|
10086
10124
|
|
|
10087
|
-
|
|
10125
|
+
Verify GitHub artifact attestations of precompiled Ruby builds.
|
|
10088
10126
|
|
|
10089
10127
|
---
|
|
10090
10128
|
|
|
@@ -10096,7 +10134,7 @@ public readonly precompiledArch: string;
|
|
|
10096
10134
|
|
|
10097
10135
|
- *Type:* string
|
|
10098
10136
|
|
|
10099
|
-
|
|
10137
|
+
Architecture name of precompiled Ruby builds, such as `x86_64` or `arm64`, used with `ruby.precompiled_os`.
|
|
10100
10138
|
|
|
10101
10139
|
---
|
|
10102
10140
|
|
|
@@ -10108,7 +10146,7 @@ public readonly precompiledOs: string;
|
|
|
10108
10146
|
|
|
10109
10147
|
- *Type:* string
|
|
10110
10148
|
|
|
10111
|
-
|
|
10149
|
+
OS name of precompiled Ruby builds, such as `linux`, used with `ruby.precompiled_arch`.
|
|
10112
10150
|
|
|
10113
10151
|
---
|
|
10114
10152
|
|
|
@@ -10120,7 +10158,7 @@ public readonly precompiledUrl: string;
|
|
|
10120
10158
|
|
|
10121
10159
|
- *Type:* string
|
|
10122
10160
|
|
|
10123
|
-
URL template
|
|
10161
|
+
GitHub repository, as `owner/repo`, or URL template that mise downloads precompiled Ruby builds from.
|
|
10124
10162
|
|
|
10125
10163
|
---
|
|
10126
10164
|
|
|
@@ -10132,7 +10170,7 @@ public readonly rubyBuildCliOpts: string;
|
|
|
10132
10170
|
|
|
10133
10171
|
- *Type:* string
|
|
10134
10172
|
|
|
10135
|
-
|
|
10173
|
+
Options for ruby-build itself, such as `--keep`, passed before the version and install directory.
|
|
10136
10174
|
|
|
10137
10175
|
---
|
|
10138
10176
|
|
|
@@ -10144,7 +10182,7 @@ public readonly rubyBuildOpts: string;
|
|
|
10144
10182
|
|
|
10145
10183
|
- *Type:* string
|
|
10146
10184
|
|
|
10147
|
-
|
|
10185
|
+
Arguments for Ruby's `configure`, such as `--enable-yjit`, passed through ruby-build.
|
|
10148
10186
|
|
|
10149
10187
|
---
|
|
10150
10188
|
|
|
@@ -10156,9 +10194,7 @@ public readonly rubyBuildRepo: string;
|
|
|
10156
10194
|
|
|
10157
10195
|
- *Type:* string
|
|
10158
10196
|
|
|
10159
|
-
|
|
10160
|
-
|
|
10161
|
-
This accepts either a Git repository or a ZIP archive.
|
|
10197
|
+
Git repository or ZIP archive URL that mise gets ruby-build from.
|
|
10162
10198
|
|
|
10163
10199
|
---
|
|
10164
10200
|
|
|
@@ -10170,7 +10206,7 @@ public readonly rubyInstall: boolean;
|
|
|
10170
10206
|
|
|
10171
10207
|
- *Type:* boolean
|
|
10172
10208
|
|
|
10173
|
-
|
|
10209
|
+
Compile Ruby with ruby-install instead of ruby-build.
|
|
10174
10210
|
|
|
10175
10211
|
---
|
|
10176
10212
|
|
|
@@ -10182,7 +10218,7 @@ public readonly rubyInstallOpts: string;
|
|
|
10182
10218
|
|
|
10183
10219
|
- *Type:* string
|
|
10184
10220
|
|
|
10185
|
-
|
|
10221
|
+
Arguments for Ruby's `configure`, passed through ruby-install.
|
|
10186
10222
|
|
|
10187
10223
|
---
|
|
10188
10224
|
|
|
@@ -10194,9 +10230,7 @@ public readonly rubyInstallRepo: string;
|
|
|
10194
10230
|
|
|
10195
10231
|
- *Type:* string
|
|
10196
10232
|
|
|
10197
|
-
|
|
10198
|
-
|
|
10199
|
-
This accepts either a Git repository or a ZIP archive.
|
|
10233
|
+
Git repository or ZIP archive URL that mise gets ruby-install from.
|
|
10200
10234
|
|
|
10201
10235
|
---
|
|
10202
10236
|
|
|
@@ -10208,7 +10242,7 @@ public readonly verboseInstall: boolean;
|
|
|
10208
10242
|
|
|
10209
10243
|
- *Type:* boolean
|
|
10210
10244
|
|
|
10211
|
-
|
|
10245
|
+
Show ruby-build's full output while compiling Ruby.
|
|
10212
10246
|
|
|
10213
10247
|
---
|
|
10214
10248
|
|
|
@@ -10226,9 +10260,9 @@ const settingsRust: SettingsRust = { ... }
|
|
|
10226
10260
|
|
|
10227
10261
|
| **Name** | **Type** | **Description** |
|
|
10228
10262
|
| --- | --- | --- |
|
|
10229
|
-
| <code><a href="#mise-projen.SettingsRust.property.cargoHome">cargoHome</a></code> | <code>string</code> |
|
|
10230
|
-
| <code><a href="#mise-projen.SettingsRust.property.defaultHost">defaultHost</a></code> | <code>string</code> |
|
|
10231
|
-
| <code><a href="#mise-projen.SettingsRust.property.rustupHome">rustupHome</a></code> | <code>string</code> |
|
|
10263
|
+
| <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. |
|
|
10264
|
+
| <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`. |
|
|
10265
|
+
| <code><a href="#mise-projen.SettingsRust.property.rustupHome">rustupHome</a></code> | <code>string</code> | Directory used as `RUSTUP_HOME` for the Rust toolchains that mise manages. |
|
|
10232
10266
|
|
|
10233
10267
|
---
|
|
10234
10268
|
|
|
@@ -10239,11 +10273,8 @@ public readonly cargoHome: string;
|
|
|
10239
10273
|
```
|
|
10240
10274
|
|
|
10241
10275
|
- *Type:* string
|
|
10242
|
-
- *Default:* cargo` or `%USERPROFILE%\.cargo`
|
|
10243
|
-
|
|
10244
|
-
Path to the cargo home directory.
|
|
10245
10276
|
|
|
10246
|
-
|
|
10277
|
+
Directory used as `CARGO_HOME` for the Rust toolchains that mise manages.
|
|
10247
10278
|
|
|
10248
10279
|
---
|
|
10249
10280
|
|
|
@@ -10255,7 +10286,7 @@ public readonly defaultHost: string;
|
|
|
10255
10286
|
|
|
10256
10287
|
- *Type:* string
|
|
10257
10288
|
|
|
10258
|
-
|
|
10289
|
+
Host triple that mise passes to `rustup init` as `--default-host`.
|
|
10259
10290
|
|
|
10260
10291
|
---
|
|
10261
10292
|
|
|
@@ -10266,11 +10297,8 @@ public readonly rustupHome: string;
|
|
|
10266
10297
|
```
|
|
10267
10298
|
|
|
10268
10299
|
- *Type:* string
|
|
10269
|
-
- *Default:* rustup` or `%USERPROFILE%\.rustup`
|
|
10270
10300
|
|
|
10271
|
-
|
|
10272
|
-
|
|
10273
|
-
Defaults to `~/.rustup` or `%USERPROFILE%\.rustup`
|
|
10301
|
+
Directory used as `RUSTUP_HOME` for the Rust toolchains that mise manages.
|
|
10274
10302
|
|
|
10275
10303
|
---
|
|
10276
10304
|
|
|
@@ -10288,7 +10316,7 @@ const settingsSandbox: SettingsSandbox = { ... }
|
|
|
10288
10316
|
|
|
10289
10317
|
| **Name** | **Type** | **Description** |
|
|
10290
10318
|
| --- | --- | --- |
|
|
10291
|
-
| <code><a href="#mise-projen.SettingsSandbox.property.denyAll">denyAll</a></code> | <code>boolean</code> | Deny filesystem
|
|
10319
|
+
| <code><a href="#mise-projen.SettingsSandbox.property.denyAll">denyAll</a></code> | <code>boolean</code> | Deny filesystem access, network access and inherited environment variables by default for `mise run` and `mise exec`. |
|
|
10292
10320
|
| <code><a href="#mise-projen.SettingsSandbox.property.denyEnv">denyEnv</a></code> | <code>boolean</code> | Deny environment variable inheritance by default for `mise run` and `mise exec`. |
|
|
10293
10321
|
| <code><a href="#mise-projen.SettingsSandbox.property.denyNet">denyNet</a></code> | <code>boolean</code> | Deny network access by default for `mise run` and `mise exec`. |
|
|
10294
10322
|
| <code><a href="#mise-projen.SettingsSandbox.property.denyRead">denyRead</a></code> | <code>boolean</code> | Deny filesystem reads by default for `mise run` and `mise exec`. |
|
|
@@ -10304,7 +10332,7 @@ public readonly denyAll: boolean;
|
|
|
10304
10332
|
|
|
10305
10333
|
- *Type:* boolean
|
|
10306
10334
|
|
|
10307
|
-
Deny filesystem
|
|
10335
|
+
Deny filesystem access, network access and inherited environment variables by default for `mise run` and `mise exec`.
|
|
10308
10336
|
|
|
10309
10337
|
---
|
|
10310
10338
|
|
|
@@ -10370,11 +10398,11 @@ const settingsSelfUpdate: SettingsSelfUpdate = { ... }
|
|
|
10370
10398
|
|
|
10371
10399
|
| **Name** | **Type** | **Description** |
|
|
10372
10400
|
| --- | --- | --- |
|
|
10373
|
-
| <code><a href="#mise-projen.SettingsSelfUpdate.property.apiUrl">apiUrl</a></code> | <code>string</code> | GitHub API base URL
|
|
10374
|
-
| <code><a href="#mise-projen.SettingsSelfUpdate.property.auto">auto</a></code> | <code>
|
|
10375
|
-
| <code><a href="#mise-projen.SettingsSelfUpdate.property.checkDuration">checkDuration</a></code> | <code>string</code> | How often
|
|
10376
|
-
| <code><a href="#mise-projen.SettingsSelfUpdate.property.minimumReleaseAge">minimumReleaseAge</a></code> | <code>string</code> |
|
|
10377
|
-
| <code><a href="#mise-projen.SettingsSelfUpdate.property.repository">repository</a></code> | <code>string</code> | GitHub repository
|
|
10401
|
+
| <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. |
|
|
10402
|
+
| <code><a href="#mise-projen.SettingsSelfUpdate.property.auto">auto</a></code> | <code><a href="#mise-projen.SettingsSelfUpdateAuto">SettingsSelfUpdateAuto</a></code> | Update mise automatically before running eligible commands. |
|
|
10403
|
+
| <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 = true`. |
|
|
10404
|
+
| <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. |
|
|
10405
|
+
| <code><a href="#mise-projen.SettingsSelfUpdate.property.repository">repository</a></code> | <code>string</code> | GitHub repository, as `owner/repo`, that mise gets its own releases from. |
|
|
10378
10406
|
|
|
10379
10407
|
---
|
|
10380
10408
|
|
|
@@ -10386,19 +10414,19 @@ public readonly apiUrl: string;
|
|
|
10386
10414
|
|
|
10387
10415
|
- *Type:* string
|
|
10388
10416
|
|
|
10389
|
-
GitHub API base URL
|
|
10417
|
+
GitHub API base URL that `mise self-update` gets mise releases from.
|
|
10390
10418
|
|
|
10391
10419
|
---
|
|
10392
10420
|
|
|
10393
10421
|
##### `auto`<sup>Optional</sup> <a name="auto" id="mise-projen.SettingsSelfUpdate.property.auto"></a>
|
|
10394
10422
|
|
|
10395
10423
|
```typescript
|
|
10396
|
-
public readonly auto:
|
|
10424
|
+
public readonly auto: SettingsSelfUpdateAuto;
|
|
10397
10425
|
```
|
|
10398
10426
|
|
|
10399
|
-
- *Type:*
|
|
10427
|
+
- *Type:* <a href="#mise-projen.SettingsSelfUpdateAuto">SettingsSelfUpdateAuto</a>
|
|
10400
10428
|
|
|
10401
|
-
|
|
10429
|
+
Update mise automatically before running eligible commands.
|
|
10402
10430
|
|
|
10403
10431
|
---
|
|
10404
10432
|
|
|
@@ -10410,7 +10438,7 @@ public readonly checkDuration: string;
|
|
|
10410
10438
|
|
|
10411
10439
|
- *Type:* string
|
|
10412
10440
|
|
|
10413
|
-
How often
|
|
10441
|
+
How often automatic updates check for a new mise release when `self_update.auto = true`.
|
|
10414
10442
|
|
|
10415
10443
|
---
|
|
10416
10444
|
|
|
@@ -10422,9 +10450,7 @@ public readonly minimumReleaseAge: string;
|
|
|
10422
10450
|
|
|
10423
10451
|
- *Type:* string
|
|
10424
10452
|
|
|
10425
|
-
|
|
10426
|
-
|
|
10427
|
-
inherits minimum_release_age (24h by default).
|
|
10453
|
+
Skip mise releases published more recently than this, for `mise self-update` and automatic updates.
|
|
10428
10454
|
|
|
10429
10455
|
---
|
|
10430
10456
|
|
|
@@ -10436,7 +10462,7 @@ public readonly repository: string;
|
|
|
10436
10462
|
|
|
10437
10463
|
- *Type:* string
|
|
10438
10464
|
|
|
10439
|
-
GitHub repository
|
|
10465
|
+
GitHub repository, as `owner/repo`, that mise gets its own releases from.
|
|
10440
10466
|
|
|
10441
10467
|
---
|
|
10442
10468
|
|
|
@@ -10454,7 +10480,7 @@ const settingsShims: SettingsShims = { ... }
|
|
|
10454
10480
|
|
|
10455
10481
|
| **Name** | **Type** | **Description** |
|
|
10456
10482
|
| --- | --- | --- |
|
|
10457
|
-
| <code><a href="#mise-projen.SettingsShims.property.exclude">exclude</a></code> | <code>string[]</code> | Command names mise
|
|
10483
|
+
| <code><a href="#mise-projen.SettingsShims.property.exclude">exclude</a></code> | <code>string[]</code> | Command names that mise never creates shims for, so they resolve to whatever else is on `PATH`. |
|
|
10458
10484
|
|
|
10459
10485
|
---
|
|
10460
10486
|
|
|
@@ -10466,7 +10492,7 @@ public readonly exclude: string[];
|
|
|
10466
10492
|
|
|
10467
10493
|
- *Type:* string[]
|
|
10468
10494
|
|
|
10469
|
-
Command names mise
|
|
10495
|
+
Command names that mise never creates shims for, so they resolve to whatever else is on `PATH`.
|
|
10470
10496
|
|
|
10471
10497
|
---
|
|
10472
10498
|
|
|
@@ -10487,7 +10513,7 @@ const settingsSkills: SettingsSkills = { ... }
|
|
|
10487
10513
|
| <code><a href="#mise-projen.SettingsSkills.property.autoSync">autoSync</a></code> | <code>boolean</code> | Link the active tools' agent skills into the project after `mise install` and `mise use`. |
|
|
10488
10514
|
| <code><a href="#mise-projen.SettingsSkills.property.dir">dir</a></code> | <code>string</code> | Where `mise skills sync` links skills: a path under the project root, or under the home directory with `--global`. |
|
|
10489
10515
|
| <code><a href="#mise-projen.SettingsSkills.property.fetch">fetch</a></code> | <code>boolean</code> | Fetch the agent skills a tool's packslip declares when installing it. |
|
|
10490
|
-
| <code><a href="#mise-projen.SettingsSkills.property.prune">prune</a></code> | <code>boolean</code> | Remove links mise made for skills that are no longer active
|
|
10516
|
+
| <code><a href="#mise-projen.SettingsSkills.property.prune">prune</a></code> | <code>boolean</code> | Remove links mise made for skills that are no longer active, on every `mise skills sync`. |
|
|
10491
10517
|
|
|
10492
10518
|
---
|
|
10493
10519
|
|
|
@@ -10535,7 +10561,7 @@ public readonly prune: boolean;
|
|
|
10535
10561
|
|
|
10536
10562
|
- *Type:* boolean
|
|
10537
10563
|
|
|
10538
|
-
Remove links mise made for skills that are no longer active
|
|
10564
|
+
Remove links mise made for skills that are no longer active, on every `mise skills sync`.
|
|
10539
10565
|
|
|
10540
10566
|
---
|
|
10541
10567
|
|
|
@@ -10553,11 +10579,11 @@ const settingsSops: SettingsSops = { ... }
|
|
|
10553
10579
|
|
|
10554
10580
|
| **Name** | **Type** | **Description** |
|
|
10555
10581
|
| --- | --- | --- |
|
|
10556
|
-
| <code><a href="#mise-projen.SettingsSops.property.ageKey">ageKey</a></code> | <code>string</code> |
|
|
10557
|
-
| <code><a href="#mise-projen.SettingsSops.property.ageKeyFile">ageKeyFile</a></code> | <code>string</code> | Path
|
|
10558
|
-
| <code><a href="#mise-projen.SettingsSops.property.ageRecipients">ageRecipients</a></code> | <code>string</code> |
|
|
10559
|
-
| <code><a href="#mise-projen.SettingsSops.property.rops">rops</a></code> | <code>boolean</code> |
|
|
10560
|
-
| <code><a href="#mise-projen.SettingsSops.property.strict">strict</a></code> | <code>boolean</code> |
|
|
10582
|
+
| <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. |
|
|
10583
|
+
| <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`. |
|
|
10584
|
+
| <code><a href="#mise-projen.SettingsSops.property.ageRecipients">ageRecipients</a></code> | <code>string</code> | [deprecated] Has no effect; |
|
|
10585
|
+
| <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. |
|
|
10586
|
+
| <code><a href="#mise-projen.SettingsSops.property.strict">strict</a></code> | <code>boolean</code> | Fail when a SOPS file cannot be decrypted, instead of skipping it. |
|
|
10561
10587
|
|
|
10562
10588
|
---
|
|
10563
10589
|
|
|
@@ -10569,9 +10595,7 @@ public readonly ageKey: string;
|
|
|
10569
10595
|
|
|
10570
10596
|
- *Type:* string
|
|
10571
10597
|
|
|
10572
|
-
|
|
10573
|
-
|
|
10574
|
-
Takes precedence over standard SOPS_AGE_KEY environment variable.
|
|
10598
|
+
Private age key for decrypting SOPS files, used before any other key source.
|
|
10575
10599
|
|
|
10576
10600
|
---
|
|
10577
10601
|
|
|
@@ -10583,9 +10607,7 @@ public readonly ageKeyFile: string;
|
|
|
10583
10607
|
|
|
10584
10608
|
- *Type:* string
|
|
10585
10609
|
|
|
10586
|
-
Path
|
|
10587
|
-
|
|
10588
|
-
Takes precedence over standard SOPS_AGE_KEY_FILE environment variable.
|
|
10610
|
+
Path of an age key file for decrypting SOPS files, used after `sops.age_key` and before `SOPS_AGE_KEY_FILE`.
|
|
10589
10611
|
|
|
10590
10612
|
---
|
|
10591
10613
|
|
|
@@ -10597,7 +10619,9 @@ public readonly ageRecipients: string;
|
|
|
10597
10619
|
|
|
10598
10620
|
- *Type:* string
|
|
10599
10621
|
|
|
10600
|
-
|
|
10622
|
+
[deprecated] Has no effect;
|
|
10623
|
+
|
|
10624
|
+
mise does not encrypt sops files.
|
|
10601
10625
|
|
|
10602
10626
|
---
|
|
10603
10627
|
|
|
@@ -10609,9 +10633,7 @@ public readonly rops: boolean;
|
|
|
10609
10633
|
|
|
10610
10634
|
- *Type:* boolean
|
|
10611
10635
|
|
|
10612
|
-
|
|
10613
|
-
|
|
10614
|
-
Disable to shell out to `sops` which will slow down mise but sops may offer features not available in rops. Required for TOML SOPS files because the sops CLI does not support TOML.
|
|
10636
|
+
Decrypt SOPS files with mise's built-in rops library instead of the `sops` CLI.
|
|
10615
10637
|
|
|
10616
10638
|
---
|
|
10617
10639
|
|
|
@@ -10623,9 +10645,7 @@ public readonly strict: boolean;
|
|
|
10623
10645
|
|
|
10624
10646
|
- *Type:* boolean
|
|
10625
10647
|
|
|
10626
|
-
|
|
10627
|
-
|
|
10628
|
-
If false, skip decryption and continue in these cases.
|
|
10648
|
+
Fail when a SOPS file cannot be decrypted, instead of skipping it.
|
|
10629
10649
|
|
|
10630
10650
|
---
|
|
10631
10651
|
|
|
@@ -10643,7 +10663,7 @@ const settingsSpm: SettingsSpm = { ... }
|
|
|
10643
10663
|
|
|
10644
10664
|
| **Name** | **Type** | **Description** |
|
|
10645
10665
|
| --- | --- | --- |
|
|
10646
|
-
| <code><a href="#mise-projen.SettingsSpm.property.artifactbundleOnly">artifactbundleOnly</a></code> | <code>boolean</code> |
|
|
10666
|
+
| <code><a href="#mise-projen.SettingsSpm.property.artifactbundleOnly">artifactbundleOnly</a></code> | <code>boolean</code> | Install `spm:` tools only from prebuilt artifact bundles, and fail instead of building from source. |
|
|
10647
10667
|
|
|
10648
10668
|
---
|
|
10649
10669
|
|
|
@@ -10655,7 +10675,7 @@ public readonly artifactbundleOnly: boolean;
|
|
|
10655
10675
|
|
|
10656
10676
|
- *Type:* boolean
|
|
10657
10677
|
|
|
10658
|
-
|
|
10678
|
+
Install `spm:` tools only from prebuilt artifact bundles, and fail instead of building from source.
|
|
10659
10679
|
|
|
10660
10680
|
---
|
|
10661
10681
|
|
|
@@ -10673,23 +10693,23 @@ const settingsStatus: SettingsStatus = { ... }
|
|
|
10673
10693
|
|
|
10674
10694
|
| **Name** | **Type** | **Description** |
|
|
10675
10695
|
| --- | --- | --- |
|
|
10676
|
-
| <code><a href="#mise-projen.SettingsStatus.property.missingTools">missingTools</a></code> | <code>
|
|
10677
|
-
| <code><a href="#mise-projen.SettingsStatus.property.showDepsStale">showDepsStale</a></code> | <code>boolean</code> |
|
|
10678
|
-
| <code><a href="#mise-projen.SettingsStatus.property.showEnv">showEnv</a></code> | <code>boolean</code> |
|
|
10679
|
-
| <code><a href="#mise-projen.SettingsStatus.property.showTools">showTools</a></code> | <code>boolean</code> |
|
|
10680
|
-
| <code><a href="#mise-projen.SettingsStatus.property.truncate">truncate</a></code> | <code>boolean</code> |
|
|
10696
|
+
| <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. |
|
|
10697
|
+
| <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. |
|
|
10698
|
+
| <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. |
|
|
10699
|
+
| <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. |
|
|
10700
|
+
| <code><a href="#mise-projen.SettingsStatus.property.truncate">truncate</a></code> | <code>boolean</code> | Cut the lines from `status.show_env` and `status.show_tools` to the terminal width. |
|
|
10681
10701
|
|
|
10682
10702
|
---
|
|
10683
10703
|
|
|
10684
10704
|
##### `missingTools`<sup>Optional</sup> <a name="missingTools" id="mise-projen.SettingsStatus.property.missingTools"></a>
|
|
10685
10705
|
|
|
10686
10706
|
```typescript
|
|
10687
|
-
public readonly missingTools:
|
|
10707
|
+
public readonly missingTools: SettingsStatusMissingTools;
|
|
10688
10708
|
```
|
|
10689
10709
|
|
|
10690
|
-
- *Type:*
|
|
10710
|
+
- *Type:* <a href="#mise-projen.SettingsStatusMissingTools">SettingsStatusMissingTools</a>
|
|
10691
10711
|
|
|
10692
|
-
|
|
10712
|
+
When to warn that tools requested by config are not installed.
|
|
10693
10713
|
|
|
10694
10714
|
---
|
|
10695
10715
|
|
|
@@ -10701,7 +10721,7 @@ public readonly showDepsStale: boolean;
|
|
|
10701
10721
|
|
|
10702
10722
|
- *Type:* boolean
|
|
10703
10723
|
|
|
10704
|
-
|
|
10724
|
+
Warn in an activated shell when a `[deps]` provider with `auto = true` is out of date.
|
|
10705
10725
|
|
|
10706
10726
|
---
|
|
10707
10727
|
|
|
@@ -10713,7 +10733,7 @@ public readonly showEnv: boolean;
|
|
|
10713
10733
|
|
|
10714
10734
|
- *Type:* boolean
|
|
10715
10735
|
|
|
10716
|
-
|
|
10736
|
+
When you change directories in an activated shell, list the environment variables that mise adds, changes or removes.
|
|
10717
10737
|
|
|
10718
10738
|
---
|
|
10719
10739
|
|
|
@@ -10725,7 +10745,7 @@ public readonly showTools: boolean;
|
|
|
10725
10745
|
|
|
10726
10746
|
- *Type:* boolean
|
|
10727
10747
|
|
|
10728
|
-
|
|
10748
|
+
When you change directories in an activated shell, list the tool versions that become active or inactive.
|
|
10729
10749
|
|
|
10730
10750
|
---
|
|
10731
10751
|
|
|
@@ -10737,7 +10757,7 @@ public readonly truncate: boolean;
|
|
|
10737
10757
|
|
|
10738
10758
|
- *Type:* boolean
|
|
10739
10759
|
|
|
10740
|
-
|
|
10760
|
+
Cut the lines from `status.show_env` and `status.show_tools` to the terminal width.
|
|
10741
10761
|
|
|
10742
10762
|
---
|
|
10743
10763
|
|
|
@@ -10755,8 +10775,8 @@ const settingsSwift: SettingsSwift = { ... }
|
|
|
10755
10775
|
|
|
10756
10776
|
| **Name** | **Type** | **Description** |
|
|
10757
10777
|
| --- | --- | --- |
|
|
10758
|
-
| <code><a href="#mise-projen.SettingsSwift.property.gpgVerify">gpgVerify</a></code> | <code>boolean</code> | Verify OpenPGP
|
|
10759
|
-
| <code><a href="#mise-projen.SettingsSwift.property.platform">platform</a></code> | <code>string</code> |
|
|
10778
|
+
| <code><a href="#mise-projen.SettingsSwift.property.gpgVerify">gpgVerify</a></code> | <code>boolean</code> | Verify the OpenPGP signature of Swift downloads on Linux. |
|
|
10779
|
+
| <code><a href="#mise-projen.SettingsSwift.property.platform">platform</a></code> | <code>string</code> | Linux distribution build of Swift to download, such as `ubuntu24.04` or `fedora41`. |
|
|
10760
10780
|
|
|
10761
10781
|
---
|
|
10762
10782
|
|
|
@@ -10768,9 +10788,7 @@ public readonly gpgVerify: boolean;
|
|
|
10768
10788
|
|
|
10769
10789
|
- *Type:* boolean
|
|
10770
10790
|
|
|
10771
|
-
Verify OpenPGP
|
|
10772
|
-
|
|
10773
|
-
Set to false to disable.
|
|
10791
|
+
Verify the OpenPGP signature of Swift downloads on Linux.
|
|
10774
10792
|
|
|
10775
10793
|
---
|
|
10776
10794
|
|
|
@@ -10782,9 +10800,7 @@ public readonly platform: string;
|
|
|
10782
10800
|
|
|
10783
10801
|
- *Type:* string
|
|
10784
10802
|
|
|
10785
|
-
|
|
10786
|
-
|
|
10787
|
-
By default the distro is detected and matched against what the Swift release actually publishes, which changes from release to release. Set this to force a specific build, or to install without reaching swift.org's release index.
|
|
10803
|
+
Linux distribution build of Swift to download, such as `ubuntu24.04` or `fedora41`.
|
|
10788
10804
|
|
|
10789
10805
|
---
|
|
10790
10806
|
|
|
@@ -10802,8 +10818,8 @@ const settingsSystemPackages: SettingsSystemPackages = { ... }
|
|
|
10802
10818
|
|
|
10803
10819
|
| **Name** | **Type** | **Description** |
|
|
10804
10820
|
| --- | --- | --- |
|
|
10805
|
-
| <code><a href="#mise-projen.SettingsSystemPackages.property.managers">managers</a></code> | <code>string[]</code> |
|
|
10806
|
-
| <code><a href="#mise-projen.SettingsSystemPackages.property.sudo">sudo</a></code> | <code>boolean</code> |
|
|
10821
|
+
| <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. |
|
|
10822
|
+
| <code><a href="#mise-projen.SettingsSystemPackages.property.sudo">sudo</a></code> | <code>boolean</code> | Let mise run `sudo` for steps that need root, such as system packages and `mise install --system`. |
|
|
10807
10823
|
|
|
10808
10824
|
---
|
|
10809
10825
|
|
|
@@ -10815,7 +10831,7 @@ public readonly managers: string[];
|
|
|
10815
10831
|
|
|
10816
10832
|
- *Type:* string[]
|
|
10817
10833
|
|
|
10818
|
-
|
|
10834
|
+
Package managers that mise may use for `[bootstrap.packages]` and missing plugin dependencies.
|
|
10819
10835
|
|
|
10820
10836
|
---
|
|
10821
10837
|
|
|
@@ -10827,7 +10843,7 @@ public readonly sudo: boolean;
|
|
|
10827
10843
|
|
|
10828
10844
|
- *Type:* boolean
|
|
10829
10845
|
|
|
10830
|
-
|
|
10846
|
+
Let mise run `sudo` for steps that need root, such as system packages and `mise install --system`.
|
|
10831
10847
|
|
|
10832
10848
|
---
|
|
10833
10849
|
|
|
@@ -10845,33 +10861,33 @@ const settingsTask: SettingsTask = { ... }
|
|
|
10845
10861
|
|
|
10846
10862
|
| **Name** | **Type** | **Description** |
|
|
10847
10863
|
| --- | --- | --- |
|
|
10848
|
-
| <code><a href="#mise-projen.SettingsTask.property.autoInfer">autoInfer</a></code> | <code>string[]</code> |
|
|
10864
|
+
| <code><a href="#mise-projen.SettingsTask.property.autoInfer">autoInfer</a></code> | <code>string[]</code> | Workspace providers whose package scripts mise imports as tasks, such as `node`. |
|
|
10849
10865
|
| <code><a href="#mise-projen.SettingsTask.property.cache">cache</a></code> | <code><a href="#mise-projen.SettingsTaskCache">SettingsTaskCache</a></code> | *No description.* |
|
|
10850
|
-
| <code><a href="#mise-projen.SettingsTask.property.cacheDir">cacheDir</a></code> | <code>string</code> | [experimental] Directory for task
|
|
10851
|
-
| <code><a href="#mise-projen.SettingsTask.property.cacheMaxAge">cacheMaxAge</a></code> | <code>string</code> | [experimental]
|
|
10852
|
-
| <code><a href="#mise-projen.SettingsTask.property.cacheMaxSize">cacheMaxSize</a></code> | <code>string</code> | [experimental] Maximum total size of task
|
|
10853
|
-
| <code><a href="#mise-projen.SettingsTask.property.cacheRemoteMode">cacheRemoteMode</a></code> | <code><a href="#mise-projen.SettingsTaskCacheRemoteMode">SettingsTaskCacheRemoteMode</a></code> |
|
|
10854
|
-
| <code><a href="#mise-projen.SettingsTask.property.cacheRemoteNamespace">cacheRemoteNamespace</a></code> | <code>string</code> |
|
|
10855
|
-
| <code><a href="#mise-projen.SettingsTask.property.cacheRemoteOidcAudience">cacheRemoteOidcAudience</a></code> | <code>string</code> |
|
|
10856
|
-
| <code><a href="#mise-projen.SettingsTask.property.cacheRemoteToken">cacheRemoteToken</a></code> | <code>string</code> |
|
|
10857
|
-
| <code><a href="#mise-projen.SettingsTask.property.cacheRemoteTokenFile">cacheRemoteTokenFile</a></code> | <code>string</code> |
|
|
10858
|
-
| <code><a href="#mise-projen.SettingsTask.property.cacheRemoteUrl">cacheRemoteUrl</a></code> | <code>string</code> |
|
|
10859
|
-
| <code><a href="#mise-projen.SettingsTask.property.disablePaths">disablePaths</a></code> | <code>string[]</code> | Paths that mise
|
|
10860
|
-
| <code><a href="#mise-projen.SettingsTask.property.disableSpecFromRunScripts">disableSpecFromRunScripts</a></code> | <code>boolean</code> |
|
|
10861
|
-
| <code><a href="#mise-projen.SettingsTask.property.monorepoDepth">monorepoDepth</a></code> | <code>number</code> | Maximum depth
|
|
10862
|
-
| <code><a href="#mise-projen.SettingsTask.property.monorepoExcludeDirs">monorepoExcludeDirs</a></code> | <code>string[]</code> | Directory
|
|
10863
|
-
| <code><a href="#mise-projen.SettingsTask.property.monorepoRespectGitignore">monorepoRespectGitignore</a></code> | <code>boolean</code> |
|
|
10864
|
-
| <code><a href="#mise-projen.SettingsTask.property.output">output</a></code> | <code><a href="#mise-projen.SettingsTaskOutput">SettingsTaskOutput</a></code> |
|
|
10865
|
-
| <code><a href="#mise-projen.SettingsTask.property.quiet">quiet</a></code> | <code>boolean</code> |
|
|
10866
|
-
| <code><a href="#mise-projen.SettingsTask.property.remoteNoCache">remoteNoCache</a></code> | <code>boolean</code> |
|
|
10867
|
-
| <code><a href="#mise-projen.SettingsTask.property.runAutoInstall">runAutoInstall</a></code> | <code>boolean</code> |
|
|
10868
|
-
| <code><a href="#mise-projen.SettingsTask.property.showFullCmd">showFullCmd</a></code> | <code>boolean</code> |
|
|
10869
|
-
| <code><a href="#mise-projen.SettingsTask.property.skip">skip</a></code> | <code>string[]</code> |
|
|
10870
|
-
| <code><a href="#mise-projen.SettingsTask.property.skipDepends">skipDepends</a></code> | <code>boolean</code> | Run only
|
|
10871
|
-
| <code><a href="#mise-projen.SettingsTask.property.sourceFreshnessEqualMtimeIsFresh">sourceFreshnessEqualMtimeIsFresh</a></code> | <code>boolean</code> |
|
|
10872
|
-
| <code><a href="#mise-projen.SettingsTask.property.sourceFreshnessHashContents">sourceFreshnessHashContents</a></code> | <code>boolean</code> |
|
|
10873
|
-
| <code><a href="#mise-projen.SettingsTask.property.timeout">timeout</a></code> | <code>string</code> |
|
|
10874
|
-
| <code><a href="#mise-projen.SettingsTask.property.timings">timings</a></code> | <code>boolean</code> |
|
|
10866
|
+
| <code><a href="#mise-projen.SettingsTask.property.cacheDir">cacheDir</a></code> | <code>string</code> | [experimental] Directory for the task artifact cache. |
|
|
10867
|
+
| <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. |
|
|
10868
|
+
| <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`. |
|
|
10869
|
+
| <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`. |
|
|
10870
|
+
| <code><a href="#mise-projen.SettingsTask.property.cacheRemoteNamespace">cacheRemoteNamespace</a></code> | <code>string</code> | Deprecated alias for `task.cache.remote_namespace`. |
|
|
10871
|
+
| <code><a href="#mise-projen.SettingsTask.property.cacheRemoteOidcAudience">cacheRemoteOidcAudience</a></code> | <code>string</code> | Deprecated alias for `task.cache.remote_oidc_audience`. |
|
|
10872
|
+
| <code><a href="#mise-projen.SettingsTask.property.cacheRemoteToken">cacheRemoteToken</a></code> | <code>string</code> | Deprecated alias for `task.cache.remote_token`. |
|
|
10873
|
+
| <code><a href="#mise-projen.SettingsTask.property.cacheRemoteTokenFile">cacheRemoteTokenFile</a></code> | <code>string</code> | Deprecated alias for `task.cache.remote_token_file`. |
|
|
10874
|
+
| <code><a href="#mise-projen.SettingsTask.property.cacheRemoteUrl">cacheRemoteUrl</a></code> | <code>string</code> | Deprecated alias for `task.cache.remote_url`. |
|
|
10875
|
+
| <code><a href="#mise-projen.SettingsTask.property.disablePaths">disablePaths</a></code> | <code>string[]</code> | Paths that mise does not look for tasks in. |
|
|
10876
|
+
| <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. |
|
|
10877
|
+
| <code><a href="#mise-projen.SettingsTask.property.monorepoDepth">monorepoDepth</a></code> | <code>number</code> | Maximum directory depth for automatic monorepo discovery, which is deprecated. |
|
|
10878
|
+
| <code><a href="#mise-projen.SettingsTask.property.monorepoExcludeDirs">monorepoExcludeDirs</a></code> | <code>string[]</code> | Directory names that automatic monorepo discovery skips. |
|
|
10879
|
+
| <code><a href="#mise-projen.SettingsTask.property.monorepoRespectGitignore">monorepoRespectGitignore</a></code> | <code>boolean</code> | Skip directories that `.gitignore` files ignore during automatic monorepo discovery. |
|
|
10880
|
+
| <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`. |
|
|
10881
|
+
| <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. |
|
|
10882
|
+
| <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. |
|
|
10883
|
+
| <code><a href="#mise-projen.SettingsTask.property.runAutoInstall">runAutoInstall</a></code> | <code>boolean</code> | Install missing tools automatically before tasks run. |
|
|
10884
|
+
| <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. |
|
|
10885
|
+
| <code><a href="#mise-projen.SettingsTask.property.skip">skip</a></code> | <code>string[]</code> | Names of tasks that `mise run` skips. |
|
|
10886
|
+
| <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; |
|
|
10887
|
+
| <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. |
|
|
10888
|
+
| <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. |
|
|
10889
|
+
| <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. |
|
|
10890
|
+
| <code><a href="#mise-projen.SettingsTask.property.timings">timings</a></code> | <code>boolean</code> | Print each task's elapsed time when it finishes. |
|
|
10875
10891
|
|
|
10876
10892
|
---
|
|
10877
10893
|
|
|
@@ -10883,7 +10899,7 @@ public readonly autoInfer: string[];
|
|
|
10883
10899
|
|
|
10884
10900
|
- *Type:* string[]
|
|
10885
10901
|
|
|
10886
|
-
|
|
10902
|
+
Workspace providers whose package scripts mise imports as tasks, such as `node`.
|
|
10887
10903
|
|
|
10888
10904
|
---
|
|
10889
10905
|
|
|
@@ -10905,7 +10921,7 @@ public readonly cacheDir: string;
|
|
|
10905
10921
|
|
|
10906
10922
|
- *Type:* string
|
|
10907
10923
|
|
|
10908
|
-
[experimental] Directory for task
|
|
10924
|
+
[experimental] Directory for the task artifact cache.
|
|
10909
10925
|
|
|
10910
10926
|
---
|
|
10911
10927
|
|
|
@@ -10917,7 +10933,7 @@ public readonly cacheMaxAge: string;
|
|
|
10917
10933
|
|
|
10918
10934
|
- *Type:* string
|
|
10919
10935
|
|
|
10920
|
-
[experimental]
|
|
10936
|
+
[experimental] Remove task artifact cache entries that have not been used for this long.
|
|
10921
10937
|
|
|
10922
10938
|
---
|
|
10923
10939
|
|
|
@@ -10929,7 +10945,7 @@ public readonly cacheMaxSize: string;
|
|
|
10929
10945
|
|
|
10930
10946
|
- *Type:* string
|
|
10931
10947
|
|
|
10932
|
-
[experimental] Maximum total size of task
|
|
10948
|
+
[experimental] Maximum total size of the task artifact cache, such as `500MB` or `2GiB`.
|
|
10933
10949
|
|
|
10934
10950
|
---
|
|
10935
10951
|
|
|
@@ -10941,7 +10957,7 @@ public readonly cacheRemoteMode: SettingsTaskCacheRemoteMode;
|
|
|
10941
10957
|
|
|
10942
10958
|
- *Type:* <a href="#mise-projen.SettingsTaskCacheRemoteMode">SettingsTaskCacheRemoteMode</a>
|
|
10943
10959
|
|
|
10944
|
-
|
|
10960
|
+
Deprecated alias for `task.cache.remote_mode`.
|
|
10945
10961
|
|
|
10946
10962
|
---
|
|
10947
10963
|
|
|
@@ -10953,7 +10969,7 @@ public readonly cacheRemoteNamespace: string;
|
|
|
10953
10969
|
|
|
10954
10970
|
- *Type:* string
|
|
10955
10971
|
|
|
10956
|
-
|
|
10972
|
+
Deprecated alias for `task.cache.remote_namespace`.
|
|
10957
10973
|
|
|
10958
10974
|
---
|
|
10959
10975
|
|
|
@@ -10965,7 +10981,7 @@ public readonly cacheRemoteOidcAudience: string;
|
|
|
10965
10981
|
|
|
10966
10982
|
- *Type:* string
|
|
10967
10983
|
|
|
10968
|
-
|
|
10984
|
+
Deprecated alias for `task.cache.remote_oidc_audience`.
|
|
10969
10985
|
|
|
10970
10986
|
---
|
|
10971
10987
|
|
|
@@ -10977,7 +10993,7 @@ public readonly cacheRemoteToken: string;
|
|
|
10977
10993
|
|
|
10978
10994
|
- *Type:* string
|
|
10979
10995
|
|
|
10980
|
-
|
|
10996
|
+
Deprecated alias for `task.cache.remote_token`.
|
|
10981
10997
|
|
|
10982
10998
|
---
|
|
10983
10999
|
|
|
@@ -10989,7 +11005,7 @@ public readonly cacheRemoteTokenFile: string;
|
|
|
10989
11005
|
|
|
10990
11006
|
- *Type:* string
|
|
10991
11007
|
|
|
10992
|
-
|
|
11008
|
+
Deprecated alias for `task.cache.remote_token_file`.
|
|
10993
11009
|
|
|
10994
11010
|
---
|
|
10995
11011
|
|
|
@@ -11001,7 +11017,7 @@ public readonly cacheRemoteUrl: string;
|
|
|
11001
11017
|
|
|
11002
11018
|
- *Type:* string
|
|
11003
11019
|
|
|
11004
|
-
|
|
11020
|
+
Deprecated alias for `task.cache.remote_url`.
|
|
11005
11021
|
|
|
11006
11022
|
---
|
|
11007
11023
|
|
|
@@ -11013,7 +11029,7 @@ public readonly disablePaths: string[];
|
|
|
11013
11029
|
|
|
11014
11030
|
- *Type:* string[]
|
|
11015
11031
|
|
|
11016
|
-
Paths that mise
|
|
11032
|
+
Paths that mise does not look for tasks in.
|
|
11017
11033
|
|
|
11018
11034
|
---
|
|
11019
11035
|
|
|
@@ -11025,9 +11041,7 @@ public readonly disableSpecFromRunScripts: boolean;
|
|
|
11025
11041
|
|
|
11026
11042
|
- *Type:* boolean
|
|
11027
11043
|
|
|
11028
|
-
|
|
11029
|
-
|
|
11030
|
-
When enabled, mise will derive the usage spec only from the `usage` field, ignoring any `arg()`, `option()`, or `flag()` templates used in run scripts. This can restore previous behavior and avoid the extra template pass over run scripts when collecting specs.
|
|
11044
|
+
Build task usage specs only from the `usage` field, ignoring deprecated `arg()`, `option()` and `flag()` in run scripts.
|
|
11031
11045
|
|
|
11032
11046
|
---
|
|
11033
11047
|
|
|
@@ -11039,7 +11053,7 @@ public readonly monorepoDepth: number;
|
|
|
11039
11053
|
|
|
11040
11054
|
- *Type:* number
|
|
11041
11055
|
|
|
11042
|
-
Maximum depth
|
|
11056
|
+
Maximum directory depth for automatic monorepo discovery, which is deprecated.
|
|
11043
11057
|
|
|
11044
11058
|
---
|
|
11045
11059
|
|
|
@@ -11051,7 +11065,7 @@ public readonly monorepoExcludeDirs: string[];
|
|
|
11051
11065
|
|
|
11052
11066
|
- *Type:* string[]
|
|
11053
11067
|
|
|
11054
|
-
Directory
|
|
11068
|
+
Directory names that automatic monorepo discovery skips.
|
|
11055
11069
|
|
|
11056
11070
|
---
|
|
11057
11071
|
|
|
@@ -11063,7 +11077,7 @@ public readonly monorepoRespectGitignore: boolean;
|
|
|
11063
11077
|
|
|
11064
11078
|
- *Type:* boolean
|
|
11065
11079
|
|
|
11066
|
-
|
|
11080
|
+
Skip directories that `.gitignore` files ignore during automatic monorepo discovery.
|
|
11067
11081
|
|
|
11068
11082
|
---
|
|
11069
11083
|
|
|
@@ -11075,7 +11089,7 @@ public readonly output: SettingsTaskOutput;
|
|
|
11075
11089
|
|
|
11076
11090
|
- *Type:* <a href="#mise-projen.SettingsTaskOutput">SettingsTaskOutput</a>
|
|
11077
11091
|
|
|
11078
|
-
|
|
11092
|
+
Default output style for `mise run`.
|
|
11079
11093
|
|
|
11080
11094
|
---
|
|
11081
11095
|
|
|
@@ -11087,7 +11101,7 @@ public readonly quiet: boolean;
|
|
|
11087
11101
|
|
|
11088
11102
|
- *Type:* boolean
|
|
11089
11103
|
|
|
11090
|
-
|
|
11104
|
+
Hide mise's own messages while tasks run, without changing other mise commands.
|
|
11091
11105
|
|
|
11092
11106
|
---
|
|
11093
11107
|
|
|
@@ -11099,7 +11113,7 @@ public readonly remoteNoCache: boolean;
|
|
|
11099
11113
|
|
|
11100
11114
|
- *Type:* boolean
|
|
11101
11115
|
|
|
11102
|
-
|
|
11116
|
+
Download remote task files and task includes on every run instead of using the cached copy.
|
|
11103
11117
|
|
|
11104
11118
|
---
|
|
11105
11119
|
|
|
@@ -11111,7 +11125,7 @@ public readonly runAutoInstall: boolean;
|
|
|
11111
11125
|
|
|
11112
11126
|
- *Type:* boolean
|
|
11113
11127
|
|
|
11114
|
-
|
|
11128
|
+
Install missing tools automatically before tasks run.
|
|
11115
11129
|
|
|
11116
11130
|
---
|
|
11117
11131
|
|
|
@@ -11123,9 +11137,7 @@ public readonly showFullCmd: boolean;
|
|
|
11123
11137
|
|
|
11124
11138
|
- *Type:* boolean
|
|
11125
11139
|
|
|
11126
|
-
|
|
11127
|
-
|
|
11128
|
-
When true, the full command line will be shown.
|
|
11140
|
+
Print each task's full command line instead of truncating it to the terminal width.
|
|
11129
11141
|
|
|
11130
11142
|
---
|
|
11131
11143
|
|
|
@@ -11137,7 +11149,7 @@ public readonly skip: string[];
|
|
|
11137
11149
|
|
|
11138
11150
|
- *Type:* string[]
|
|
11139
11151
|
|
|
11140
|
-
|
|
11152
|
+
Names of tasks that `mise run` skips.
|
|
11141
11153
|
|
|
11142
11154
|
---
|
|
11143
11155
|
|
|
@@ -11149,7 +11161,9 @@ public readonly skipDepends: boolean;
|
|
|
11149
11161
|
|
|
11150
11162
|
- *Type:* boolean
|
|
11151
11163
|
|
|
11152
|
-
Run only
|
|
11164
|
+
Run only the tasks named on the command line, skipping their dependencies;
|
|
11165
|
+
|
|
11166
|
+
same as `mise run --skip-deps`.
|
|
11153
11167
|
|
|
11154
11168
|
---
|
|
11155
11169
|
|
|
@@ -11161,9 +11175,7 @@ public readonly sourceFreshnessEqualMtimeIsFresh: boolean;
|
|
|
11161
11175
|
|
|
11162
11176
|
- *Type:* boolean
|
|
11163
11177
|
|
|
11164
|
-
|
|
11165
|
-
|
|
11166
|
-
Default false uses strict < comparison.
|
|
11178
|
+
Treat a task as up to date when its newest source and its outputs have the same modification time.
|
|
11167
11179
|
|
|
11168
11180
|
---
|
|
11169
11181
|
|
|
@@ -11175,9 +11187,7 @@ public readonly sourceFreshnessHashContents: boolean;
|
|
|
11175
11187
|
|
|
11176
11188
|
- *Type:* boolean
|
|
11177
11189
|
|
|
11178
|
-
|
|
11179
|
-
|
|
11180
|
-
More accurate but slower.
|
|
11190
|
+
Decide whether a task's sources changed by hashing their contents instead of comparing modification times.
|
|
11181
11191
|
|
|
11182
11192
|
---
|
|
11183
11193
|
|
|
@@ -11189,7 +11199,7 @@ public readonly timeout: string;
|
|
|
11189
11199
|
|
|
11190
11200
|
- *Type:* string
|
|
11191
11201
|
|
|
11192
|
-
|
|
11202
|
+
Time limit for a whole `mise run` invocation, across every task it runs.
|
|
11193
11203
|
|
|
11194
11204
|
---
|
|
11195
11205
|
|
|
@@ -11201,9 +11211,7 @@ public readonly timings: boolean;
|
|
|
11201
11211
|
|
|
11202
11212
|
- *Type:* boolean
|
|
11203
11213
|
|
|
11204
|
-
|
|
11205
|
-
|
|
11206
|
-
Default shows when output type is `prefix`.
|
|
11214
|
+
Print each task's elapsed time when it finishes.
|
|
11207
11215
|
|
|
11208
11216
|
---
|
|
11209
11217
|
|
|
@@ -11221,14 +11229,14 @@ const settingsTaskCache: SettingsTaskCache = { ... }
|
|
|
11221
11229
|
|
|
11222
11230
|
| **Name** | **Type** | **Description** |
|
|
11223
11231
|
| --- | --- | --- |
|
|
11224
|
-
| <code><a href="#mise-projen.SettingsTaskCache.property.auditReport">auditReport</a></code> | <code>string</code> | [experimental] File
|
|
11225
|
-
| <code><a href="#mise-projen.SettingsTaskCache.property.remoteMode">remoteMode</a></code> | <code><a href="#mise-projen.SettingsTaskCacheRemoteMode">SettingsTaskCacheRemoteMode</a></code> | [experimental]
|
|
11226
|
-
| <code><a href="#mise-projen.SettingsTaskCache.property.remoteNamespace">remoteNamespace</a></code> | <code>string</code> | [experimental] Namespace
|
|
11227
|
-
| <code><a href="#mise-projen.SettingsTaskCache.property.remoteOidcAudience">remoteOidcAudience</a></code> | <code>string</code> | [experimental] Audience
|
|
11228
|
-
| <code><a href="#mise-projen.SettingsTaskCache.property.remoteToken">remoteToken</a></code> | <code>string</code> | [experimental] Bearer token
|
|
11229
|
-
| <code><a href="#mise-projen.SettingsTaskCache.property.remoteTokenFile">remoteTokenFile</a></code> | <code>string</code> | [experimental] File
|
|
11230
|
-
| <code><a href="#mise-projen.SettingsTaskCache.property.remoteUrl">remoteUrl</a></code> | <code>string</code> | [experimental] Base URL
|
|
11231
|
-
| <code><a href="#mise-projen.SettingsTaskCache.property.statsReport">statsReport</a></code> | <code>string</code> | [
|
|
11232
|
+
| <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. |
|
|
11233
|
+
| <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. |
|
|
11234
|
+
| <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. |
|
|
11235
|
+
| <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. |
|
|
11236
|
+
| <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. |
|
|
11237
|
+
| <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. |
|
|
11238
|
+
| <code><a href="#mise-projen.SettingsTaskCache.property.remoteUrl">remoteUrl</a></code> | <code>string</code> | [experimental] Base URL of the remote task cache server. |
|
|
11239
|
+
| <code><a href="#mise-projen.SettingsTaskCache.property.statsReport">statsReport</a></code> | <code>string</code> | [deprecated] Has no effect since the built-in action cache was removed. |
|
|
11232
11240
|
|
|
11233
11241
|
---
|
|
11234
11242
|
|
|
@@ -11240,7 +11248,7 @@ public readonly auditReport: string;
|
|
|
11240
11248
|
|
|
11241
11249
|
- *Type:* string
|
|
11242
11250
|
|
|
11243
|
-
[experimental] File
|
|
11251
|
+
[experimental] File that receives every undeclared path found by the `cache.audit` task option.
|
|
11244
11252
|
|
|
11245
11253
|
---
|
|
11246
11254
|
|
|
@@ -11252,7 +11260,7 @@ public readonly remoteMode: SettingsTaskCacheRemoteMode;
|
|
|
11252
11260
|
|
|
11253
11261
|
- *Type:* <a href="#mise-projen.SettingsTaskCacheRemoteMode">SettingsTaskCacheRemoteMode</a>
|
|
11254
11262
|
|
|
11255
|
-
[experimental]
|
|
11263
|
+
[experimental] How mise uses the remote task cache server.
|
|
11256
11264
|
|
|
11257
11265
|
---
|
|
11258
11266
|
|
|
@@ -11264,7 +11272,7 @@ public readonly remoteNamespace: string;
|
|
|
11264
11272
|
|
|
11265
11273
|
- *Type:* string
|
|
11266
11274
|
|
|
11267
|
-
[experimental] Namespace
|
|
11275
|
+
[experimental] Namespace that keeps this project's entries apart on the remote task cache server.
|
|
11268
11276
|
|
|
11269
11277
|
---
|
|
11270
11278
|
|
|
@@ -11276,7 +11284,7 @@ public readonly remoteOidcAudience: string;
|
|
|
11276
11284
|
|
|
11277
11285
|
- *Type:* string
|
|
11278
11286
|
|
|
11279
|
-
[experimental] Audience
|
|
11287
|
+
[experimental] Audience of the GitHub Actions OIDC token that mise requests for the remote task cache.
|
|
11280
11288
|
|
|
11281
11289
|
---
|
|
11282
11290
|
|
|
@@ -11288,7 +11296,7 @@ public readonly remoteToken: string;
|
|
|
11288
11296
|
|
|
11289
11297
|
- *Type:* string
|
|
11290
11298
|
|
|
11291
|
-
[experimental] Bearer token
|
|
11299
|
+
[experimental] Bearer token that mise sends to the remote task cache server.
|
|
11292
11300
|
|
|
11293
11301
|
---
|
|
11294
11302
|
|
|
@@ -11300,7 +11308,7 @@ public readonly remoteTokenFile: string;
|
|
|
11300
11308
|
|
|
11301
11309
|
- *Type:* string
|
|
11302
11310
|
|
|
11303
|
-
[experimental] File
|
|
11311
|
+
[experimental] File that mise reads the remote task cache token from before each request.
|
|
11304
11312
|
|
|
11305
11313
|
---
|
|
11306
11314
|
|
|
@@ -11312,7 +11320,7 @@ public readonly remoteUrl: string;
|
|
|
11312
11320
|
|
|
11313
11321
|
- *Type:* string
|
|
11314
11322
|
|
|
11315
|
-
[experimental] Base URL
|
|
11323
|
+
[experimental] Base URL of the remote task cache server.
|
|
11316
11324
|
|
|
11317
11325
|
---
|
|
11318
11326
|
|
|
@@ -11324,7 +11332,7 @@ public readonly statsReport: string;
|
|
|
11324
11332
|
|
|
11325
11333
|
- *Type:* string
|
|
11326
11334
|
|
|
11327
|
-
[
|
|
11335
|
+
[deprecated] Has no effect since the built-in action cache was removed.
|
|
11328
11336
|
|
|
11329
11337
|
---
|
|
11330
11338
|
|
|
@@ -11342,7 +11350,8 @@ const settingsToolUpdate: SettingsToolUpdate = { ... }
|
|
|
11342
11350
|
|
|
11343
11351
|
| **Name** | **Type** | **Description** |
|
|
11344
11352
|
| --- | --- | --- |
|
|
11345
|
-
| <code><a href="#mise-projen.SettingsToolUpdate.property.checkDuration">checkDuration</a></code> | <code>string</code> | How often
|
|
11353
|
+
| <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`, or of every global tool with `tool_update.global_auto = true`. |
|
|
11354
|
+
| <code><a href="#mise-projen.SettingsToolUpdate.property.globalAuto">globalAuto</a></code> | <code><a href="#mise-projen.SettingsToolUpdateGlobalAuto">SettingsToolUpdateGlobalAuto</a></code> | Update every tool in global config automatically, as if each set `auto_update` to this value. |
|
|
11346
11355
|
|
|
11347
11356
|
---
|
|
11348
11357
|
|
|
@@ -11354,7 +11363,19 @@ public readonly checkDuration: string;
|
|
|
11354
11363
|
|
|
11355
11364
|
- *Type:* string
|
|
11356
11365
|
|
|
11357
|
-
How often
|
|
11366
|
+
How often mise checks for a newer version of a global tool that sets `auto_update = true`, or of every global tool with `tool_update.global_auto = true`.
|
|
11367
|
+
|
|
11368
|
+
---
|
|
11369
|
+
|
|
11370
|
+
##### `globalAuto`<sup>Optional</sup> <a name="globalAuto" id="mise-projen.SettingsToolUpdate.property.globalAuto"></a>
|
|
11371
|
+
|
|
11372
|
+
```typescript
|
|
11373
|
+
public readonly globalAuto: SettingsToolUpdateGlobalAuto;
|
|
11374
|
+
```
|
|
11375
|
+
|
|
11376
|
+
- *Type:* <a href="#mise-projen.SettingsToolUpdateGlobalAuto">SettingsToolUpdateGlobalAuto</a>
|
|
11377
|
+
|
|
11378
|
+
Update every tool in global config automatically, as if each set `auto_update` to this value.
|
|
11358
11379
|
|
|
11359
11380
|
---
|
|
11360
11381
|
|
|
@@ -11372,8 +11393,8 @@ const settingsUpgrade: SettingsUpgrade = { ... }
|
|
|
11372
11393
|
|
|
11373
11394
|
| **Name** | **Type** | **Description** |
|
|
11374
11395
|
| --- | --- | --- |
|
|
11375
|
-
| <code><a href="#mise-projen.SettingsUpgrade.property.autoPrune">autoPrune</a></code> | <code>boolean</code> |
|
|
11376
|
-
| <code><a href="#mise-projen.SettingsUpgrade.property.pruneAfter">pruneAfter</a></code> | <code>string</code> | Grace period before
|
|
11396
|
+
| <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. |
|
|
11397
|
+
| <code><a href="#mise-projen.SettingsUpgrade.property.pruneAfter">pruneAfter</a></code> | <code>string</code> | Grace period before mise removes a version that `mise upgrade` replaced. |
|
|
11377
11398
|
|
|
11378
11399
|
---
|
|
11379
11400
|
|
|
@@ -11385,7 +11406,7 @@ public readonly autoPrune: boolean;
|
|
|
11385
11406
|
|
|
11386
11407
|
- *Type:* boolean
|
|
11387
11408
|
|
|
11388
|
-
|
|
11409
|
+
Remove the version that `mise upgrade` replaced once `upgrade.prune_after` has passed.
|
|
11389
11410
|
|
|
11390
11411
|
---
|
|
11391
11412
|
|
|
@@ -11397,7 +11418,7 @@ public readonly pruneAfter: string;
|
|
|
11397
11418
|
|
|
11398
11419
|
- *Type:* string
|
|
11399
11420
|
|
|
11400
|
-
Grace period before
|
|
11421
|
+
Grace period before mise removes a version that `mise upgrade` replaced.
|
|
11401
11422
|
|
|
11402
11423
|
---
|
|
11403
11424
|
|
|
@@ -11415,9 +11436,9 @@ const settingsWriteTargets: SettingsWriteTargets = { ... }
|
|
|
11415
11436
|
|
|
11416
11437
|
| **Name** | **Type** | **Description** |
|
|
11417
11438
|
| --- | --- | --- |
|
|
11418
|
-
| <code><a href="#mise-projen.SettingsWriteTargets.property.dotfiles">dotfiles</a></code> | <code>string</code> | Global config file
|
|
11419
|
-
| <code><a href="#mise-projen.SettingsWriteTargets.property.packages">packages</a></code> | <code>string</code> | Global config file
|
|
11420
|
-
| <code><a href="#mise-projen.SettingsWriteTargets.property.tools">tools</a></code> | <code>string</code> | Global config file
|
|
11439
|
+
| <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. |
|
|
11440
|
+
| <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. |
|
|
11441
|
+
| <code><a href="#mise-projen.SettingsWriteTargets.property.tools">tools</a></code> | <code>string</code> | Global config file where `mise use --global` creates new `[tools]` entries. |
|
|
11421
11442
|
|
|
11422
11443
|
---
|
|
11423
11444
|
|
|
@@ -11429,9 +11450,7 @@ public readonly dotfiles: string;
|
|
|
11429
11450
|
|
|
11430
11451
|
- *Type:* string
|
|
11431
11452
|
|
|
11432
|
-
Global config file
|
|
11433
|
-
|
|
11434
|
-
Existing entries stay in the config file that already declares them.
|
|
11453
|
+
Global config file where `mise dot add` creates new `[dotfiles]` entries.
|
|
11435
11454
|
|
|
11436
11455
|
---
|
|
11437
11456
|
|
|
@@ -11443,7 +11462,7 @@ public readonly packages: string;
|
|
|
11443
11462
|
|
|
11444
11463
|
- *Type:* string
|
|
11445
11464
|
|
|
11446
|
-
Global config file
|
|
11465
|
+
Global config file where `--global` package commands create new `[bootstrap.packages]` entries.
|
|
11447
11466
|
|
|
11448
11467
|
---
|
|
11449
11468
|
|
|
@@ -11455,9 +11474,7 @@ public readonly tools: string;
|
|
|
11455
11474
|
|
|
11456
11475
|
- *Type:* string
|
|
11457
11476
|
|
|
11458
|
-
Global config file
|
|
11459
|
-
|
|
11460
|
-
Existing entries stay in the config file that already declares them.
|
|
11477
|
+
Global config file where `mise use --global` creates new `[tools]` entries.
|
|
11461
11478
|
|
|
11462
11479
|
---
|
|
11463
11480
|
|
|
@@ -11475,7 +11492,7 @@ const settingsZig: SettingsZig = { ... }
|
|
|
11475
11492
|
|
|
11476
11493
|
| **Name** | **Type** | **Description** |
|
|
11477
11494
|
| --- | --- | --- |
|
|
11478
|
-
| <code><a href="#mise-projen.SettingsZig.property.useCommunityMirrors">useCommunityMirrors</a></code> | <code>boolean</code> | Download Zig from community
|
|
11495
|
+
| <code><a href="#mise-projen.SettingsZig.property.useCommunityMirrors">useCommunityMirrors</a></code> | <code>boolean</code> | Download Zig from the community mirrors that ziglang.org recommends before trying ziglang.org itself. |
|
|
11479
11496
|
|
|
11480
11497
|
---
|
|
11481
11498
|
|
|
@@ -11487,7 +11504,7 @@ public readonly useCommunityMirrors: boolean;
|
|
|
11487
11504
|
|
|
11488
11505
|
- *Type:* boolean
|
|
11489
11506
|
|
|
11490
|
-
Download Zig from community
|
|
11507
|
+
Download Zig from the community mirrors that ziglang.org recommends before trying ziglang.org itself.
|
|
11491
11508
|
|
|
11492
11509
|
---
|
|
11493
11510
|
|
|
@@ -12111,7 +12128,7 @@ public readonly value: string | number | boolean;
|
|
|
12111
12128
|
|
|
12112
12129
|
### SettingsPythonUvVenvAuto <a name="SettingsPythonUvVenvAuto" id="mise-projen.SettingsPythonUvVenvAuto"></a>
|
|
12113
12130
|
|
|
12114
|
-
|
|
12131
|
+
Activate, and optionally create, the virtualenv of the uv project around the current directory.
|
|
12115
12132
|
|
|
12116
12133
|
|
|
12117
12134
|
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
@@ -12170,6 +12187,128 @@ public readonly value: string | boolean;
|
|
|
12170
12187
|
---
|
|
12171
12188
|
|
|
12172
12189
|
|
|
12190
|
+
### SettingsSelfUpdateAuto <a name="SettingsSelfUpdateAuto" id="mise-projen.SettingsSelfUpdateAuto"></a>
|
|
12191
|
+
|
|
12192
|
+
Update mise automatically before running eligible commands.
|
|
12193
|
+
|
|
12194
|
+
|
|
12195
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
12196
|
+
|
|
12197
|
+
| **Name** | **Description** |
|
|
12198
|
+
| --- | --- |
|
|
12199
|
+
| <code><a href="#mise-projen.SettingsSelfUpdateAuto.fromBoolean">fromBoolean</a></code> | *No description.* |
|
|
12200
|
+
| <code><a href="#mise-projen.SettingsSelfUpdateAuto.fromString">fromString</a></code> | *No description.* |
|
|
12201
|
+
|
|
12202
|
+
---
|
|
12203
|
+
|
|
12204
|
+
##### `fromBoolean` <a name="fromBoolean" id="mise-projen.SettingsSelfUpdateAuto.fromBoolean"></a>
|
|
12205
|
+
|
|
12206
|
+
```typescript
|
|
12207
|
+
import { SettingsSelfUpdateAuto } from 'mise-projen'
|
|
12208
|
+
|
|
12209
|
+
SettingsSelfUpdateAuto.fromBoolean(value: boolean)
|
|
12210
|
+
```
|
|
12211
|
+
|
|
12212
|
+
###### `value`<sup>Required</sup> <a name="value" id="mise-projen.SettingsSelfUpdateAuto.fromBoolean.parameter.value"></a>
|
|
12213
|
+
|
|
12214
|
+
- *Type:* boolean
|
|
12215
|
+
|
|
12216
|
+
---
|
|
12217
|
+
|
|
12218
|
+
##### `fromString` <a name="fromString" id="mise-projen.SettingsSelfUpdateAuto.fromString"></a>
|
|
12219
|
+
|
|
12220
|
+
```typescript
|
|
12221
|
+
import { SettingsSelfUpdateAuto } from 'mise-projen'
|
|
12222
|
+
|
|
12223
|
+
SettingsSelfUpdateAuto.fromString(value: string)
|
|
12224
|
+
```
|
|
12225
|
+
|
|
12226
|
+
###### `value`<sup>Required</sup> <a name="value" id="mise-projen.SettingsSelfUpdateAuto.fromString.parameter.value"></a>
|
|
12227
|
+
|
|
12228
|
+
- *Type:* string
|
|
12229
|
+
|
|
12230
|
+
---
|
|
12231
|
+
|
|
12232
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
12233
|
+
|
|
12234
|
+
| **Name** | **Type** | **Description** |
|
|
12235
|
+
| --- | --- | --- |
|
|
12236
|
+
| <code><a href="#mise-projen.SettingsSelfUpdateAuto.property.value">value</a></code> | <code>string \| boolean</code> | *No description.* |
|
|
12237
|
+
|
|
12238
|
+
---
|
|
12239
|
+
|
|
12240
|
+
##### `value`<sup>Required</sup> <a name="value" id="mise-projen.SettingsSelfUpdateAuto.property.value"></a>
|
|
12241
|
+
|
|
12242
|
+
```typescript
|
|
12243
|
+
public readonly value: string | boolean;
|
|
12244
|
+
```
|
|
12245
|
+
|
|
12246
|
+
- *Type:* string | boolean
|
|
12247
|
+
|
|
12248
|
+
---
|
|
12249
|
+
|
|
12250
|
+
|
|
12251
|
+
### SettingsToolUpdateGlobalAuto <a name="SettingsToolUpdateGlobalAuto" id="mise-projen.SettingsToolUpdateGlobalAuto"></a>
|
|
12252
|
+
|
|
12253
|
+
Update every tool in global config automatically, as if each set `auto_update` to this value.
|
|
12254
|
+
|
|
12255
|
+
|
|
12256
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
12257
|
+
|
|
12258
|
+
| **Name** | **Description** |
|
|
12259
|
+
| --- | --- |
|
|
12260
|
+
| <code><a href="#mise-projen.SettingsToolUpdateGlobalAuto.fromBoolean">fromBoolean</a></code> | *No description.* |
|
|
12261
|
+
| <code><a href="#mise-projen.SettingsToolUpdateGlobalAuto.fromString">fromString</a></code> | *No description.* |
|
|
12262
|
+
|
|
12263
|
+
---
|
|
12264
|
+
|
|
12265
|
+
##### `fromBoolean` <a name="fromBoolean" id="mise-projen.SettingsToolUpdateGlobalAuto.fromBoolean"></a>
|
|
12266
|
+
|
|
12267
|
+
```typescript
|
|
12268
|
+
import { SettingsToolUpdateGlobalAuto } from 'mise-projen'
|
|
12269
|
+
|
|
12270
|
+
SettingsToolUpdateGlobalAuto.fromBoolean(value: boolean)
|
|
12271
|
+
```
|
|
12272
|
+
|
|
12273
|
+
###### `value`<sup>Required</sup> <a name="value" id="mise-projen.SettingsToolUpdateGlobalAuto.fromBoolean.parameter.value"></a>
|
|
12274
|
+
|
|
12275
|
+
- *Type:* boolean
|
|
12276
|
+
|
|
12277
|
+
---
|
|
12278
|
+
|
|
12279
|
+
##### `fromString` <a name="fromString" id="mise-projen.SettingsToolUpdateGlobalAuto.fromString"></a>
|
|
12280
|
+
|
|
12281
|
+
```typescript
|
|
12282
|
+
import { SettingsToolUpdateGlobalAuto } from 'mise-projen'
|
|
12283
|
+
|
|
12284
|
+
SettingsToolUpdateGlobalAuto.fromString(value: string)
|
|
12285
|
+
```
|
|
12286
|
+
|
|
12287
|
+
###### `value`<sup>Required</sup> <a name="value" id="mise-projen.SettingsToolUpdateGlobalAuto.fromString.parameter.value"></a>
|
|
12288
|
+
|
|
12289
|
+
- *Type:* string
|
|
12290
|
+
|
|
12291
|
+
---
|
|
12292
|
+
|
|
12293
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
12294
|
+
|
|
12295
|
+
| **Name** | **Type** | **Description** |
|
|
12296
|
+
| --- | --- | --- |
|
|
12297
|
+
| <code><a href="#mise-projen.SettingsToolUpdateGlobalAuto.property.value">value</a></code> | <code>string \| boolean</code> | *No description.* |
|
|
12298
|
+
|
|
12299
|
+
---
|
|
12300
|
+
|
|
12301
|
+
##### `value`<sup>Required</sup> <a name="value" id="mise-projen.SettingsToolUpdateGlobalAuto.property.value"></a>
|
|
12302
|
+
|
|
12303
|
+
```typescript
|
|
12304
|
+
public readonly value: string | boolean;
|
|
12305
|
+
```
|
|
12306
|
+
|
|
12307
|
+
- *Type:* string | boolean
|
|
12308
|
+
|
|
12309
|
+
---
|
|
12310
|
+
|
|
12311
|
+
|
|
12173
12312
|
|
|
12174
12313
|
## Enums <a name="Enums" id="Enums"></a>
|
|
12175
12314
|
|
|
@@ -12691,6 +12830,35 @@ absent.
|
|
|
12691
12830
|
---
|
|
12692
12831
|
|
|
12693
12832
|
|
|
12833
|
+
### MiseTomlSchemaBootstrapLinuxSystemdUnitsState <a name="MiseTomlSchemaBootstrapLinuxSystemdUnitsState" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState"></a>
|
|
12834
|
+
|
|
12835
|
+
present writes and manages the unit;
|
|
12836
|
+
|
|
12837
|
+
absent stops, disables, and removes both dev.mise.<name>.service and dev.mise.<name>.timer
|
|
12838
|
+
|
|
12839
|
+
#### Members <a name="Members" id="Members"></a>
|
|
12840
|
+
|
|
12841
|
+
| **Name** | **Description** |
|
|
12842
|
+
| --- | --- |
|
|
12843
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState.PRESENT">PRESENT</a></code> | present. |
|
|
12844
|
+
| <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState.ABSENT">ABSENT</a></code> | absent. |
|
|
12845
|
+
|
|
12846
|
+
---
|
|
12847
|
+
|
|
12848
|
+
##### `PRESENT` <a name="PRESENT" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState.PRESENT"></a>
|
|
12849
|
+
|
|
12850
|
+
present.
|
|
12851
|
+
|
|
12852
|
+
---
|
|
12853
|
+
|
|
12854
|
+
|
|
12855
|
+
##### `ABSENT` <a name="ABSENT" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsState.ABSENT"></a>
|
|
12856
|
+
|
|
12857
|
+
absent.
|
|
12858
|
+
|
|
12859
|
+
---
|
|
12860
|
+
|
|
12861
|
+
|
|
12694
12862
|
### MiseTomlSchemaBootstrapLinuxSystemdUnitsType <a name="MiseTomlSchemaBootstrapLinuxSystemdUnitsType" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnitsType"></a>
|
|
12695
12863
|
|
|
12696
12864
|
write Type in the [Service] section.
|
|
@@ -13166,7 +13334,7 @@ symlink.
|
|
|
13166
13334
|
|
|
13167
13335
|
### SettingsColorTheme <a name="SettingsColorTheme" id="mise-projen.SettingsColorTheme"></a>
|
|
13168
13336
|
|
|
13169
|
-
|
|
13337
|
+
Color theme for interactive prompts, such as the task picker in `mise run`.
|
|
13170
13338
|
|
|
13171
13339
|
#### Members <a name="Members" id="Members"></a>
|
|
13172
13340
|
|
|
@@ -13223,11 +13391,122 @@ dracula.
|
|
|
13223
13391
|
---
|
|
13224
13392
|
|
|
13225
13393
|
|
|
13226
|
-
###
|
|
13394
|
+
### SettingsDotfilesDefaultMode <a name="SettingsDotfilesDefaultMode" id="mise-projen.SettingsDotfilesDefaultMode"></a>
|
|
13227
13395
|
|
|
13228
|
-
|
|
13396
|
+
Mode for `[dotfiles]` entries that do not set `mode`.
|
|
13229
13397
|
|
|
13230
|
-
|
|
13398
|
+
#### Members <a name="Members" id="Members"></a>
|
|
13399
|
+
|
|
13400
|
+
| **Name** | **Description** |
|
|
13401
|
+
| --- | --- |
|
|
13402
|
+
| <code><a href="#mise-projen.SettingsDotfilesDefaultMode.SYMLINK">SYMLINK</a></code> | symlink. |
|
|
13403
|
+
| <code><a href="#mise-projen.SettingsDotfilesDefaultMode.SYMLINK_HYPHEN_EACH">SYMLINK_HYPHEN_EACH</a></code> | symlink-each. |
|
|
13404
|
+
| <code><a href="#mise-projen.SettingsDotfilesDefaultMode.COPY">COPY</a></code> | copy. |
|
|
13405
|
+
| <code><a href="#mise-projen.SettingsDotfilesDefaultMode.TEMPLATE">TEMPLATE</a></code> | template. |
|
|
13406
|
+
|
|
13407
|
+
---
|
|
13408
|
+
|
|
13409
|
+
##### `SYMLINK` <a name="SYMLINK" id="mise-projen.SettingsDotfilesDefaultMode.SYMLINK"></a>
|
|
13410
|
+
|
|
13411
|
+
symlink.
|
|
13412
|
+
|
|
13413
|
+
---
|
|
13414
|
+
|
|
13415
|
+
|
|
13416
|
+
##### `SYMLINK_HYPHEN_EACH` <a name="SYMLINK_HYPHEN_EACH" id="mise-projen.SettingsDotfilesDefaultMode.SYMLINK_HYPHEN_EACH"></a>
|
|
13417
|
+
|
|
13418
|
+
symlink-each.
|
|
13419
|
+
|
|
13420
|
+
---
|
|
13421
|
+
|
|
13422
|
+
|
|
13423
|
+
##### `COPY` <a name="COPY" id="mise-projen.SettingsDotfilesDefaultMode.COPY"></a>
|
|
13424
|
+
|
|
13425
|
+
copy.
|
|
13426
|
+
|
|
13427
|
+
---
|
|
13428
|
+
|
|
13429
|
+
|
|
13430
|
+
##### `TEMPLATE` <a name="TEMPLATE" id="mise-projen.SettingsDotfilesDefaultMode.TEMPLATE"></a>
|
|
13431
|
+
|
|
13432
|
+
template.
|
|
13433
|
+
|
|
13434
|
+
---
|
|
13435
|
+
|
|
13436
|
+
|
|
13437
|
+
### SettingsErlangPrecompiledOs <a name="SettingsErlangPrecompiledOs" id="mise-projen.SettingsErlangPrecompiledOs"></a>
|
|
13438
|
+
|
|
13439
|
+
Ubuntu release whose precompiled Erlang build from builds.hex.pm mise installs on Linux.
|
|
13440
|
+
|
|
13441
|
+
#### Members <a name="Members" id="Members"></a>
|
|
13442
|
+
|
|
13443
|
+
| **Name** | **Description** |
|
|
13444
|
+
| --- | --- |
|
|
13445
|
+
| <code><a href="#mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_20_04">UBUNTU_HYPHEN_20_04</a></code> | ubuntu-20.04. |
|
|
13446
|
+
| <code><a href="#mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_22_04">UBUNTU_HYPHEN_22_04</a></code> | ubuntu-22.04. |
|
|
13447
|
+
| <code><a href="#mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_24_04">UBUNTU_HYPHEN_24_04</a></code> | ubuntu-24.04. |
|
|
13448
|
+
| <code><a href="#mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_26_04">UBUNTU_HYPHEN_26_04</a></code> | ubuntu-26.04. |
|
|
13449
|
+
|
|
13450
|
+
---
|
|
13451
|
+
|
|
13452
|
+
##### `UBUNTU_HYPHEN_20_04` <a name="UBUNTU_HYPHEN_20_04" id="mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_20_04"></a>
|
|
13453
|
+
|
|
13454
|
+
ubuntu-20.04.
|
|
13455
|
+
|
|
13456
|
+
---
|
|
13457
|
+
|
|
13458
|
+
|
|
13459
|
+
##### `UBUNTU_HYPHEN_22_04` <a name="UBUNTU_HYPHEN_22_04" id="mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_22_04"></a>
|
|
13460
|
+
|
|
13461
|
+
ubuntu-22.04.
|
|
13462
|
+
|
|
13463
|
+
---
|
|
13464
|
+
|
|
13465
|
+
|
|
13466
|
+
##### `UBUNTU_HYPHEN_24_04` <a name="UBUNTU_HYPHEN_24_04" id="mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_24_04"></a>
|
|
13467
|
+
|
|
13468
|
+
ubuntu-24.04.
|
|
13469
|
+
|
|
13470
|
+
---
|
|
13471
|
+
|
|
13472
|
+
|
|
13473
|
+
##### `UBUNTU_HYPHEN_26_04` <a name="UBUNTU_HYPHEN_26_04" id="mise-projen.SettingsErlangPrecompiledOs.UBUNTU_HYPHEN_26_04"></a>
|
|
13474
|
+
|
|
13475
|
+
ubuntu-26.04.
|
|
13476
|
+
|
|
13477
|
+
---
|
|
13478
|
+
|
|
13479
|
+
|
|
13480
|
+
### SettingsGithubRelayLogFormat <a name="SettingsGithubRelayLogFormat" id="mise-projen.SettingsGithubRelayLogFormat"></a>
|
|
13481
|
+
|
|
13482
|
+
Format of GitHub relay request logs and the end-of-session summary.
|
|
13483
|
+
|
|
13484
|
+
#### Members <a name="Members" id="Members"></a>
|
|
13485
|
+
|
|
13486
|
+
| **Name** | **Description** |
|
|
13487
|
+
| --- | --- |
|
|
13488
|
+
| <code><a href="#mise-projen.SettingsGithubRelayLogFormat.TEXT">TEXT</a></code> | text. |
|
|
13489
|
+
| <code><a href="#mise-projen.SettingsGithubRelayLogFormat.JSONL">JSONL</a></code> | jsonl. |
|
|
13490
|
+
|
|
13491
|
+
---
|
|
13492
|
+
|
|
13493
|
+
##### `TEXT` <a name="TEXT" id="mise-projen.SettingsGithubRelayLogFormat.TEXT"></a>
|
|
13494
|
+
|
|
13495
|
+
text.
|
|
13496
|
+
|
|
13497
|
+
---
|
|
13498
|
+
|
|
13499
|
+
|
|
13500
|
+
##### `JSONL` <a name="JSONL" id="mise-projen.SettingsGithubRelayLogFormat.JSONL"></a>
|
|
13501
|
+
|
|
13502
|
+
jsonl.
|
|
13503
|
+
|
|
13504
|
+
---
|
|
13505
|
+
|
|
13506
|
+
|
|
13507
|
+
### SettingsHistorySync <a name="SettingsHistorySync" id="mise-projen.SettingsHistorySync"></a>
|
|
13508
|
+
|
|
13509
|
+
What the history watcher shares with a connected setup repository on its own.
|
|
13231
13510
|
|
|
13232
13511
|
#### Members <a name="Members" id="Members"></a>
|
|
13233
13512
|
|
|
@@ -13289,7 +13568,7 @@ identity.
|
|
|
13289
13568
|
|
|
13290
13569
|
### SettingsLibc <a name="SettingsLibc" id="mise-projen.SettingsLibc"></a>
|
|
13291
13570
|
|
|
13292
|
-
Libc
|
|
13571
|
+
Libc build to install on Linux when a tool publishes both glibc and musl builds.
|
|
13293
13572
|
|
|
13294
13573
|
#### Members <a name="Members" id="Members"></a>
|
|
13295
13574
|
|
|
@@ -13357,7 +13636,7 @@ system.
|
|
|
13357
13636
|
|
|
13358
13637
|
### SettingsLockfileMode <a name="SettingsLockfileMode" id="mise-projen.SettingsLockfileMode"></a>
|
|
13359
13638
|
|
|
13360
|
-
|
|
13639
|
+
How lockfiles are written: entry by entry, or rebuilt from the current requests.
|
|
13361
13640
|
|
|
13362
13641
|
#### Members <a name="Members" id="Members"></a>
|
|
13363
13642
|
|
|
@@ -13384,7 +13663,7 @@ generate.
|
|
|
13384
13663
|
|
|
13385
13664
|
### SettingsLogLevel <a name="SettingsLogLevel" id="mise-projen.SettingsLogLevel"></a>
|
|
13386
13665
|
|
|
13387
|
-
|
|
13666
|
+
Log level for mise's own output.
|
|
13388
13667
|
|
|
13389
13668
|
#### Members <a name="Members" id="Members"></a>
|
|
13390
13669
|
|
|
@@ -13435,7 +13714,7 @@ error.
|
|
|
13435
13714
|
|
|
13436
13715
|
### SettingsNpmPackageManager <a name="SettingsNpmPackageManager" id="mise-projen.SettingsNpmPackageManager"></a>
|
|
13437
13716
|
|
|
13438
|
-
Package manager
|
|
13717
|
+
Package manager that installs `npm:` tools.
|
|
13439
13718
|
|
|
13440
13719
|
#### Members <a name="Members" id="Members"></a>
|
|
13441
13720
|
|
|
@@ -13492,9 +13771,44 @@ pnpm.
|
|
|
13492
13771
|
---
|
|
13493
13772
|
|
|
13494
13773
|
|
|
13774
|
+
### SettingsStatusMissingTools <a name="SettingsStatusMissingTools" id="mise-projen.SettingsStatusMissingTools"></a>
|
|
13775
|
+
|
|
13776
|
+
When to warn that tools requested by config are not installed.
|
|
13777
|
+
|
|
13778
|
+
#### Members <a name="Members" id="Members"></a>
|
|
13779
|
+
|
|
13780
|
+
| **Name** | **Description** |
|
|
13781
|
+
| --- | --- |
|
|
13782
|
+
| <code><a href="#mise-projen.SettingsStatusMissingTools.NEVER">NEVER</a></code> | never. |
|
|
13783
|
+
| <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. |
|
|
13784
|
+
| <code><a href="#mise-projen.SettingsStatusMissingTools.ALWAYS">ALWAYS</a></code> | always. |
|
|
13785
|
+
|
|
13786
|
+
---
|
|
13787
|
+
|
|
13788
|
+
##### `NEVER` <a name="NEVER" id="mise-projen.SettingsStatusMissingTools.NEVER"></a>
|
|
13789
|
+
|
|
13790
|
+
never.
|
|
13791
|
+
|
|
13792
|
+
---
|
|
13793
|
+
|
|
13794
|
+
|
|
13795
|
+
##### `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>
|
|
13796
|
+
|
|
13797
|
+
if_other_versions_installed.
|
|
13798
|
+
|
|
13799
|
+
---
|
|
13800
|
+
|
|
13801
|
+
|
|
13802
|
+
##### `ALWAYS` <a name="ALWAYS" id="mise-projen.SettingsStatusMissingTools.ALWAYS"></a>
|
|
13803
|
+
|
|
13804
|
+
always.
|
|
13805
|
+
|
|
13806
|
+
---
|
|
13807
|
+
|
|
13808
|
+
|
|
13495
13809
|
### SettingsSystemDeps <a name="SettingsSystemDeps" id="mise-projen.SettingsSystemDeps"></a>
|
|
13496
13810
|
|
|
13497
|
-
|
|
13811
|
+
What mise does when a plugin's declared system dependencies are missing before it installs a tool.
|
|
13498
13812
|
|
|
13499
13813
|
#### Members <a name="Members" id="Members"></a>
|
|
13500
13814
|
|
|
@@ -13537,7 +13851,7 @@ ignore.
|
|
|
13537
13851
|
|
|
13538
13852
|
### SettingsTaskCacheRemoteMode <a name="SettingsTaskCacheRemoteMode" id="mise-projen.SettingsTaskCacheRemoteMode"></a>
|
|
13539
13853
|
|
|
13540
|
-
[experimental]
|
|
13854
|
+
[experimental] How mise uses the remote task cache server.
|
|
13541
13855
|
|
|
13542
13856
|
#### Members <a name="Members" id="Members"></a>
|
|
13543
13857
|
|
|
@@ -13572,7 +13886,7 @@ write-only.
|
|
|
13572
13886
|
|
|
13573
13887
|
### SettingsTaskOutput <a name="SettingsTaskOutput" id="mise-projen.SettingsTaskOutput"></a>
|
|
13574
13888
|
|
|
13575
|
-
|
|
13889
|
+
Default output style for `mise run`.
|
|
13576
13890
|
|
|
13577
13891
|
#### Members <a name="Members" id="Members"></a>
|
|
13578
13892
|
|
|
@@ -13636,3 +13950,46 @@ silent.
|
|
|
13636
13950
|
|
|
13637
13951
|
---
|
|
13638
13952
|
|
|
13953
|
+
|
|
13954
|
+
### SettingsWindowsShimMode <a name="SettingsWindowsShimMode" id="mise-projen.SettingsWindowsShimMode"></a>
|
|
13955
|
+
|
|
13956
|
+
How mise creates shims on Windows.
|
|
13957
|
+
|
|
13958
|
+
#### Members <a name="Members" id="Members"></a>
|
|
13959
|
+
|
|
13960
|
+
| **Name** | **Description** |
|
|
13961
|
+
| --- | --- |
|
|
13962
|
+
| <code><a href="#mise-projen.SettingsWindowsShimMode.EXE">EXE</a></code> | exe. |
|
|
13963
|
+
| <code><a href="#mise-projen.SettingsWindowsShimMode.FILE">FILE</a></code> | file. |
|
|
13964
|
+
| <code><a href="#mise-projen.SettingsWindowsShimMode.HARDLINK">HARDLINK</a></code> | hardlink. |
|
|
13965
|
+
| <code><a href="#mise-projen.SettingsWindowsShimMode.SYMLINK">SYMLINK</a></code> | symlink. |
|
|
13966
|
+
|
|
13967
|
+
---
|
|
13968
|
+
|
|
13969
|
+
##### `EXE` <a name="EXE" id="mise-projen.SettingsWindowsShimMode.EXE"></a>
|
|
13970
|
+
|
|
13971
|
+
exe.
|
|
13972
|
+
|
|
13973
|
+
---
|
|
13974
|
+
|
|
13975
|
+
|
|
13976
|
+
##### `FILE` <a name="FILE" id="mise-projen.SettingsWindowsShimMode.FILE"></a>
|
|
13977
|
+
|
|
13978
|
+
file.
|
|
13979
|
+
|
|
13980
|
+
---
|
|
13981
|
+
|
|
13982
|
+
|
|
13983
|
+
##### `HARDLINK` <a name="HARDLINK" id="mise-projen.SettingsWindowsShimMode.HARDLINK"></a>
|
|
13984
|
+
|
|
13985
|
+
hardlink.
|
|
13986
|
+
|
|
13987
|
+
---
|
|
13988
|
+
|
|
13989
|
+
|
|
13990
|
+
##### `SYMLINK` <a name="SYMLINK" id="mise-projen.SettingsWindowsShimMode.SYMLINK"></a>
|
|
13991
|
+
|
|
13992
|
+
symlink.
|
|
13993
|
+
|
|
13994
|
+
---
|
|
13995
|
+
|