mise-projen 0.0.21 → 0.0.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/API.md CHANGED
@@ -333,6 +333,8 @@ The generated mise config file.
333
333
 
334
334
  ### BootstrapAptSources <a name="BootstrapAptSources" id="mise-projen.BootstrapAptSources"></a>
335
335
 
336
+ apt source: a Launchpad PPA, or repository URIs with the key that signs them.
337
+
336
338
  #### Initializer <a name="Initializer" id="mise-projen.BootstrapAptSources.Initializer"></a>
337
339
 
338
340
  ```typescript
@@ -449,6 +451,8 @@ repository URL(s), space-separated.
449
451
 
450
452
  ### BootstrapDnfRepos <a name="BootstrapDnfRepos" id="mise-projen.BootstrapDnfRepos"></a>
451
453
 
454
+ dnf repository to enable, given as a COPR project.
455
+
452
456
  #### Initializer <a name="Initializer" id="mise-projen.BootstrapDnfRepos.Initializer"></a>
453
457
 
454
458
  ```typescript
@@ -1060,14 +1064,14 @@ const bootstrapMiseShellActivate: BootstrapMiseShellActivate = { ... }
1060
1064
 
1061
1065
  | **Name** | **Type** | **Description** |
1062
1066
  | --- | --- | --- |
1063
- | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.bash">bash</a></code> | <code>any</code> | *No description.* |
1064
- | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.bashProfile">bashProfile</a></code> | <code>any</code> | *No description.* |
1065
- | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.bashrc">bashrc</a></code> | <code>any</code> | *No description.* |
1066
- | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.fish">fish</a></code> | <code>any</code> | *No description.* |
1067
- | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.zprofile">zprofile</a></code> | <code>any</code> | *No description.* |
1068
- | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.zsh">zsh</a></code> | <code>any</code> | *No description.* |
1069
- | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.zshenv">zshenv</a></code> | <code>any</code> | *No description.* |
1070
- | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.zshrc">zshrc</a></code> | <code>any</code> | *No description.* |
1067
+ | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.bash">bash</a></code> | <code>any</code> | manage the activation blocks in ~/.bash_profile (shims) and ~/.bashrc (activate); a mode applies to both files. |
1068
+ | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.bashProfile">bashProfile</a></code> | <code>any</code> | manage the activation block in ~/.bash_profile; shims by default. |
1069
+ | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.bashrc">bashrc</a></code> | <code>any</code> | manage the activation block in ~/.bashrc; activate by default. |
1070
+ | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.fish">fish</a></code> | <code>any</code> | manage the activation block in ~/.config/fish/config.fish; activate by default, and auto activates interactive shells and uses shims otherwise. |
1071
+ | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.zprofile">zprofile</a></code> | <code>any</code> | manage the activation block in ~/.zprofile; shims by default. |
1072
+ | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.zsh">zsh</a></code> | <code>any</code> | manage the activation blocks in ~/.zprofile (shims) and ~/.zshrc (activate); a mode applies to both files, and ~/.zshenv is never written. |
1073
+ | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.zshenv">zshenv</a></code> | <code>any</code> | manage the activation block in ~/.zshenv, which zsh reads for every script; shims by default. |
1074
+ | <code><a href="#mise-projen.BootstrapMiseShellActivate.property.zshrc">zshrc</a></code> | <code>any</code> | manage the activation block in ~/.zshrc; activate by default. |
1071
1075
 
1072
1076
  ---
1073
1077
 
@@ -1079,6 +1083,8 @@ public readonly bash: any;
1079
1083
 
1080
1084
  - *Type:* any
1081
1085
 
1086
+ manage the activation blocks in ~/.bash_profile (shims) and ~/.bashrc (activate); a mode applies to both files.
1087
+
1082
1088
  ---
1083
1089
 
1084
1090
  ##### `bashProfile`<sup>Optional</sup> <a name="bashProfile" id="mise-projen.BootstrapMiseShellActivate.property.bashProfile"></a>
@@ -1089,6 +1095,8 @@ public readonly bashProfile: any;
1089
1095
 
1090
1096
  - *Type:* any
1091
1097
 
1098
+ manage the activation block in ~/.bash_profile; shims by default.
1099
+
1092
1100
  ---
1093
1101
 
1094
1102
  ##### `bashrc`<sup>Optional</sup> <a name="bashrc" id="mise-projen.BootstrapMiseShellActivate.property.bashrc"></a>
@@ -1099,6 +1107,8 @@ public readonly bashrc: any;
1099
1107
 
1100
1108
  - *Type:* any
1101
1109
 
1110
+ manage the activation block in ~/.bashrc; activate by default.
1111
+
1102
1112
  ---
1103
1113
 
1104
1114
  ##### `fish`<sup>Optional</sup> <a name="fish" id="mise-projen.BootstrapMiseShellActivate.property.fish"></a>
@@ -1109,6 +1119,8 @@ public readonly fish: any;
1109
1119
 
1110
1120
  - *Type:* any
1111
1121
 
1122
+ manage the activation block in ~/.config/fish/config.fish; activate by default, and auto activates interactive shells and uses shims otherwise.
1123
+
1112
1124
  ---
1113
1125
 
1114
1126
  ##### `zprofile`<sup>Optional</sup> <a name="zprofile" id="mise-projen.BootstrapMiseShellActivate.property.zprofile"></a>
@@ -1119,6 +1131,8 @@ public readonly zprofile: any;
1119
1131
 
1120
1132
  - *Type:* any
1121
1133
 
1134
+ manage the activation block in ~/.zprofile; shims by default.
1135
+
1122
1136
  ---
1123
1137
 
1124
1138
  ##### `zsh`<sup>Optional</sup> <a name="zsh" id="mise-projen.BootstrapMiseShellActivate.property.zsh"></a>
@@ -1129,6 +1143,8 @@ public readonly zsh: any;
1129
1143
 
1130
1144
  - *Type:* any
1131
1145
 
1146
+ manage the activation blocks in ~/.zprofile (shims) and ~/.zshrc (activate); a mode applies to both files, and ~/.zshenv is never written.
1147
+
1132
1148
  ---
1133
1149
 
1134
1150
  ##### `zshenv`<sup>Optional</sup> <a name="zshenv" id="mise-projen.BootstrapMiseShellActivate.property.zshenv"></a>
@@ -1139,6 +1155,8 @@ public readonly zshenv: any;
1139
1155
 
1140
1156
  - *Type:* any
1141
1157
 
1158
+ manage the activation block in ~/.zshenv, which zsh reads for every script; shims by default.
1159
+
1142
1160
  ---
1143
1161
 
1144
1162
  ##### `zshrc`<sup>Optional</sup> <a name="zshrc" id="mise-projen.BootstrapMiseShellActivate.property.zshrc"></a>
@@ -1149,6 +1167,8 @@ public readonly zshrc: any;
1149
1167
 
1150
1168
  - *Type:* any
1151
1169
 
1170
+ manage the activation block in ~/.zshrc; activate by default.
1171
+
1152
1172
  ---
1153
1173
 
1154
1174
  ### DepsProvider <a name="DepsProvider" id="mise-projen.DepsProvider"></a>
@@ -1303,7 +1323,7 @@ const doctor: Doctor = { ... }
1303
1323
 
1304
1324
  | **Name** | **Type** | **Description** |
1305
1325
  | --- | --- | --- |
1306
- | <code><a href="#mise-projen.Doctor.property.checks">checks</a></code> | <code>{[ key: string ]: <a href="#mise-projen.DoctorChecks">DoctorChecks</a>}</code> | *No description.* |
1326
+ | <code><a href="#mise-projen.Doctor.property.checks">checks</a></code> | <code>{[ key: string ]: <a href="#mise-projen.DoctorChecks">DoctorChecks</a>}</code> | Checks run by mise doctor project, keyed by check name. |
1307
1327
 
1308
1328
  ---
1309
1329
 
@@ -1315,10 +1335,14 @@ public readonly checks: {[ key: string ]: DoctorChecks};
1315
1335
 
1316
1336
  - *Type:* {[ key: string ]: <a href="#mise-projen.DoctorChecks">DoctorChecks</a>}
1317
1337
 
1338
+ Checks run by mise doctor project, keyed by check name.
1339
+
1318
1340
  ---
1319
1341
 
1320
1342
  ### DoctorChecks <a name="DoctorChecks" id="mise-projen.DoctorChecks"></a>
1321
1343
 
1344
+ A check: a command that passes when it exits zero.
1345
+
1322
1346
  #### Initializer <a name="Initializer" id="mise-projen.DoctorChecks.Initializer"></a>
1323
1347
 
1324
1348
  ```typescript
@@ -1465,11 +1489,11 @@ const hooks: Hooks = { ... }
1465
1489
 
1466
1490
  | **Name** | **Type** | **Description** |
1467
1491
  | --- | --- | --- |
1468
- | <code><a href="#mise-projen.Hooks.property.cd">cd</a></code> | <code>any[]</code> | *No description.* |
1469
- | <code><a href="#mise-projen.Hooks.property.enter">enter</a></code> | <code>any[]</code> | *No description.* |
1470
- | <code><a href="#mise-projen.Hooks.property.leave">leave</a></code> | <code>any[]</code> | *No description.* |
1471
- | <code><a href="#mise-projen.Hooks.property.postinstall">postinstall</a></code> | <code>any[]</code> | *No description.* |
1472
- | <code><a href="#mise-projen.Hooks.property.preinstall">preinstall</a></code> | <code>any[]</code> | *No description.* |
1492
+ | <code><a href="#mise-projen.Hooks.property.cd">cd</a></code> | <code>any[]</code> | hooks to run when an activated shell changes to a directory inside the project. |
1493
+ | <code><a href="#mise-projen.Hooks.property.enter">enter</a></code> | <code>any[]</code> | hooks to run when an activated shell moves into the project. |
1494
+ | <code><a href="#mise-projen.Hooks.property.leave">leave</a></code> | <code>any[]</code> | hooks to run when an activated shell moves out of the project. |
1495
+ | <code><a href="#mise-projen.Hooks.property.postinstall">postinstall</a></code> | <code>any[]</code> | hooks to run after mise installs tools. |
1496
+ | <code><a href="#mise-projen.Hooks.property.preinstall">preinstall</a></code> | <code>any[]</code> | hooks to run before mise installs tools. |
1473
1497
 
1474
1498
  ---
1475
1499
 
@@ -1481,6 +1505,8 @@ public readonly cd: any[];
1481
1505
 
1482
1506
  - *Type:* any[]
1483
1507
 
1508
+ hooks to run when an activated shell changes to a directory inside the project.
1509
+
1484
1510
  ---
1485
1511
 
1486
1512
  ##### `enter`<sup>Optional</sup> <a name="enter" id="mise-projen.Hooks.property.enter"></a>
@@ -1491,6 +1517,8 @@ public readonly enter: any[];
1491
1517
 
1492
1518
  - *Type:* any[]
1493
1519
 
1520
+ hooks to run when an activated shell moves into the project.
1521
+
1494
1522
  ---
1495
1523
 
1496
1524
  ##### `leave`<sup>Optional</sup> <a name="leave" id="mise-projen.Hooks.property.leave"></a>
@@ -1501,6 +1529,8 @@ public readonly leave: any[];
1501
1529
 
1502
1530
  - *Type:* any[]
1503
1531
 
1532
+ hooks to run when an activated shell moves out of the project.
1533
+
1504
1534
  ---
1505
1535
 
1506
1536
  ##### `postinstall`<sup>Optional</sup> <a name="postinstall" id="mise-projen.Hooks.property.postinstall"></a>
@@ -1511,6 +1541,8 @@ public readonly postinstall: any[];
1511
1541
 
1512
1542
  - *Type:* any[]
1513
1543
 
1544
+ hooks to run after mise installs tools.
1545
+
1514
1546
  ---
1515
1547
 
1516
1548
  ##### `preinstall`<sup>Optional</sup> <a name="preinstall" id="mise-projen.Hooks.property.preinstall"></a>
@@ -1521,6 +1553,8 @@ public readonly preinstall: any[];
1521
1553
 
1522
1554
  - *Type:* any[]
1523
1555
 
1556
+ hooks to run before mise installs tools.
1557
+
1524
1558
  ---
1525
1559
 
1526
1560
  ### LaunchdCalendarInterval <a name="LaunchdCalendarInterval" id="mise-projen.LaunchdCalendarInterval"></a>
@@ -1539,11 +1573,11 @@ const launchdCalendarInterval: LaunchdCalendarInterval = { ... }
1539
1573
 
1540
1574
  | **Name** | **Type** | **Description** |
1541
1575
  | --- | --- | --- |
1542
- | <code><a href="#mise-projen.LaunchdCalendarInterval.property.day">day</a></code> | <code>number</code> | *No description.* |
1543
- | <code><a href="#mise-projen.LaunchdCalendarInterval.property.hour">hour</a></code> | <code>number</code> | *No description.* |
1544
- | <code><a href="#mise-projen.LaunchdCalendarInterval.property.minute">minute</a></code> | <code>number</code> | *No description.* |
1545
- | <code><a href="#mise-projen.LaunchdCalendarInterval.property.month">month</a></code> | <code>number</code> | *No description.* |
1546
- | <code><a href="#mise-projen.LaunchdCalendarInterval.property.weekday">weekday</a></code> | <code>number</code> | *No description.* |
1576
+ | <code><a href="#mise-projen.LaunchdCalendarInterval.property.day">day</a></code> | <code>number</code> | day of the month, 1-31; |
1577
+ | <code><a href="#mise-projen.LaunchdCalendarInterval.property.hour">hour</a></code> | <code>number</code> | hour of the day, 0-23; |
1578
+ | <code><a href="#mise-projen.LaunchdCalendarInterval.property.minute">minute</a></code> | <code>number</code> | minute of the hour, 0-59; |
1579
+ | <code><a href="#mise-projen.LaunchdCalendarInterval.property.month">month</a></code> | <code>number</code> | month of the year, 1-12; |
1580
+ | <code><a href="#mise-projen.LaunchdCalendarInterval.property.weekday">weekday</a></code> | <code>number</code> | day of the week, 0-7, where 0 and 7 are Sunday; |
1547
1581
 
1548
1582
  ---
1549
1583
 
@@ -1555,6 +1589,10 @@ public readonly day: number;
1555
1589
 
1556
1590
  - *Type:* number
1557
1591
 
1592
+ day of the month, 1-31;
1593
+
1594
+ every day when unset
1595
+
1558
1596
  ---
1559
1597
 
1560
1598
  ##### `hour`<sup>Optional</sup> <a name="hour" id="mise-projen.LaunchdCalendarInterval.property.hour"></a>
@@ -1565,6 +1603,10 @@ public readonly hour: number;
1565
1603
 
1566
1604
  - *Type:* number
1567
1605
 
1606
+ hour of the day, 0-23;
1607
+
1608
+ every hour when unset
1609
+
1568
1610
  ---
1569
1611
 
1570
1612
  ##### `minute`<sup>Optional</sup> <a name="minute" id="mise-projen.LaunchdCalendarInterval.property.minute"></a>
@@ -1575,6 +1617,10 @@ public readonly minute: number;
1575
1617
 
1576
1618
  - *Type:* number
1577
1619
 
1620
+ minute of the hour, 0-59;
1621
+
1622
+ every minute when unset
1623
+
1578
1624
  ---
1579
1625
 
1580
1626
  ##### `month`<sup>Optional</sup> <a name="month" id="mise-projen.LaunchdCalendarInterval.property.month"></a>
@@ -1585,6 +1631,10 @@ public readonly month: number;
1585
1631
 
1586
1632
  - *Type:* number
1587
1633
 
1634
+ month of the year, 1-12;
1635
+
1636
+ every month when unset
1637
+
1588
1638
  ---
1589
1639
 
1590
1640
  ##### `weekday`<sup>Optional</sup> <a name="weekday" id="mise-projen.LaunchdCalendarInterval.property.weekday"></a>
@@ -1595,6 +1645,10 @@ public readonly weekday: number;
1595
1645
 
1596
1646
  - *Type:* number
1597
1647
 
1648
+ day of the week, 0-7, where 0 and 7 are Sunday;
1649
+
1650
+ every day when unset
1651
+
1598
1652
  ---
1599
1653
 
1600
1654
  ### MiseFileOptions <a name="MiseFileOptions" id="mise-projen.MiseFileOptions"></a>
@@ -1731,7 +1785,7 @@ const miseTomlSchema: MiseTomlSchema = { ... }
1731
1785
  | <code><a href="#mise-projen.MiseTomlSchema.property.daemonProviders">daemonProviders</a></code> | <code>{[ key: string ]: <a href="#mise-projen.MiseTomlSchemaDaemonProviders">MiseTomlSchemaDaemonProviders</a>}</code> | Experimental shared servers owned by the user. |
1732
1786
  | <code><a href="#mise-projen.MiseTomlSchema.property.daemons">daemons</a></code> | <code>{[ key: string ]: any}</code> | Experimental project daemons: custom pitchfork commands or managed presets. |
1733
1787
  | <code><a href="#mise-projen.MiseTomlSchema.property.daemonsSettings">daemonsSettings</a></code> | <code><a href="#mise-projen.MiseTomlSchemaDaemonsSettings">MiseTomlSchemaDaemonsSettings</a></code> | Experimental project-wide daemon options. |
1734
- | <code><a href="#mise-projen.MiseTomlSchema.property.deps">deps</a></code> | <code><a href="#mise-projen.MiseTomlSchemaDeps">MiseTomlSchemaDeps</a></code> | configure deps providers. |
1788
+ | <code><a href="#mise-projen.MiseTomlSchema.property.deps">deps</a></code> | <code><a href="#mise-projen.MiseTomlSchemaDeps">MiseTomlSchemaDeps</a></code> | [experimental] configure deps providers. |
1735
1789
  | <code><a href="#mise-projen.MiseTomlSchema.property.doctor">doctor</a></code> | <code><a href="#mise-projen.Doctor">Doctor</a></code> | *No description.* |
1736
1790
  | <code><a href="#mise-projen.MiseTomlSchema.property.dotenv">dotenv</a></code> | <code>any</code> | dotenv file(s) to load. |
1737
1791
  | <code><a href="#mise-projen.MiseTomlSchema.property.dotfileGroups">dotfileGroups</a></code> | <code>{[ key: string ]: <a href="#mise-projen.MiseTomlSchemaDotfileGroups">MiseTomlSchemaDotfileGroups</a>}</code> | named directory trees of dotfiles, applied with `mise dotfiles apply` or `mise bootstrap` while [bootstrap] dotfile_groups selects them (or is unset). |
@@ -1746,7 +1800,7 @@ const miseTomlSchema: MiseTomlSchema = { ... }
1746
1800
  | <code><a href="#mise-projen.MiseTomlSchema.property.minVersion">minVersion</a></code> | <code>any</code> | minimum version of mise required to use this config. |
1747
1801
  | <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. |
1748
1802
  | <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. |
1749
- | <code><a href="#mise-projen.MiseTomlSchema.property.oci">oci</a></code> | <code><a href="#mise-projen.MiseTomlSchemaOci">MiseTomlSchemaOci</a></code> | configuration for `mise oci build`. |
1803
+ | <code><a href="#mise-projen.MiseTomlSchema.property.oci">oci</a></code> | <code><a href="#mise-projen.MiseTomlSchemaOci">MiseTomlSchemaOci</a></code> | [experimental] configuration for `mise oci build`. |
1750
1804
  | <code><a href="#mise-projen.MiseTomlSchema.property.plugins">plugins</a></code> | <code>{[ key: string ]: string}</code> | plugins to use. |
1751
1805
  | <code><a href="#mise-projen.MiseTomlSchema.property.redactions">redactions</a></code> | <code>string[]</code> | env or vars keys to redact from logs. |
1752
1806
  | <code><a href="#mise-projen.MiseTomlSchema.property.secrets">secrets</a></code> | <code><a href="#mise-projen.MiseTomlSchemaSecrets">MiseTomlSchemaSecrets</a></code> | [experimental] Sources for mise secrets: values resolved only when mise starts a task or `mise x` command that was granted them. |
@@ -1848,7 +1902,7 @@ public readonly deps: MiseTomlSchemaDeps;
1848
1902
 
1849
1903
  - *Type:* <a href="#mise-projen.MiseTomlSchemaDeps">MiseTomlSchemaDeps</a>
1850
1904
 
1851
- configure deps providers.
1905
+ [experimental] configure deps providers.
1852
1906
 
1853
1907
  ---
1854
1908
 
@@ -2034,7 +2088,7 @@ public readonly oci: MiseTomlSchemaOci;
2034
2088
 
2035
2089
  - *Type:* <a href="#mise-projen.MiseTomlSchemaOci">MiseTomlSchemaOci</a>
2036
2090
 
2037
- configuration for `mise oci build`.
2091
+ [experimental] configuration for `mise oci build`.
2038
2092
 
2039
2093
  ---
2040
2094
 
@@ -2577,6 +2631,8 @@ Homebrew tap names mapped to custom git URLs.
2577
2631
 
2578
2632
  ### MiseTomlSchemaBootstrapCompose <a name="MiseTomlSchemaBootstrapCompose" id="mise-projen.MiseTomlSchemaBootstrapCompose"></a>
2579
2633
 
2634
+ Docker Compose project that mise brings up, stops, or removes.
2635
+
2580
2636
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapCompose.Initializer"></a>
2581
2637
 
2582
2638
  ```typescript
@@ -2590,26 +2646,26 @@ const miseTomlSchemaBootstrapCompose: MiseTomlSchemaBootstrapCompose = { ... }
2590
2646
  | **Name** | **Type** | **Description** |
2591
2647
  | --- | --- | --- |
2592
2648
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.projectDir">projectDir</a></code> | <code>string</code> | absolute directory containing the Compose project. |
2593
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.buildValue">buildValue</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild">MiseTomlSchemaBootstrapComposeBuild</a></code> | *No description.* |
2649
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.buildValue">buildValue</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild">MiseTomlSchemaBootstrapComposeBuild</a></code> | auto lets Compose decide, always passes --build, never passes --no-build. |
2594
2650
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.command">command</a></code> | <code>string[]</code> | standalone Compose command. |
2595
2651
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.dependsOn">dependsOn</a></code> | <code>string[]</code> | bootstrap resource dependencies. |
2596
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.downImages">downImages</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeDownImages">MiseTomlSchemaBootstrapComposeDownImages</a></code> | *No description.* |
2597
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.downVolumes">downVolumes</a></code> | <code>boolean</code> | *No description.* |
2652
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.downImages">downImages</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeDownImages">MiseTomlSchemaBootstrapComposeDownImages</a></code> | images compose down removes, passed as --rmi. |
2653
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.downVolumes">downVolumes</a></code> | <code>boolean</code> | pass --volumes to compose down, removing the project's volumes. |
2598
2654
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.engineCommand">engineCommand</a></code> | <code>string[]</code> | container engine command. |
2599
2655
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.envFiles">envFiles</a></code> | <code>string[]</code> | environment file paths relative to project_dir unless absolute. |
2600
2656
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.files">files</a></code> | <code>string[]</code> | Compose file paths relative to project_dir unless absolute. |
2601
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.oneshot">oneshot</a></code> | <code>string[]</code> | *No description.* |
2602
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.profiles">profiles</a></code> | <code>string[]</code> | *No description.* |
2657
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.oneshot">oneshot</a></code> | <code>string[]</code> | services that run once and count as converged after exiting with code 0; |
2658
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.profiles">profiles</a></code> | <code>string[]</code> | Compose profiles to enable, passed with --profile. |
2603
2659
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.projectName">projectName</a></code> | <code>string</code> | optional Compose project name. |
2604
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.pull">pull</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposePull">MiseTomlSchemaBootstrapComposePull</a></code> | *No description.* |
2605
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.recreate">recreate</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate">MiseTomlSchemaBootstrapComposeRecreate</a></code> | *No description.* |
2606
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.removeOrphans">removeOrphans</a></code> | <code>boolean</code> | *No description.* |
2607
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.renewAnonymousVolumes">renewAnonymousVolumes</a></code> | <code>boolean</code> | *No description.* |
2608
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.services">services</a></code> | <code>string[]</code> | *No description.* |
2609
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeState">MiseTomlSchemaBootstrapComposeState</a></code> | *No description.* |
2610
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.sudo">sudo</a></code> | <code>boolean</code> | *No description.* |
2660
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.pull">pull</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposePull">MiseTomlSchemaBootstrapComposePull</a></code> | image pull policy passed to compose up as --pull. |
2661
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.recreate">recreate</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate">MiseTomlSchemaBootstrapComposeRecreate</a></code> | auto lets Compose decide, always passes --force-recreate, never passes --no-recreate. |
2662
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.removeOrphans">removeOrphans</a></code> | <code>boolean</code> | remove containers for services that are no longer in the Compose model. |
2663
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.renewAnonymousVolumes">renewAnonymousVolumes</a></code> | <code>boolean</code> | pass --renew-anon-volumes to compose up, recreating anonymous volumes. |
2664
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.services">services</a></code> | <code>string[]</code> | services to manage; |
2665
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapComposeState">MiseTomlSchemaBootstrapComposeState</a></code> | running (compose up), stopped (compose stop, keeping containers and data), or absent (compose down). |
2666
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.sudo">sudo</a></code> | <code>boolean</code> | run every Compose and engine command through sudo, for a project on the system Docker daemon. |
2611
2667
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.timeout">timeout</a></code> | <code>number</code> | Compose shutdown timeout in seconds. |
2612
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.wait">wait</a></code> | <code>boolean</code> | *No description.* |
2668
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.wait">wait</a></code> | <code>boolean</code> | pass --wait to compose up, so it waits for services to be running and healthy. |
2613
2669
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapCompose.property.waitTimeout">waitTimeout</a></code> | <code>number</code> | wait timeout in seconds. |
2614
2670
 
2615
2671
  ---
@@ -2634,6 +2690,8 @@ public readonly buildValue: MiseTomlSchemaBootstrapComposeBuild;
2634
2690
 
2635
2691
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposeBuild">MiseTomlSchemaBootstrapComposeBuild</a>
2636
2692
 
2693
+ auto lets Compose decide, always passes --build, never passes --no-build.
2694
+
2637
2695
  ---
2638
2696
 
2639
2697
  ##### `command`<sup>Optional</sup> <a name="command" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.command"></a>
@@ -2668,6 +2726,8 @@ public readonly downImages: MiseTomlSchemaBootstrapComposeDownImages;
2668
2726
 
2669
2727
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposeDownImages">MiseTomlSchemaBootstrapComposeDownImages</a>
2670
2728
 
2729
+ images compose down removes, passed as --rmi.
2730
+
2671
2731
  ---
2672
2732
 
2673
2733
  ##### `downVolumes`<sup>Optional</sup> <a name="downVolumes" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.downVolumes"></a>
@@ -2678,6 +2738,8 @@ public readonly downVolumes: boolean;
2678
2738
 
2679
2739
  - *Type:* boolean
2680
2740
 
2741
+ pass --volumes to compose down, removing the project's volumes.
2742
+
2681
2743
  ---
2682
2744
 
2683
2745
  ##### `engineCommand`<sup>Optional</sup> <a name="engineCommand" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.engineCommand"></a>
@@ -2724,6 +2786,10 @@ public readonly oneshot: string[];
2724
2786
 
2725
2787
  - *Type:* string[]
2726
2788
 
2789
+ services that run once and count as converged after exiting with code 0;
2790
+
2791
+ when services is set, they must be listed there too
2792
+
2727
2793
  ---
2728
2794
 
2729
2795
  ##### `profiles`<sup>Optional</sup> <a name="profiles" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.profiles"></a>
@@ -2734,6 +2800,8 @@ public readonly profiles: string[];
2734
2800
 
2735
2801
  - *Type:* string[]
2736
2802
 
2803
+ Compose profiles to enable, passed with --profile.
2804
+
2737
2805
  ---
2738
2806
 
2739
2807
  ##### `projectName`<sup>Optional</sup> <a name="projectName" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.projectName"></a>
@@ -2756,6 +2824,8 @@ public readonly pull: MiseTomlSchemaBootstrapComposePull;
2756
2824
 
2757
2825
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposePull">MiseTomlSchemaBootstrapComposePull</a>
2758
2826
 
2827
+ image pull policy passed to compose up as --pull.
2828
+
2759
2829
  ---
2760
2830
 
2761
2831
  ##### `recreate`<sup>Optional</sup> <a name="recreate" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.recreate"></a>
@@ -2766,6 +2836,8 @@ public readonly recreate: MiseTomlSchemaBootstrapComposeRecreate;
2766
2836
 
2767
2837
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposeRecreate">MiseTomlSchemaBootstrapComposeRecreate</a>
2768
2838
 
2839
+ auto lets Compose decide, always passes --force-recreate, never passes --no-recreate.
2840
+
2769
2841
  ---
2770
2842
 
2771
2843
  ##### `removeOrphans`<sup>Optional</sup> <a name="removeOrphans" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.removeOrphans"></a>
@@ -2776,6 +2848,8 @@ public readonly removeOrphans: boolean;
2776
2848
 
2777
2849
  - *Type:* boolean
2778
2850
 
2851
+ remove containers for services that are no longer in the Compose model.
2852
+
2779
2853
  ---
2780
2854
 
2781
2855
  ##### `renewAnonymousVolumes`<sup>Optional</sup> <a name="renewAnonymousVolumes" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.renewAnonymousVolumes"></a>
@@ -2786,6 +2860,8 @@ public readonly renewAnonymousVolumes: boolean;
2786
2860
 
2787
2861
  - *Type:* boolean
2788
2862
 
2863
+ pass --renew-anon-volumes to compose up, recreating anonymous volumes.
2864
+
2789
2865
  ---
2790
2866
 
2791
2867
  ##### `services`<sup>Optional</sup> <a name="services" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.services"></a>
@@ -2796,6 +2872,10 @@ public readonly services: string[];
2796
2872
 
2797
2873
  - *Type:* string[]
2798
2874
 
2875
+ services to manage;
2876
+
2877
+ defaults to every service the files and profiles enable
2878
+
2799
2879
  ---
2800
2880
 
2801
2881
  ##### `state`<sup>Optional</sup> <a name="state" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.state"></a>
@@ -2806,6 +2886,8 @@ public readonly state: MiseTomlSchemaBootstrapComposeState;
2806
2886
 
2807
2887
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapComposeState">MiseTomlSchemaBootstrapComposeState</a>
2808
2888
 
2889
+ running (compose up), stopped (compose stop, keeping containers and data), or absent (compose down).
2890
+
2809
2891
  ---
2810
2892
 
2811
2893
  ##### `sudo`<sup>Optional</sup> <a name="sudo" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.sudo"></a>
@@ -2816,6 +2898,8 @@ public readonly sudo: boolean;
2816
2898
 
2817
2899
  - *Type:* boolean
2818
2900
 
2901
+ run every Compose and engine command through sudo, for a project on the system Docker daemon.
2902
+
2819
2903
  ---
2820
2904
 
2821
2905
  ##### `timeout`<sup>Optional</sup> <a name="timeout" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.timeout"></a>
@@ -2838,6 +2922,8 @@ public readonly wait: boolean;
2838
2922
 
2839
2923
  - *Type:* boolean
2840
2924
 
2925
+ pass --wait to compose up, so it waits for services to be running and healthy.
2926
+
2841
2927
  ---
2842
2928
 
2843
2929
  ##### `waitTimeout`<sup>Optional</sup> <a name="waitTimeout" id="mise-projen.MiseTomlSchemaBootstrapCompose.property.waitTimeout"></a>
@@ -2854,6 +2940,8 @@ wait timeout in seconds.
2854
2940
 
2855
2941
  ### MiseTomlSchemaBootstrapDirectories <a name="MiseTomlSchemaBootstrapDirectories" id="mise-projen.MiseTomlSchemaBootstrapDirectories"></a>
2856
2942
 
2943
+ directory whose owner, group, and mode mise manages, keyed by an absolute or ~/ target path.
2944
+
2857
2945
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapDirectories.Initializer"></a>
2858
2946
 
2859
2947
  ```typescript
@@ -2866,15 +2954,15 @@ const miseTomlSchemaBootstrapDirectories: MiseTomlSchemaBootstrapDirectories = {
2866
2954
 
2867
2955
  | **Name** | **Type** | **Description** |
2868
2956
  | --- | --- | --- |
2869
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.group">group</a></code> | <code>string</code> | *No description.* |
2870
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.mode">mode</a></code> | <code>string</code> | *No description.* |
2871
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.notify">notify</a></code> | <code>string[]</code> | *No description.* |
2957
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.group">group</a></code> | <code>string</code> | group that should own the directory; |
2958
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.mode">mode</a></code> | <code>string</code> | octal permissions such as "0755"; |
2959
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.notify">notify</a></code> | <code>string[]</code> | system services declared in [bootstrap.services] to reload or restart when mise changes this directory. |
2872
2960
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.os">os</a></code> | <code>string[]</code> | OS or OS/arch selectors; |
2873
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.owner">owner</a></code> | <code>string</code> | *No description.* |
2961
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.owner">owner</a></code> | <code>string</code> | user that should own the directory; |
2874
2962
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.phase">phase</a></code> | <code><a href="#mise-projen.BootstrapFilePhase">BootstrapFilePhase</a></code> | *No description.* |
2875
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.recursive">recursive</a></code> | <code>boolean</code> | *No description.* |
2876
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.replace">replace</a></code> | <code>boolean</code> | *No description.* |
2877
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectoriesState">MiseTomlSchemaBootstrapDirectoriesState</a></code> | *No description.* |
2963
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.recursive">recursive</a></code> | <code>boolean</code> | with state = "absent", delete the directory and everything in it. |
2964
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.replace">replace</a></code> | <code>boolean</code> | replace a path of another type at the target, such as a file. |
2965
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectories.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapDirectoriesState">MiseTomlSchemaBootstrapDirectoriesState</a></code> | present creates the directory with any missing parents; |
2878
2966
 
2879
2967
  ---
2880
2968
 
@@ -2886,6 +2974,10 @@ public readonly group: string;
2886
2974
 
2887
2975
  - *Type:* string
2888
2976
 
2977
+ group that should own the directory;
2978
+
2979
+ left as it is when unset, and parents mise creates get the system defaults
2980
+
2889
2981
  ---
2890
2982
 
2891
2983
  ##### `mode`<sup>Optional</sup> <a name="mode" id="mise-projen.MiseTomlSchemaBootstrapDirectories.property.mode"></a>
@@ -2896,6 +2988,10 @@ public readonly mode: string;
2896
2988
 
2897
2989
  - *Type:* string
2898
2990
 
2991
+ octal permissions such as "0755";
2992
+
2993
+ defaults to "0755"
2994
+
2899
2995
  ---
2900
2996
 
2901
2997
  ##### `notify`<sup>Optional</sup> <a name="notify" id="mise-projen.MiseTomlSchemaBootstrapDirectories.property.notify"></a>
@@ -2906,6 +3002,8 @@ public readonly notify: string[];
2906
3002
 
2907
3003
  - *Type:* string[]
2908
3004
 
3005
+ system services declared in [bootstrap.services] to reload or restart when mise changes this directory.
3006
+
2909
3007
  ---
2910
3008
 
2911
3009
  ##### `os`<sup>Optional</sup> <a name="os" id="mise-projen.MiseTomlSchemaBootstrapDirectories.property.os"></a>
@@ -2930,6 +3028,10 @@ public readonly owner: string;
2930
3028
 
2931
3029
  - *Type:* string
2932
3030
 
3031
+ user that should own the directory;
3032
+
3033
+ left as it is when unset, and parents mise creates get the system defaults
3034
+
2933
3035
  ---
2934
3036
 
2935
3037
  ##### `phase`<sup>Optional</sup> <a name="phase" id="mise-projen.MiseTomlSchemaBootstrapDirectories.property.phase"></a>
@@ -2950,6 +3052,8 @@ public readonly recursive: boolean;
2950
3052
 
2951
3053
  - *Type:* boolean
2952
3054
 
3055
+ with state = "absent", delete the directory and everything in it.
3056
+
2953
3057
  ---
2954
3058
 
2955
3059
  ##### `replace`<sup>Optional</sup> <a name="replace" id="mise-projen.MiseTomlSchemaBootstrapDirectories.property.replace"></a>
@@ -2960,6 +3064,8 @@ public readonly replace: boolean;
2960
3064
 
2961
3065
  - *Type:* boolean
2962
3066
 
3067
+ replace a path of another type at the target, such as a file.
3068
+
2963
3069
  ---
2964
3070
 
2965
3071
  ##### `state`<sup>Optional</sup> <a name="state" id="mise-projen.MiseTomlSchemaBootstrapDirectories.property.state"></a>
@@ -2970,6 +3076,10 @@ public readonly state: MiseTomlSchemaBootstrapDirectoriesState;
2970
3076
 
2971
3077
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapDirectoriesState">MiseTomlSchemaBootstrapDirectoriesState</a>
2972
3078
 
3079
+ present creates the directory with any missing parents;
3080
+
3081
+ absent removes it, which must then be empty unless recursive is set
3082
+
2973
3083
  ---
2974
3084
 
2975
3085
  ### MiseTomlSchemaBootstrapDnf <a name="MiseTomlSchemaBootstrapDnf" id="mise-projen.MiseTomlSchemaBootstrapDnf"></a>
@@ -3004,6 +3114,8 @@ public readonly repos: {[ key: string ]: BootstrapDnfRepos};
3004
3114
 
3005
3115
  ### MiseTomlSchemaBootstrapFiles <a name="MiseTomlSchemaBootstrapFiles" id="mise-projen.MiseTomlSchemaBootstrapFiles"></a>
3006
3116
 
3117
+ file whose content, owner, group, and mode mise manages, keyed by an absolute or ~/ target path.
3118
+
3007
3119
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapFiles.Initializer"></a>
3008
3120
 
3009
3121
  ```typescript
@@ -3016,18 +3128,18 @@ const miseTomlSchemaBootstrapFiles: MiseTomlSchemaBootstrapFiles = { ... }
3016
3128
 
3017
3129
  | **Name** | **Type** | **Description** |
3018
3130
  | --- | --- | --- |
3019
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.content">content</a></code> | <code>string</code> | *No description.* |
3020
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.group">group</a></code> | <code>string</code> | *No description.* |
3021
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.mode">mode</a></code> | <code>string</code> | *No description.* |
3022
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.notify">notify</a></code> | <code>string[]</code> | *No description.* |
3131
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.content">content</a></code> | <code>string</code> | inline file content; |
3132
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.group">group</a></code> | <code>string</code> | group that should own the file; |
3133
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.mode">mode</a></code> | <code>string</code> | octal permissions such as "0640"; |
3134
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.notify">notify</a></code> | <code>string[]</code> | system services declared in [bootstrap.services] to reload or restart when mise changes this file. |
3023
3135
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.os">os</a></code> | <code>string[]</code> | OS or OS/arch selectors; |
3024
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.owner">owner</a></code> | <code>string</code> | *No description.* |
3136
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.owner">owner</a></code> | <code>string</code> | user that should own the file; |
3025
3137
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.phase">phase</a></code> | <code><a href="#mise-projen.BootstrapFilePhase">BootstrapFilePhase</a></code> | *No description.* |
3026
3138
  | <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; |
3027
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.replace">replace</a></code> | <code>boolean</code> | *No description.* |
3028
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.source">source</a></code> | <code>string</code> | *No description.* |
3029
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFilesState">MiseTomlSchemaBootstrapFilesState</a></code> | *No description.* |
3030
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.template">template</a></code> | <code>boolean</code> | *No description.* |
3139
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.replace">replace</a></code> | <code>boolean</code> | replace a path of another type at the target, such as an empty directory; |
3140
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.source">source</a></code> | <code>string</code> | file to copy the content from; |
3141
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFilesState">MiseTomlSchemaBootstrapFilesState</a></code> | present creates or updates the file; |
3142
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapFiles.property.template">template</a></code> | <code>boolean</code> | render source or content with mise's template engine; |
3031
3143
 
3032
3144
  ---
3033
3145
 
@@ -3039,6 +3151,10 @@ public readonly content: string;
3039
3151
 
3040
3152
  - *Type:* string
3041
3153
 
3154
+ inline file content;
3155
+
3156
+ cannot be combined with source
3157
+
3042
3158
  ---
3043
3159
 
3044
3160
  ##### `group`<sup>Optional</sup> <a name="group" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.group"></a>
@@ -3049,6 +3165,10 @@ public readonly group: string;
3049
3165
 
3050
3166
  - *Type:* string
3051
3167
 
3168
+ group that should own the file;
3169
+
3170
+ left as it is when unset
3171
+
3052
3172
  ---
3053
3173
 
3054
3174
  ##### `mode`<sup>Optional</sup> <a name="mode" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.mode"></a>
@@ -3059,6 +3179,10 @@ public readonly mode: string;
3059
3179
 
3060
3180
  - *Type:* string
3061
3181
 
3182
+ octal permissions such as "0640";
3183
+
3184
+ defaults to "0644" for a file with source or content, otherwise left as it is
3185
+
3062
3186
  ---
3063
3187
 
3064
3188
  ##### `notify`<sup>Optional</sup> <a name="notify" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.notify"></a>
@@ -3069,6 +3193,8 @@ public readonly notify: string[];
3069
3193
 
3070
3194
  - *Type:* string[]
3071
3195
 
3196
+ system services declared in [bootstrap.services] to reload or restart when mise changes this file.
3197
+
3072
3198
  ---
3073
3199
 
3074
3200
  ##### `os`<sup>Optional</sup> <a name="os" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.os"></a>
@@ -3093,6 +3219,10 @@ public readonly owner: string;
3093
3219
 
3094
3220
  - *Type:* string
3095
3221
 
3222
+ user that should own the file;
3223
+
3224
+ left as it is when unset
3225
+
3096
3226
  ---
3097
3227
 
3098
3228
  ##### `phase`<sup>Optional</sup> <a name="phase" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.phase"></a>
@@ -3127,6 +3257,10 @@ public readonly replace: boolean;
3127
3257
 
3128
3258
  - *Type:* boolean
3129
3259
 
3260
+ replace a path of another type at the target, such as an empty directory;
3261
+
3262
+ requires source or content
3263
+
3130
3264
  ---
3131
3265
 
3132
3266
  ##### `source`<sup>Optional</sup> <a name="source" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.source"></a>
@@ -3137,6 +3271,10 @@ public readonly source: string;
3137
3271
 
3138
3272
  - *Type:* string
3139
3273
 
3274
+ file to copy the content from;
3275
+
3276
+ a relative path resolves from the declaring config's directory and ~/ from your home directory
3277
+
3140
3278
  ---
3141
3279
 
3142
3280
  ##### `state`<sup>Optional</sup> <a name="state" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.state"></a>
@@ -3147,6 +3285,10 @@ public readonly state: MiseTomlSchemaBootstrapFilesState;
3147
3285
 
3148
3286
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapFilesState">MiseTomlSchemaBootstrapFilesState</a>
3149
3287
 
3288
+ present creates or updates the file;
3289
+
3290
+ absent removes it whatever its content
3291
+
3150
3292
  ---
3151
3293
 
3152
3294
  ##### `template`<sup>Optional</sup> <a name="template" id="mise-projen.MiseTomlSchemaBootstrapFiles.property.template"></a>
@@ -3157,10 +3299,16 @@ public readonly template: boolean;
3157
3299
 
3158
3300
  - *Type:* boolean
3159
3301
 
3302
+ render source or content with mise's template engine;
3303
+
3304
+ without it, template syntax is written unchanged
3305
+
3160
3306
  ---
3161
3307
 
3162
3308
  ### MiseTomlSchemaBootstrapGroups <a name="MiseTomlSchemaBootstrapGroups" id="mise-projen.MiseTomlSchemaBootstrapGroups"></a>
3163
3309
 
3310
+ local Linux group that bootstrap creates, updates, or removes.
3311
+
3164
3312
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapGroups.Initializer"></a>
3165
3313
 
3166
3314
  ```typescript
@@ -3389,14 +3537,14 @@ const miseTomlSchemaBootstrapLinuxFirewallRules: MiseTomlSchemaBootstrapLinuxFir
3389
3537
  | **Name** | **Type** | **Description** |
3390
3538
  | --- | --- | --- |
3391
3539
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.name">name</a></code> | <code>string</code> | stable managed rule identifier. |
3392
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.action">action</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesAction">MiseTomlSchemaBootstrapLinuxFirewallRulesAction</a></code> | *No description.* |
3540
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.action">action</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesAction">MiseTomlSchemaBootstrapLinuxFirewallRulesAction</a></code> | what to do with matching traffic; |
3393
3541
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.destination">destination</a></code> | <code>string</code> | destination IPv4 or IPv6 CIDR network. |
3394
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.direction">direction</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesDirection">MiseTomlSchemaBootstrapLinuxFirewallRulesDirection</a></code> | *No description.* |
3542
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.direction">direction</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesDirection">MiseTomlSchemaBootstrapLinuxFirewallRulesDirection</a></code> | traffic direction the rule matches. |
3395
3543
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.interface">interface</a></code> | <code>string</code> | network interface (nftables and UFW only). |
3396
3544
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.port">port</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesPort">MiseTomlSchemaBootstrapLinuxFirewallRulesPort</a></code> | single port number or inclusive range. |
3397
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.protocol">protocol</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol">MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol</a></code> | *No description.* |
3545
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.protocol">protocol</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol">MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol</a></code> | protocol to match; |
3398
3546
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.source">source</a></code> | <code>string</code> | source IPv4 or IPv6 CIDR network. |
3399
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesState">MiseTomlSchemaBootstrapLinuxFirewallRulesState</a></code> | *No description.* |
3547
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesState">MiseTomlSchemaBootstrapLinuxFirewallRulesState</a></code> | present adds the rule; |
3400
3548
 
3401
3549
  ---
3402
3550
 
@@ -3420,6 +3568,10 @@ public readonly action: MiseTomlSchemaBootstrapLinuxFirewallRulesAction;
3420
3568
 
3421
3569
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesAction">MiseTomlSchemaBootstrapLinuxFirewallRulesAction</a>
3422
3570
 
3571
+ what to do with matching traffic;
3572
+
3573
+ limit needs incoming TCP and is not available on firewalld
3574
+
3423
3575
  ---
3424
3576
 
3425
3577
  ##### `destination`<sup>Optional</sup> <a name="destination" id="mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.destination"></a>
@@ -3442,6 +3594,8 @@ public readonly direction: MiseTomlSchemaBootstrapLinuxFirewallRulesDirection;
3442
3594
 
3443
3595
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesDirection">MiseTomlSchemaBootstrapLinuxFirewallRulesDirection</a>
3444
3596
 
3597
+ traffic direction the rule matches.
3598
+
3445
3599
  ---
3446
3600
 
3447
3601
  ##### `interface`<sup>Optional</sup> <a name="interface" id="mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.interface"></a>
@@ -3476,6 +3630,10 @@ public readonly protocol: MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol;
3476
3630
 
3477
3631
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol">MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol</a>
3478
3632
 
3633
+ protocol to match;
3634
+
3635
+ any when unset, and UFW supports only tcp and udp
3636
+
3479
3637
  ---
3480
3638
 
3481
3639
  ##### `source`<sup>Optional</sup> <a name="source" id="mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRules.property.source"></a>
@@ -3498,6 +3656,10 @@ public readonly state: MiseTomlSchemaBootstrapLinuxFirewallRulesState;
3498
3656
 
3499
3657
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesState">MiseTomlSchemaBootstrapLinuxFirewallRulesState</a>
3500
3658
 
3659
+ present adds the rule;
3660
+
3661
+ absent removes a rule mise added earlier
3662
+
3501
3663
  ---
3502
3664
 
3503
3665
  ### MiseTomlSchemaBootstrapLinuxSystemd <a name="MiseTomlSchemaBootstrapLinuxSystemd" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemd"></a>
@@ -3534,6 +3696,8 @@ systemd user services and timers to write and start with `mise bootstrap linux s
3534
3696
 
3535
3697
  ### MiseTomlSchemaBootstrapLinuxSystemdUnits <a name="MiseTomlSchemaBootstrapLinuxSystemdUnits" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits"></a>
3536
3698
 
3699
+ systemd user unit written to ~/.config/systemd/user/dev.mise.<name>.service, or .timer when it sets a timer key.
3700
+
3537
3701
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapLinuxSystemdUnits.Initializer"></a>
3538
3702
 
3539
3703
  ```typescript
@@ -4189,10 +4353,10 @@ const miseTomlSchemaBootstrapMacosDefaultsEntries: MiseTomlSchemaBootstrapMacosD
4189
4353
 
4190
4354
  | **Name** | **Type** | **Description** |
4191
4355
  | --- | --- | --- |
4192
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.domain">domain</a></code> | <code>string</code> | *No description.* |
4193
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.key">key</a></code> | <code>string</code> | *No description.* |
4194
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.value">value</a></code> | <code>any</code> | *No description.* |
4195
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.host">host</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntriesHost">MiseTomlSchemaBootstrapMacosDefaultsEntriesHost</a></code> | *No description.* |
4356
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.domain">domain</a></code> | <code>string</code> | preferences domain, such as "com.apple.dock" or "NSGlobalDomain"; -g and -globalDomain mean NSGlobalDomain. |
4357
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.key">key</a></code> | <code>string</code> | preference key within the domain. |
4358
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.value">value</a></code> | <code>any</code> | desired value, written with the matching property list type; |
4359
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.host">host</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntriesHost">MiseTomlSchemaBootstrapMacosDefaultsEntriesHost</a></code> | any writes the preference for every host; |
4196
4360
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.path">path</a></code> | <code>string[]</code> | Dictionary keys below the preference key; |
4197
4361
 
4198
4362
  ---
@@ -4205,6 +4369,8 @@ public readonly domain: string;
4205
4369
 
4206
4370
  - *Type:* string
4207
4371
 
4372
+ preferences domain, such as "com.apple.dock" or "NSGlobalDomain"; -g and -globalDomain mean NSGlobalDomain.
4373
+
4208
4374
  ---
4209
4375
 
4210
4376
  ##### `key`<sup>Required</sup> <a name="key" id="mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.key"></a>
@@ -4215,6 +4381,8 @@ public readonly key: string;
4215
4381
 
4216
4382
  - *Type:* string
4217
4383
 
4384
+ preference key within the domain.
4385
+
4218
4386
  ---
4219
4387
 
4220
4388
  ##### `value`<sup>Required</sup> <a name="value" id="mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.value"></a>
@@ -4225,6 +4393,10 @@ public readonly value: any;
4225
4393
 
4226
4394
  - *Type:* any
4227
4395
 
4396
+ desired value, written with the matching property list type;
4397
+
4398
+ replaces the selected value in full
4399
+
4228
4400
  ---
4229
4401
 
4230
4402
  ##### `host`<sup>Optional</sup> <a name="host" id="mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.host"></a>
@@ -4235,6 +4407,10 @@ public readonly host: MiseTomlSchemaBootstrapMacosDefaultsEntriesHost;
4235
4407
 
4236
4408
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntriesHost">MiseTomlSchemaBootstrapMacosDefaultsEntriesHost</a>
4237
4409
 
4410
+ any writes the preference for every host;
4411
+
4412
+ current writes it for this machine only, like defaults -currentHost
4413
+
4238
4414
  ---
4239
4415
 
4240
4416
  ##### `path`<sup>Optional</sup> <a name="path" id="mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntries.property.path"></a>
@@ -4285,6 +4461,8 @@ macOS user LaunchAgents to write and load with `mise bootstrap macos launchd-age
4285
4461
 
4286
4462
  ### MiseTomlSchemaBootstrapMacosLaunchdAgents <a name="MiseTomlSchemaBootstrapMacosLaunchdAgents" id="mise-projen.MiseTomlSchemaBootstrapMacosLaunchdAgents"></a>
4287
4463
 
4464
+ macOS LaunchAgent written to ~/Library/LaunchAgents/dev.mise.<name>.plist and loaded for the current user.
4465
+
4288
4466
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapMacosLaunchdAgents.Initializer"></a>
4289
4467
 
4290
4468
  ```typescript
@@ -4669,6 +4847,8 @@ local project directory sent to inventory hosts.
4669
4847
 
4670
4848
  ### MiseTomlSchemaBootstrapRemoteHosts <a name="MiseTomlSchemaBootstrapRemoteHosts" id="mise-projen.MiseTomlSchemaBootstrapRemoteHosts"></a>
4671
4849
 
4850
+ SSH target that `mise bootstrap remote` can bootstrap, selected by name or tag.
4851
+
4672
4852
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapRemoteHosts.Initializer"></a>
4673
4853
 
4674
4854
  ```typescript
@@ -4881,6 +5061,8 @@ SSH user.
4881
5061
 
4882
5062
  ### MiseTomlSchemaBootstrapRepos <a name="MiseTomlSchemaBootstrapRepos" id="mise-projen.MiseTomlSchemaBootstrapRepos"></a>
4883
5063
 
5064
+ git repository to clone to this path, then keep on ref when one is set.
5065
+
4884
5066
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapRepos.Initializer"></a>
4885
5067
 
4886
5068
  ```typescript
@@ -4969,6 +5151,8 @@ applies to the first clone only
4969
5151
 
4970
5152
  ### MiseTomlSchemaBootstrapServices <a name="MiseTomlSchemaBootstrapServices" id="mise-projen.MiseTomlSchemaBootstrapServices"></a>
4971
5153
 
5154
+ Linux systemd system unit that mise starts, stops, enables, or masks, or a user service mise defines from command or builtin.
5155
+
4972
5156
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapServices.Initializer"></a>
4973
5157
 
4974
5158
  ```typescript
@@ -4983,16 +5167,16 @@ const miseTomlSchemaBootstrapServices: MiseTomlSchemaBootstrapServices = { ... }
4983
5167
  | --- | --- | --- |
4984
5168
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.builtin">builtin</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServicesBuiltin">MiseTomlSchemaBootstrapServicesBuiltin</a></code> | A mise-provided user service. |
4985
5169
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.command">command</a></code> | <code>string</code> | User service command; |
4986
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.description">description</a></code> | <code>string</code> | *No description.* |
4987
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.enabled">enabled</a></code> | <code>boolean</code> | *No description.* |
4988
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.environment">environment</a></code> | <code>{[ key: string ]: string}</code> | *No description.* |
5170
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.description">description</a></code> | <code>string</code> | text the service manager shows for the service; |
5171
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.enabled">enabled</a></code> | <code>boolean</code> | start the service at boot (system scope) or at login (user scope). |
5172
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.environment">environment</a></code> | <code>{[ key: string ]: string}</code> | environment variables for the process; |
4989
5173
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.masked">masked</a></code> | <code>boolean</code> | System scope only. |
4990
5174
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.onChange">onChange</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServicesOnChange">MiseTomlSchemaBootstrapServicesOnChange</a></code> | System scope only. |
4991
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.requiresTools">requiresTools</a></code> | <code>boolean</code> | *No description.* |
4992
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.restart">restart</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServicesRestart">MiseTomlSchemaBootstrapServicesRestart</a></code> | *No description.* |
5175
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.requiresTools">requiresTools</a></code> | <code>boolean</code> | start the service only after `mise bootstrap` installs [tools] and plugin packages; |
5176
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.restart">restart</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServicesRestart">MiseTomlSchemaBootstrapServicesRestart</a></code> | when to restart the process after it exits: on-failure, always, or never; |
4993
5177
  | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.scope">scope</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServicesScope">MiseTomlSchemaBootstrapServicesScope</a></code> | Defaults to system; |
4994
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServicesState">MiseTomlSchemaBootstrapServicesState</a></code> | *No description.* |
4995
- | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.workingDirectory">workingDirectory</a></code> | <code>string</code> | *No description.* |
5178
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.state">state</a></code> | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServicesState">MiseTomlSchemaBootstrapServicesState</a></code> | running or stopped; |
5179
+ | <code><a href="#mise-projen.MiseTomlSchemaBootstrapServices.property.workingDirectory">workingDirectory</a></code> | <code>string</code> | directory to run the process in, with ~ expanded; |
4996
5180
 
4997
5181
  ---
4998
5182
 
@@ -5030,6 +5214,10 @@ public readonly description: string;
5030
5214
 
5031
5215
  - *Type:* string
5032
5216
 
5217
+ text the service manager shows for the service;
5218
+
5219
+ user scope only
5220
+
5033
5221
  ---
5034
5222
 
5035
5223
  ##### `enabled`<sup>Optional</sup> <a name="enabled" id="mise-projen.MiseTomlSchemaBootstrapServices.property.enabled"></a>
@@ -5040,6 +5228,8 @@ public readonly enabled: boolean;
5040
5228
 
5041
5229
  - *Type:* boolean
5042
5230
 
5231
+ start the service at boot (system scope) or at login (user scope).
5232
+
5043
5233
  ---
5044
5234
 
5045
5235
  ##### `environment`<sup>Optional</sup> <a name="environment" id="mise-projen.MiseTomlSchemaBootstrapServices.property.environment"></a>
@@ -5050,6 +5240,10 @@ public readonly environment: {[ key: string ]: string};
5050
5240
 
5051
5241
  - *Type:* {[ key: string ]: string}
5052
5242
 
5243
+ environment variables for the process;
5244
+
5245
+ user scope only
5246
+
5053
5247
  ---
5054
5248
 
5055
5249
  ##### `masked`<sup>Optional</sup> <a name="masked" id="mise-projen.MiseTomlSchemaBootstrapServices.property.masked"></a>
@@ -5084,6 +5278,10 @@ public readonly requiresTools: boolean;
5084
5278
 
5085
5279
  - *Type:* boolean
5086
5280
 
5281
+ start the service only after `mise bootstrap` installs [tools] and plugin packages;
5282
+
5283
+ user scope only
5284
+
5087
5285
  ---
5088
5286
 
5089
5287
  ##### `restart`<sup>Optional</sup> <a name="restart" id="mise-projen.MiseTomlSchemaBootstrapServices.property.restart"></a>
@@ -5094,6 +5292,10 @@ public readonly restart: MiseTomlSchemaBootstrapServicesRestart;
5094
5292
 
5095
5293
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapServicesRestart">MiseTomlSchemaBootstrapServicesRestart</a>
5096
5294
 
5295
+ when to restart the process after it exits: on-failure, always, or never;
5296
+
5297
+ on Windows, always and on-failure both retry failed runs only; user scope only
5298
+
5097
5299
  ---
5098
5300
 
5099
5301
  ##### `scope`<sup>Optional</sup> <a name="scope" id="mise-projen.MiseTomlSchemaBootstrapServices.property.scope"></a>
@@ -5119,6 +5321,10 @@ public readonly state: MiseTomlSchemaBootstrapServicesState;
5119
5321
 
5120
5322
  - *Type:* <a href="#mise-projen.MiseTomlSchemaBootstrapServicesState">MiseTomlSchemaBootstrapServicesState</a>
5121
5323
 
5324
+ running or stopped;
5325
+
5326
+ absent removes a user service's definition (user scope only)
5327
+
5122
5328
  ---
5123
5329
 
5124
5330
  ##### `workingDirectory`<sup>Optional</sup> <a name="workingDirectory" id="mise-projen.MiseTomlSchemaBootstrapServices.property.workingDirectory"></a>
@@ -5129,6 +5335,10 @@ public readonly workingDirectory: string;
5129
5335
 
5130
5336
  - *Type:* string
5131
5337
 
5338
+ directory to run the process in, with ~ expanded;
5339
+
5340
+ user scope only
5341
+
5132
5342
  ---
5133
5343
 
5134
5344
  ### MiseTomlSchemaBootstrapUser <a name="MiseTomlSchemaBootstrapUser" id="mise-projen.MiseTomlSchemaBootstrapUser"></a>
@@ -5167,6 +5377,8 @@ a template that must render to an absolute path
5167
5377
 
5168
5378
  ### MiseTomlSchemaBootstrapUsers <a name="MiseTomlSchemaBootstrapUsers" id="mise-projen.MiseTomlSchemaBootstrapUsers"></a>
5169
5379
 
5380
+ local Linux user that bootstrap creates, updates, or removes.
5381
+
5170
5382
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaBootstrapUsers.Initializer"></a>
5171
5383
 
5172
5384
  ```typescript
@@ -5346,6 +5558,8 @@ numeric user ID.
5346
5558
 
5347
5559
  ### MiseTomlSchemaDaemonProviders <a name="MiseTomlSchemaDaemonProviders" id="mise-projen.MiseTomlSchemaDaemonProviders"></a>
5348
5560
 
5561
+ A PostgreSQL, CockroachDB or NATS server that every checkout shares, with a separate database or NATS account for each.
5562
+
5349
5563
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaDaemonProviders.Initializer"></a>
5350
5564
 
5351
5565
  ```typescript
@@ -5358,13 +5572,13 @@ const miseTomlSchemaDaemonProviders: MiseTomlSchemaDaemonProviders = { ... }
5358
5572
 
5359
5573
  | **Name** | **Type** | **Description** |
5360
5574
  | --- | --- | --- |
5361
- | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.preset">preset</a></code> | <code><a href="#mise-projen.MiseTomlSchemaDaemonProvidersPreset">MiseTomlSchemaDaemonProvidersPreset</a></code> | *No description.* |
5362
- | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.version">version</a></code> | <code>string</code> | *No description.* |
5363
- | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.dataDir">dataDir</a></code> | <code>string</code> | *No description.* |
5364
- | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.options">options</a></code> | <code>any</code> | *No description.* |
5575
+ | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.preset">preset</a></code> | <code><a href="#mise-projen.MiseTomlSchemaDaemonProvidersPreset">MiseTomlSchemaDaemonProvidersPreset</a></code> | Service preset that runs the server. |
5576
+ | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.version">version</a></code> | <code>string</code> | Version request for the preset's tool. |
5577
+ | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.dataDir">dataDir</a></code> | <code>string</code> | Persistent server data directory; |
5578
+ | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.options">options</a></code> | <code>any</code> | Preset options, such as `database`. |
5365
5579
  | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.port">port</a></code> | <code>any</code> | *No description.* |
5366
- | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.ports">ports</a></code> | <code>{[ key: string ]: number}</code> | *No description.* |
5367
- | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.tool">tool</a></code> | <code>string</code> | *No description.* |
5580
+ | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.ports">ports</a></code> | <code>{[ key: string ]: number}</code> | Overrides for the preset's additional named ports. |
5581
+ | <code><a href="#mise-projen.MiseTomlSchemaDaemonProviders.property.tool">tool</a></code> | <code>string</code> | Tool to install the server from, in place of the preset's default. |
5368
5582
 
5369
5583
  ---
5370
5584
 
@@ -5376,6 +5590,8 @@ public readonly preset: MiseTomlSchemaDaemonProvidersPreset;
5376
5590
 
5377
5591
  - *Type:* <a href="#mise-projen.MiseTomlSchemaDaemonProvidersPreset">MiseTomlSchemaDaemonProvidersPreset</a>
5378
5592
 
5593
+ Service preset that runs the server.
5594
+
5379
5595
  ---
5380
5596
 
5381
5597
  ##### `version`<sup>Required</sup> <a name="version" id="mise-projen.MiseTomlSchemaDaemonProviders.property.version"></a>
@@ -5386,6 +5602,8 @@ public readonly version: string;
5386
5602
 
5387
5603
  - *Type:* string
5388
5604
 
5605
+ Version request for the preset's tool.
5606
+
5389
5607
  ---
5390
5608
 
5391
5609
  ##### `dataDir`<sup>Optional</sup> <a name="dataDir" id="mise-projen.MiseTomlSchemaDaemonProviders.property.dataDir"></a>
@@ -5395,6 +5613,11 @@ public readonly dataDir: string;
5395
5613
  ```
5396
5614
 
5397
5615
  - *Type:* string
5616
+ - *Default:* MISE_STATE_DIR/daemon-providers/<name>/data.
5617
+
5618
+ Persistent server data directory;
5619
+
5620
+ a relative path resolves inside the provider's state directory. Defaults to $MISE_STATE_DIR/daemon-providers/<name>/data.
5398
5621
 
5399
5622
  ---
5400
5623
 
@@ -5406,6 +5629,8 @@ public readonly options: any;
5406
5629
 
5407
5630
  - *Type:* any
5408
5631
 
5632
+ Preset options, such as `database`.
5633
+
5409
5634
  ---
5410
5635
 
5411
5636
  ##### `port`<sup>Optional</sup> <a name="port" id="mise-projen.MiseTomlSchemaDaemonProviders.property.port"></a>
@@ -5426,6 +5651,8 @@ public readonly ports: {[ key: string ]: number};
5426
5651
 
5427
5652
  - *Type:* {[ key: string ]: number}
5428
5653
 
5654
+ Overrides for the preset's additional named ports.
5655
+
5429
5656
  ---
5430
5657
 
5431
5658
  ##### `tool`<sup>Optional</sup> <a name="tool" id="mise-projen.MiseTomlSchemaDaemonProviders.property.tool"></a>
@@ -5436,6 +5663,8 @@ public readonly tool: string;
5436
5663
 
5437
5664
  - *Type:* string
5438
5665
 
5666
+ Tool to install the server from, in place of the preset's default.
5667
+
5439
5668
  ---
5440
5669
 
5441
5670
  ### MiseTomlSchemaDaemonsSettings <a name="MiseTomlSchemaDaemonsSettings" id="mise-projen.MiseTomlSchemaDaemonsSettings"></a>
@@ -5485,7 +5714,7 @@ Append a worktree-specific suffix to an explicit namespace when the project root
5485
5714
 
5486
5715
  ### MiseTomlSchemaDeps <a name="MiseTomlSchemaDeps" id="mise-projen.MiseTomlSchemaDeps"></a>
5487
5716
 
5488
- configure deps providers.
5717
+ [experimental] configure deps providers.
5489
5718
 
5490
5719
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaDeps.Initializer"></a>
5491
5720
 
@@ -5682,6 +5911,8 @@ public readonly yarn: DepsProvider;
5682
5911
 
5683
5912
  ### MiseTomlSchemaDotfileGroups <a name="MiseTomlSchemaDotfileGroups" id="mise-projen.MiseTomlSchemaDotfileGroups"></a>
5684
5913
 
5914
+ a directory tree of dotfiles deployed into a target directory.
5915
+
5685
5916
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaDotfileGroups.Initializer"></a>
5686
5917
 
5687
5918
  ```typescript
@@ -5823,12 +6054,12 @@ const miseTomlSchemaHistory: MiseTomlSchemaHistory = { ... }
5823
6054
 
5824
6055
  | **Name** | **Type** | **Description** |
5825
6056
  | --- | --- | --- |
5826
- | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.encryption">encryption</a></code> | <code><a href="#mise-projen.MiseTomlSchemaHistoryEncryption">MiseTomlSchemaHistoryEncryption</a></code> | *No description.* |
6057
+ | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.encryption">encryption</a></code> | <code><a href="#mise-projen.MiseTomlSchemaHistoryEncryption">MiseTomlSchemaHistoryEncryption</a></code> | encryption for dotfiles tracked with encrypt = true. |
5827
6058
  | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.exclude">exclude</a></code> | <code>string[]</code> | globs never captured by dotfiles history; |
5828
6059
  | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.gitEmail">gitEmail</a></code> | <code>string</code> | email used for history commit authors and committers; |
5829
6060
  | <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. |
5830
6061
  | <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; |
5831
- | <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). |
6062
+ | <code><a href="#mise-projen.MiseTomlSchemaHistory.property.reload">reload</a></code> | <code>{[ key: string ]: string}</code> | commands run once after a rollback, undo, pull, or dotfiles apply writes a path matching the glob (trusted global or system config only). |
5832
6063
 
5833
6064
  ---
5834
6065
 
@@ -5840,6 +6071,8 @@ public readonly encryption: MiseTomlSchemaHistoryEncryption;
5840
6071
 
5841
6072
  - *Type:* <a href="#mise-projen.MiseTomlSchemaHistoryEncryption">MiseTomlSchemaHistoryEncryption</a>
5842
6073
 
6074
+ encryption for dotfiles tracked with encrypt = true.
6075
+
5843
6076
  ---
5844
6077
 
5845
6078
  ##### `exclude`<sup>Optional</sup> <a name="exclude" id="mise-projen.MiseTomlSchemaHistory.property.exclude"></a>
@@ -5904,12 +6137,14 @@ public readonly reload: {[ key: string ]: string};
5904
6137
 
5905
6138
  - *Type:* {[ key: string ]: string}
5906
6139
 
5907
- commands run once after a rollback or undo writes a path matching the glob (trusted global or system config only).
6140
+ commands run once after a rollback, undo, pull, or dotfiles apply writes a path matching the glob (trusted global or system config only).
5908
6141
 
5909
6142
  ---
5910
6143
 
5911
6144
  ### MiseTomlSchemaHistoryEncryption <a name="MiseTomlSchemaHistoryEncryption" id="mise-projen.MiseTomlSchemaHistoryEncryption"></a>
5912
6145
 
6146
+ encryption for dotfiles tracked with encrypt = true.
6147
+
5913
6148
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaHistoryEncryption.Initializer"></a>
5914
6149
 
5915
6150
  ```typescript
@@ -5987,7 +6222,7 @@ the setup branch.
5987
6222
 
5988
6223
  ### MiseTomlSchemaOci <a name="MiseTomlSchemaOci" id="mise-projen.MiseTomlSchemaOci"></a>
5989
6224
 
5990
- configuration for `mise oci build`.
6225
+ [experimental] configuration for `mise oci build`.
5991
6226
 
5992
6227
  #### Initializer <a name="Initializer" id="mise-projen.MiseTomlSchemaOci.Initializer"></a>
5993
6228
 
@@ -6366,6 +6601,8 @@ Task defaults applied by task name across inferred and explicit workspace projec
6366
6601
 
6367
6602
  ### MonorepoProjects <a name="MonorepoProjects" id="mise-projen.MonorepoProjects"></a>
6368
6603
 
6604
+ Changes to the workspace project with this ID, or a new project when the ID is new.
6605
+
6369
6606
  #### Initializer <a name="Initializer" id="mise-projen.MonorepoProjects.Initializer"></a>
6370
6607
 
6371
6608
  ```typescript
@@ -9035,6 +9272,7 @@ const settingsDotfiles: SettingsDotfiles = { ... }
9035
9272
  | <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`. |
9036
9273
  | <code><a href="#mise-projen.SettingsDotfiles.property.relativeSymlinks">relativeSymlinks</a></code> | <code>boolean</code> | Create dotfile symlinks with relative targets instead of absolute ones. |
9037
9274
  | <code><a href="#mise-projen.SettingsDotfiles.property.root">root</a></code> | <code>string</code> | Directory that holds dotfile sources for entries without a `source`. |
9275
+ | <code><a href="#mise-projen.SettingsDotfiles.property.windowsSymlinks">windowsSymlinks</a></code> | <code>boolean</code> | On Windows, deploy dotfile files as symbolic links instead of copies. |
9038
9276
 
9039
9277
  ---
9040
9278
 
@@ -9074,6 +9312,18 @@ Directory that holds dotfile sources for entries without a `source`.
9074
9312
 
9075
9313
  ---
9076
9314
 
9315
+ ##### `windowsSymlinks`<sup>Optional</sup> <a name="windowsSymlinks" id="mise-projen.SettingsDotfiles.property.windowsSymlinks"></a>
9316
+
9317
+ ```typescript
9318
+ public readonly windowsSymlinks: boolean;
9319
+ ```
9320
+
9321
+ - *Type:* boolean
9322
+
9323
+ On Windows, deploy dotfile files as symbolic links instead of copies.
9324
+
9325
+ ---
9326
+
9077
9327
  ### SettingsDotnet <a name="SettingsDotnet" id="mise-projen.SettingsDotnet"></a>
9078
9328
 
9079
9329
  #### Initializer <a name="Initializer" id="mise-projen.SettingsDotnet.Initializer"></a>
@@ -13046,6 +13296,8 @@ gallery.
13046
13296
 
13047
13297
  ### MiseTomlSchemaBootstrapComposeBuild <a name="MiseTomlSchemaBootstrapComposeBuild" id="mise-projen.MiseTomlSchemaBootstrapComposeBuild"></a>
13048
13298
 
13299
+ auto lets Compose decide, always passes --build, never passes --no-build.
13300
+
13049
13301
  #### Members <a name="Members" id="Members"></a>
13050
13302
 
13051
13303
  | **Name** | **Description** |
@@ -13079,6 +13331,8 @@ never.
13079
13331
 
13080
13332
  ### MiseTomlSchemaBootstrapComposeDownImages <a name="MiseTomlSchemaBootstrapComposeDownImages" id="mise-projen.MiseTomlSchemaBootstrapComposeDownImages"></a>
13081
13333
 
13334
+ images compose down removes, passed as --rmi.
13335
+
13082
13336
  #### Members <a name="Members" id="Members"></a>
13083
13337
 
13084
13338
  | **Name** | **Description** |
@@ -13104,6 +13358,8 @@ all.
13104
13358
 
13105
13359
  ### MiseTomlSchemaBootstrapComposePull <a name="MiseTomlSchemaBootstrapComposePull" id="mise-projen.MiseTomlSchemaBootstrapComposePull"></a>
13106
13360
 
13361
+ image pull policy passed to compose up as --pull.
13362
+
13107
13363
  #### Members <a name="Members" id="Members"></a>
13108
13364
 
13109
13365
  | **Name** | **Description** |
@@ -13137,6 +13393,8 @@ never.
13137
13393
 
13138
13394
  ### MiseTomlSchemaBootstrapComposeRecreate <a name="MiseTomlSchemaBootstrapComposeRecreate" id="mise-projen.MiseTomlSchemaBootstrapComposeRecreate"></a>
13139
13395
 
13396
+ auto lets Compose decide, always passes --force-recreate, never passes --no-recreate.
13397
+
13140
13398
  #### Members <a name="Members" id="Members"></a>
13141
13399
 
13142
13400
  | **Name** | **Description** |
@@ -13170,6 +13428,8 @@ never.
13170
13428
 
13171
13429
  ### MiseTomlSchemaBootstrapComposeState <a name="MiseTomlSchemaBootstrapComposeState" id="mise-projen.MiseTomlSchemaBootstrapComposeState"></a>
13172
13430
 
13431
+ running (compose up), stopped (compose stop, keeping containers and data), or absent (compose down).
13432
+
13173
13433
  #### Members <a name="Members" id="Members"></a>
13174
13434
 
13175
13435
  | **Name** | **Description** |
@@ -13203,6 +13463,10 @@ absent.
13203
13463
 
13204
13464
  ### MiseTomlSchemaBootstrapDirectoriesState <a name="MiseTomlSchemaBootstrapDirectoriesState" id="mise-projen.MiseTomlSchemaBootstrapDirectoriesState"></a>
13205
13465
 
13466
+ present creates the directory with any missing parents;
13467
+
13468
+ absent removes it, which must then be empty unless recursive is set
13469
+
13206
13470
  #### Members <a name="Members" id="Members"></a>
13207
13471
 
13208
13472
  | **Name** | **Description** |
@@ -13228,6 +13492,10 @@ absent.
13228
13492
 
13229
13493
  ### MiseTomlSchemaBootstrapFilesState <a name="MiseTomlSchemaBootstrapFilesState" id="mise-projen.MiseTomlSchemaBootstrapFilesState"></a>
13230
13494
 
13495
+ present creates or updates the file;
13496
+
13497
+ absent removes it whatever its content
13498
+
13231
13499
  #### Members <a name="Members" id="Members"></a>
13232
13500
 
13233
13501
  | **Name** | **Description** |
@@ -13395,6 +13663,10 @@ reject.
13395
13663
 
13396
13664
  ### MiseTomlSchemaBootstrapLinuxFirewallRulesAction <a name="MiseTomlSchemaBootstrapLinuxFirewallRulesAction" id="mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesAction"></a>
13397
13665
 
13666
+ what to do with matching traffic;
13667
+
13668
+ limit needs incoming TCP and is not available on firewalld
13669
+
13398
13670
  #### Members <a name="Members" id="Members"></a>
13399
13671
 
13400
13672
  | **Name** | **Description** |
@@ -13436,6 +13708,8 @@ reject.
13436
13708
 
13437
13709
  ### MiseTomlSchemaBootstrapLinuxFirewallRulesDirection <a name="MiseTomlSchemaBootstrapLinuxFirewallRulesDirection" id="mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesDirection"></a>
13438
13710
 
13711
+ traffic direction the rule matches.
13712
+
13439
13713
  #### Members <a name="Members" id="Members"></a>
13440
13714
 
13441
13715
  | **Name** | **Description** |
@@ -13461,6 +13735,10 @@ outgoing.
13461
13735
 
13462
13736
  ### MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol <a name="MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol" id="mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol"></a>
13463
13737
 
13738
+ protocol to match;
13739
+
13740
+ any when unset, and UFW supports only tcp and udp
13741
+
13464
13742
  #### Members <a name="Members" id="Members"></a>
13465
13743
 
13466
13744
  | **Name** | **Description** |
@@ -13502,6 +13780,10 @@ dccp.
13502
13780
 
13503
13781
  ### MiseTomlSchemaBootstrapLinuxFirewallRulesState <a name="MiseTomlSchemaBootstrapLinuxFirewallRulesState" id="mise-projen.MiseTomlSchemaBootstrapLinuxFirewallRulesState"></a>
13504
13782
 
13783
+ present adds the rule;
13784
+
13785
+ absent removes a rule mise added earlier
13786
+
13505
13787
  #### Members <a name="Members" id="Members"></a>
13506
13788
 
13507
13789
  | **Name** | **Description** |
@@ -13666,6 +13948,10 @@ idle.
13666
13948
 
13667
13949
  ### MiseTomlSchemaBootstrapMacosDefaultsEntriesHost <a name="MiseTomlSchemaBootstrapMacosDefaultsEntriesHost" id="mise-projen.MiseTomlSchemaBootstrapMacosDefaultsEntriesHost"></a>
13668
13950
 
13951
+ any writes the preference for every host;
13952
+
13953
+ current writes it for this machine only, like defaults -currentHost
13954
+
13669
13955
  #### Members <a name="Members" id="Members"></a>
13670
13956
 
13671
13957
  | **Name** | **Description** |
@@ -13804,6 +14090,10 @@ none.
13804
14090
 
13805
14091
  ### MiseTomlSchemaBootstrapServicesRestart <a name="MiseTomlSchemaBootstrapServicesRestart" id="mise-projen.MiseTomlSchemaBootstrapServicesRestart"></a>
13806
14092
 
14093
+ when to restart the process after it exits: on-failure, always, or never;
14094
+
14095
+ on Windows, always and on-failure both retry failed runs only; user scope only
14096
+
13807
14097
  #### Members <a name="Members" id="Members"></a>
13808
14098
 
13809
14099
  | **Name** | **Description** |
@@ -13866,6 +14156,10 @@ user.
13866
14156
 
13867
14157
  ### MiseTomlSchemaBootstrapServicesState <a name="MiseTomlSchemaBootstrapServicesState" id="mise-projen.MiseTomlSchemaBootstrapServicesState"></a>
13868
14158
 
14159
+ running or stopped;
14160
+
14161
+ absent removes a user service's definition (user scope only)
14162
+
13869
14163
  #### Members <a name="Members" id="Members"></a>
13870
14164
 
13871
14165
  | **Name** | **Description** |
@@ -13926,6 +14220,8 @@ absent.
13926
14220
 
13927
14221
  ### MiseTomlSchemaDaemonProvidersPreset <a name="MiseTomlSchemaDaemonProvidersPreset" id="mise-projen.MiseTomlSchemaDaemonProvidersPreset"></a>
13928
14222
 
14223
+ Service preset that runs the server.
14224
+
13929
14225
  #### Members <a name="Members" id="Members"></a>
13930
14226
 
13931
14227
  | **Name** | **Description** |