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.
@@ -111,13 +111,13 @@ export interface MiseTomlSchema {
111
111
  [key: string]: string;
112
112
  };
113
113
  /**
114
- * configure deps providers
114
+ * [experimental] configure deps providers
115
115
  *
116
116
  * @schema MiseTomlSchema#deps
117
117
  */
118
118
  readonly deps?: MiseTomlSchemaDeps;
119
119
  /**
120
- * configuration for `mise oci build`
120
+ * [experimental] configuration for `mise oci build`
121
121
  *
122
122
  * @schema MiseTomlSchema#oci
123
123
  */
@@ -329,7 +329,7 @@ export interface MiseTomlSchemaSecrets {
329
329
  */
330
330
  export declare function toJson_MiseTomlSchemaSecrets(obj: MiseTomlSchemaSecrets | undefined): Record<string, any> | undefined;
331
331
  /**
332
- * configure deps providers
332
+ * [experimental] configure deps providers
333
333
  *
334
334
  * @schema MiseTomlSchemaDeps
335
335
  */
@@ -407,7 +407,7 @@ export interface MiseTomlSchemaDeps {
407
407
  */
408
408
  export declare function toJson_MiseTomlSchemaDeps(obj: MiseTomlSchemaDeps | undefined): Record<string, any> | undefined;
409
409
  /**
410
- * configuration for `mise oci build`
410
+ * [experimental] configuration for `mise oci build`
411
411
  *
412
412
  * @schema MiseTomlSchemaOci
413
413
  */
@@ -1484,6 +1484,8 @@ export interface Settings {
1484
1484
  */
1485
1485
  export declare function toJson_Settings(obj: Settings | undefined): Record<string, any> | undefined;
1486
1486
  /**
1487
+ * a directory tree of dotfiles deployed into a target directory
1488
+ *
1487
1489
  * @schema MiseTomlSchemaDotfileGroups
1488
1490
  */
1489
1491
  export interface MiseTomlSchemaDotfileGroups {
@@ -1704,6 +1706,8 @@ export declare function toJson_MiseTomlSchemaBootstrap(obj: MiseTomlSchemaBootst
1704
1706
  */
1705
1707
  export interface MiseTomlSchemaHistory {
1706
1708
  /**
1709
+ * encryption for dotfiles tracked with encrypt = true
1710
+ *
1707
1711
  * @schema MiseTomlSchemaHistory#encryption
1708
1712
  */
1709
1713
  readonly encryption?: MiseTomlSchemaHistoryEncryption;
@@ -1726,7 +1730,7 @@ export interface MiseTomlSchemaHistory {
1726
1730
  */
1727
1731
  readonly machine?: string;
1728
1732
  /**
1729
- * commands run once after a rollback or undo writes a path matching the glob (trusted global or system config only)
1733
+ * commands run once after a rollback, undo, pull, or dotfiles apply writes a path matching the glob (trusted global or system config only)
1730
1734
  *
1731
1735
  * @schema MiseTomlSchemaHistory#reload
1732
1736
  */
@@ -1850,22 +1854,32 @@ export declare function toJson_ToolConfig(obj: ToolConfig | undefined): Record<s
1850
1854
  */
1851
1855
  export interface Hooks {
1852
1856
  /**
1857
+ * hooks to run when an activated shell moves into the project
1858
+ *
1853
1859
  * @schema hooks#enter
1854
1860
  */
1855
1861
  readonly enter?: any[];
1856
1862
  /**
1863
+ * hooks to run when an activated shell moves out of the project
1864
+ *
1857
1865
  * @schema hooks#leave
1858
1866
  */
1859
1867
  readonly leave?: any[];
1860
1868
  /**
1869
+ * hooks to run when an activated shell changes to a directory inside the project
1870
+ *
1861
1871
  * @schema hooks#cd
1862
1872
  */
1863
1873
  readonly cd?: any[];
1864
1874
  /**
1875
+ * hooks to run before mise installs tools
1876
+ *
1865
1877
  * @schema hooks#preinstall
1866
1878
  */
1867
1879
  readonly preinstall?: any[];
1868
1880
  /**
1881
+ * hooks to run after mise installs tools
1882
+ *
1869
1883
  * @schema hooks#postinstall
1870
1884
  */
1871
1885
  readonly postinstall?: any[];
@@ -1894,6 +1908,8 @@ export declare function toJson_Vars(obj: Vars | undefined): Record<string, any>
1894
1908
  */
1895
1909
  export interface Doctor {
1896
1910
  /**
1911
+ * Checks run by mise doctor project, keyed by check name.
1912
+ *
1897
1913
  * @schema doctor#checks
1898
1914
  */
1899
1915
  readonly checks?: {
@@ -1906,14 +1922,20 @@ export interface Doctor {
1906
1922
  */
1907
1923
  export declare function toJson_Doctor(obj: Doctor | undefined): Record<string, any> | undefined;
1908
1924
  /**
1925
+ * A PostgreSQL, CockroachDB or NATS server that every checkout shares, with a separate database or NATS account for each.
1926
+ *
1909
1927
  * @schema MiseTomlSchemaDaemonProviders
1910
1928
  */
1911
1929
  export interface MiseTomlSchemaDaemonProviders {
1912
1930
  /**
1931
+ * Service preset that runs the server.
1932
+ *
1913
1933
  * @schema MiseTomlSchemaDaemonProviders#preset
1914
1934
  */
1915
1935
  readonly preset: MiseTomlSchemaDaemonProvidersPreset;
1916
1936
  /**
1937
+ * Version request for the preset's tool.
1938
+ *
1917
1939
  * @schema MiseTomlSchemaDaemonProviders#version
1918
1940
  */
1919
1941
  readonly version: string;
@@ -1922,20 +1944,29 @@ export interface MiseTomlSchemaDaemonProviders {
1922
1944
  */
1923
1945
  readonly port?: any;
1924
1946
  /**
1947
+ * Overrides for the preset's additional named ports.
1948
+ *
1925
1949
  * @schema MiseTomlSchemaDaemonProviders#ports
1926
1950
  */
1927
1951
  readonly ports?: {
1928
1952
  [key: string]: number;
1929
1953
  };
1930
1954
  /**
1955
+ * Preset options, such as `database`.
1956
+ *
1931
1957
  * @schema MiseTomlSchemaDaemonProviders#options
1932
1958
  */
1933
1959
  readonly options?: any;
1934
1960
  /**
1961
+ * Persistent server data directory; a relative path resolves inside the provider's state directory. Defaults to $MISE_STATE_DIR/daemon-providers/<name>/data.
1962
+ *
1963
+ * @default MISE_STATE_DIR/daemon-providers/<name>/data.
1935
1964
  * @schema MiseTomlSchemaDaemonProviders#data_dir
1936
1965
  */
1937
1966
  readonly dataDir?: string;
1938
1967
  /**
1968
+ * Tool to install the server from, in place of the preset's default.
1969
+ *
1939
1970
  * @schema MiseTomlSchemaDaemonProviders#tool
1940
1971
  */
1941
1972
  readonly tool?: string;
@@ -1970,6 +2001,8 @@ export interface MiseTomlSchemaDaemonsSettings {
1970
2001
  */
1971
2002
  export declare function toJson_MiseTomlSchemaDaemonsSettings(obj: MiseTomlSchemaDaemonsSettings | undefined): Record<string, any> | undefined;
1972
2003
  /**
2004
+ * Changes to the workspace project with this ID, or a new project when the ID is new
2005
+ *
1973
2006
  * @schema MonorepoProjects
1974
2007
  */
1975
2008
  export interface MonorepoProjects {
@@ -2047,6 +2080,12 @@ export interface DepsProvider {
2047
2080
  * @schema deps_provider#auto
2048
2081
  */
2049
2082
  readonly auto?: boolean;
2083
+ /**
2084
+ * Command to run when stale
2085
+ *
2086
+ * @schema deps_provider#run
2087
+ */
2088
+ readonly run?: string;
2050
2089
  /**
2051
2090
  * Files/patterns to check for changes
2052
2091
  *
@@ -2059,12 +2098,6 @@ export interface DepsProvider {
2059
2098
  * @schema deps_provider#outputs
2060
2099
  */
2061
2100
  readonly outputs?: string[];
2062
- /**
2063
- * Command to run when stale
2064
- *
2065
- * @schema deps_provider#run
2066
- */
2067
- readonly run?: string;
2068
2101
  /**
2069
2102
  * Environment variables to set
2070
2103
  *
@@ -2314,6 +2347,12 @@ export interface SettingsDotfiles {
2314
2347
  * @schema SettingsDotfiles#root
2315
2348
  */
2316
2349
  readonly root?: string;
2350
+ /**
2351
+ * On Windows, deploy dotfile files as symbolic links instead of copies.
2352
+ *
2353
+ * @schema SettingsDotfiles#windows_symlinks
2354
+ */
2355
+ readonly windowsSymlinks?: boolean;
2317
2356
  }
2318
2357
  /**
2319
2358
  * Converts an object of type 'SettingsDotfiles' to JSON representation.
@@ -3868,6 +3907,8 @@ export declare enum MiseTomlSchemaDotfileGroupsManifest {
3868
3907
  GIT = "git"
3869
3908
  }
3870
3909
  /**
3910
+ * file whose content, owner, group, and mode mise manages, keyed by an absolute or ~/ target path
3911
+ *
3871
3912
  * @schema MiseTomlSchemaBootstrapFiles
3872
3913
  */
3873
3914
  export interface MiseTomlSchemaBootstrapFiles {
@@ -3876,26 +3917,38 @@ export interface MiseTomlSchemaBootstrapFiles {
3876
3917
  */
3877
3918
  readonly phase?: BootstrapFilePhase;
3878
3919
  /**
3920
+ * file to copy the content from; a relative path resolves from the declaring config's directory and ~/ from your home directory
3921
+ *
3879
3922
  * @schema MiseTomlSchemaBootstrapFiles#source
3880
3923
  */
3881
3924
  readonly source?: string;
3882
3925
  /**
3926
+ * inline file content; cannot be combined with source
3927
+ *
3883
3928
  * @schema MiseTomlSchemaBootstrapFiles#content
3884
3929
  */
3885
3930
  readonly content?: string;
3886
3931
  /**
3932
+ * user that should own the file; left as it is when unset
3933
+ *
3887
3934
  * @schema MiseTomlSchemaBootstrapFiles#owner
3888
3935
  */
3889
3936
  readonly owner?: string;
3890
3937
  /**
3938
+ * group that should own the file; left as it is when unset
3939
+ *
3891
3940
  * @schema MiseTomlSchemaBootstrapFiles#group
3892
3941
  */
3893
3942
  readonly group?: string;
3894
3943
  /**
3944
+ * octal permissions such as "0640"; defaults to "0644" for a file with source or content, otherwise left as it is
3945
+ *
3895
3946
  * @schema MiseTomlSchemaBootstrapFiles#mode
3896
3947
  */
3897
3948
  readonly mode?: string;
3898
3949
  /**
3950
+ * render source or content with mise's template engine; without it, template syntax is written unchanged
3951
+ *
3899
3952
  * @schema MiseTomlSchemaBootstrapFiles#template
3900
3953
  */
3901
3954
  readonly template?: boolean;
@@ -3906,14 +3959,20 @@ export interface MiseTomlSchemaBootstrapFiles {
3906
3959
  */
3907
3960
  readonly removeEmpty?: boolean;
3908
3961
  /**
3962
+ * present creates or updates the file; absent removes it whatever its content
3963
+ *
3909
3964
  * @schema MiseTomlSchemaBootstrapFiles#state
3910
3965
  */
3911
3966
  readonly state?: MiseTomlSchemaBootstrapFilesState;
3912
3967
  /**
3968
+ * replace a path of another type at the target, such as an empty directory; requires source or content
3969
+ *
3913
3970
  * @schema MiseTomlSchemaBootstrapFiles#replace
3914
3971
  */
3915
3972
  readonly replace?: boolean;
3916
3973
  /**
3974
+ * system services declared in [bootstrap.services] to reload or restart when mise changes this file
3975
+ *
3917
3976
  * @schema MiseTomlSchemaBootstrapFiles#notify
3918
3977
  */
3919
3978
  readonly notify?: string[];
@@ -3930,6 +3989,8 @@ export interface MiseTomlSchemaBootstrapFiles {
3930
3989
  */
3931
3990
  export declare function toJson_MiseTomlSchemaBootstrapFiles(obj: MiseTomlSchemaBootstrapFiles | undefined): Record<string, any> | undefined;
3932
3991
  /**
3992
+ * directory whose owner, group, and mode mise manages, keyed by an absolute or ~/ target path
3993
+ *
3933
3994
  * @schema MiseTomlSchemaBootstrapDirectories
3934
3995
  */
3935
3996
  export interface MiseTomlSchemaBootstrapDirectories {
@@ -3938,30 +3999,44 @@ export interface MiseTomlSchemaBootstrapDirectories {
3938
3999
  */
3939
4000
  readonly phase?: BootstrapFilePhase;
3940
4001
  /**
4002
+ * user that should own the directory; left as it is when unset, and parents mise creates get the system defaults
4003
+ *
3941
4004
  * @schema MiseTomlSchemaBootstrapDirectories#owner
3942
4005
  */
3943
4006
  readonly owner?: string;
3944
4007
  /**
4008
+ * group that should own the directory; left as it is when unset, and parents mise creates get the system defaults
4009
+ *
3945
4010
  * @schema MiseTomlSchemaBootstrapDirectories#group
3946
4011
  */
3947
4012
  readonly group?: string;
3948
4013
  /**
4014
+ * octal permissions such as "0755"; defaults to "0755"
4015
+ *
3949
4016
  * @schema MiseTomlSchemaBootstrapDirectories#mode
3950
4017
  */
3951
4018
  readonly mode?: string;
3952
4019
  /**
4020
+ * present creates the directory with any missing parents; absent removes it, which must then be empty unless recursive is set
4021
+ *
3953
4022
  * @schema MiseTomlSchemaBootstrapDirectories#state
3954
4023
  */
3955
4024
  readonly state?: MiseTomlSchemaBootstrapDirectoriesState;
3956
4025
  /**
4026
+ * with state = "absent", delete the directory and everything in it
4027
+ *
3957
4028
  * @schema MiseTomlSchemaBootstrapDirectories#recursive
3958
4029
  */
3959
4030
  readonly recursive?: boolean;
3960
4031
  /**
4032
+ * replace a path of another type at the target, such as a file
4033
+ *
3961
4034
  * @schema MiseTomlSchemaBootstrapDirectories#replace
3962
4035
  */
3963
4036
  readonly replace?: boolean;
3964
4037
  /**
4038
+ * system services declared in [bootstrap.services] to reload or restart when mise changes this directory
4039
+ *
3965
4040
  * @schema MiseTomlSchemaBootstrapDirectories#notify
3966
4041
  */
3967
4042
  readonly notify?: string[];
@@ -4034,14 +4109,20 @@ export interface MiseTomlSchemaBootstrapRemote {
4034
4109
  */
4035
4110
  export declare function toJson_MiseTomlSchemaBootstrapRemote(obj: MiseTomlSchemaBootstrapRemote | undefined): Record<string, any> | undefined;
4036
4111
  /**
4112
+ * Linux systemd system unit that mise starts, stops, enables, or masks, or a user service mise defines from command or builtin
4113
+ *
4037
4114
  * @schema MiseTomlSchemaBootstrapServices
4038
4115
  */
4039
4116
  export interface MiseTomlSchemaBootstrapServices {
4040
4117
  /**
4118
+ * running or stopped; absent removes a user service's definition (user scope only)
4119
+ *
4041
4120
  * @schema MiseTomlSchemaBootstrapServices#state
4042
4121
  */
4043
4122
  readonly state?: MiseTomlSchemaBootstrapServicesState;
4044
4123
  /**
4124
+ * start the service at boot (system scope) or at login (user scope)
4125
+ *
4045
4126
  * @schema MiseTomlSchemaBootstrapServices#enabled
4046
4127
  */
4047
4128
  readonly enabled?: boolean;
@@ -4077,24 +4158,34 @@ export interface MiseTomlSchemaBootstrapServices {
4077
4158
  */
4078
4159
  readonly command?: string;
4079
4160
  /**
4161
+ * text the service manager shows for the service; user scope only
4162
+ *
4080
4163
  * @schema MiseTomlSchemaBootstrapServices#description
4081
4164
  */
4082
4165
  readonly description?: string;
4083
4166
  /**
4167
+ * when to restart the process after it exits: on-failure, always, or never; on Windows, always and on-failure both retry failed runs only; user scope only
4168
+ *
4084
4169
  * @schema MiseTomlSchemaBootstrapServices#restart
4085
4170
  */
4086
4171
  readonly restart?: MiseTomlSchemaBootstrapServicesRestart;
4087
4172
  /**
4173
+ * environment variables for the process; user scope only
4174
+ *
4088
4175
  * @schema MiseTomlSchemaBootstrapServices#environment
4089
4176
  */
4090
4177
  readonly environment?: {
4091
4178
  [key: string]: string;
4092
4179
  };
4093
4180
  /**
4181
+ * directory to run the process in, with ~ expanded; user scope only
4182
+ *
4094
4183
  * @schema MiseTomlSchemaBootstrapServices#working_directory
4095
4184
  */
4096
4185
  readonly workingDirectory?: string;
4097
4186
  /**
4187
+ * start the service only after `mise bootstrap` installs [tools] and plugin packages; user scope only
4188
+ *
4098
4189
  * @schema MiseTomlSchemaBootstrapServices#requires_tools
4099
4190
  */
4100
4191
  readonly requiresTools?: boolean;
@@ -4105,6 +4196,8 @@ export interface MiseTomlSchemaBootstrapServices {
4105
4196
  */
4106
4197
  export declare function toJson_MiseTomlSchemaBootstrapServices(obj: MiseTomlSchemaBootstrapServices | undefined): Record<string, any> | undefined;
4107
4198
  /**
4199
+ * Docker Compose project that mise brings up, stops, or removes
4200
+ *
4108
4201
  * @schema MiseTomlSchemaBootstrapCompose
4109
4202
  */
4110
4203
  export interface MiseTomlSchemaBootstrapCompose {
@@ -4133,34 +4226,50 @@ export interface MiseTomlSchemaBootstrapCompose {
4133
4226
  */
4134
4227
  readonly projectName?: string;
4135
4228
  /**
4229
+ * Compose profiles to enable, passed with --profile
4230
+ *
4136
4231
  * @schema MiseTomlSchemaBootstrapCompose#profiles
4137
4232
  */
4138
4233
  readonly profiles?: string[];
4139
4234
  /**
4235
+ * services to manage; defaults to every service the files and profiles enable
4236
+ *
4140
4237
  * @schema MiseTomlSchemaBootstrapCompose#services
4141
4238
  */
4142
4239
  readonly services?: string[];
4143
4240
  /**
4241
+ * services that run once and count as converged after exiting with code 0; when services is set, they must be listed there too
4242
+ *
4144
4243
  * @schema MiseTomlSchemaBootstrapCompose#oneshot
4145
4244
  */
4146
4245
  readonly oneshot?: string[];
4147
4246
  /**
4247
+ * running (compose up), stopped (compose stop, keeping containers and data), or absent (compose down)
4248
+ *
4148
4249
  * @schema MiseTomlSchemaBootstrapCompose#state
4149
4250
  */
4150
4251
  readonly state?: MiseTomlSchemaBootstrapComposeState;
4151
4252
  /**
4253
+ * image pull policy passed to compose up as --pull
4254
+ *
4152
4255
  * @schema MiseTomlSchemaBootstrapCompose#pull
4153
4256
  */
4154
4257
  readonly pull?: MiseTomlSchemaBootstrapComposePull;
4155
4258
  /**
4259
+ * auto lets Compose decide, always passes --build, never passes --no-build
4260
+ *
4156
4261
  * @schema MiseTomlSchemaBootstrapCompose#build
4157
4262
  */
4158
4263
  readonly buildValue?: MiseTomlSchemaBootstrapComposeBuild;
4159
4264
  /**
4265
+ * auto lets Compose decide, always passes --force-recreate, never passes --no-recreate
4266
+ *
4160
4267
  * @schema MiseTomlSchemaBootstrapCompose#recreate
4161
4268
  */
4162
4269
  readonly recreate?: MiseTomlSchemaBootstrapComposeRecreate;
4163
4270
  /**
4271
+ * pass --wait to compose up, so it waits for services to be running and healthy
4272
+ *
4164
4273
  * @schema MiseTomlSchemaBootstrapCompose#wait
4165
4274
  */
4166
4275
  readonly wait?: boolean;
@@ -4177,22 +4286,32 @@ export interface MiseTomlSchemaBootstrapCompose {
4177
4286
  */
4178
4287
  readonly timeout?: number;
4179
4288
  /**
4289
+ * remove containers for services that are no longer in the Compose model
4290
+ *
4180
4291
  * @schema MiseTomlSchemaBootstrapCompose#remove_orphans
4181
4292
  */
4182
4293
  readonly removeOrphans?: boolean;
4183
4294
  /**
4295
+ * pass --renew-anon-volumes to compose up, recreating anonymous volumes
4296
+ *
4184
4297
  * @schema MiseTomlSchemaBootstrapCompose#renew_anonymous_volumes
4185
4298
  */
4186
4299
  readonly renewAnonymousVolumes?: boolean;
4187
4300
  /**
4301
+ * pass --volumes to compose down, removing the project's volumes
4302
+ *
4188
4303
  * @schema MiseTomlSchemaBootstrapCompose#down_volumes
4189
4304
  */
4190
4305
  readonly downVolumes?: boolean;
4191
4306
  /**
4307
+ * images compose down removes, passed as --rmi
4308
+ *
4192
4309
  * @schema MiseTomlSchemaBootstrapCompose#down_images
4193
4310
  */
4194
4311
  readonly downImages?: MiseTomlSchemaBootstrapComposeDownImages;
4195
4312
  /**
4313
+ * run every Compose and engine command through sudo, for a project on the system Docker daemon
4314
+ *
4196
4315
  * @schema MiseTomlSchemaBootstrapCompose#sudo
4197
4316
  */
4198
4317
  readonly sudo?: boolean;
@@ -4221,6 +4340,8 @@ export interface MiseTomlSchemaBootstrapCompose {
4221
4340
  */
4222
4341
  export declare function toJson_MiseTomlSchemaBootstrapCompose(obj: MiseTomlSchemaBootstrapCompose | undefined): Record<string, any> | undefined;
4223
4342
  /**
4343
+ * git repository to clone to this path, then keep on ref when one is set
4344
+ *
4224
4345
  * @schema MiseTomlSchemaBootstrapRepos
4225
4346
  */
4226
4347
  export interface MiseTomlSchemaBootstrapRepos {
@@ -4489,34 +4610,50 @@ export declare function toJson_BootstrapHooks(obj: BootstrapHooks | undefined):
4489
4610
  */
4490
4611
  export interface BootstrapMiseShellActivate {
4491
4612
  /**
4613
+ * manage the activation blocks in ~/.bash_profile (shims) and ~/.bashrc (activate); a mode applies to both files
4614
+ *
4492
4615
  * @schema bootstrap_mise_shell_activate#bash
4493
4616
  */
4494
4617
  readonly bash?: any;
4495
4618
  /**
4619
+ * manage the activation blocks in ~/.zprofile (shims) and ~/.zshrc (activate); a mode applies to both files, and ~/.zshenv is never written
4620
+ *
4496
4621
  * @schema bootstrap_mise_shell_activate#zsh
4497
4622
  */
4498
4623
  readonly zsh?: any;
4499
4624
  /**
4625
+ * manage the activation block in ~/.config/fish/config.fish; activate by default, and auto activates interactive shells and uses shims otherwise
4626
+ *
4500
4627
  * @schema bootstrap_mise_shell_activate#fish
4501
4628
  */
4502
4629
  readonly fish?: any;
4503
4630
  /**
4631
+ * manage the activation block in ~/.bash_profile; shims by default
4632
+ *
4504
4633
  * @schema bootstrap_mise_shell_activate#bash_profile
4505
4634
  */
4506
4635
  readonly bashProfile?: any;
4507
4636
  /**
4637
+ * manage the activation block in ~/.bashrc; activate by default
4638
+ *
4508
4639
  * @schema bootstrap_mise_shell_activate#bashrc
4509
4640
  */
4510
4641
  readonly bashrc?: any;
4511
4642
  /**
4643
+ * manage the activation block in ~/.zshenv, which zsh reads for every script; shims by default
4644
+ *
4512
4645
  * @schema bootstrap_mise_shell_activate#zshenv
4513
4646
  */
4514
4647
  readonly zshenv?: any;
4515
4648
  /**
4649
+ * manage the activation block in ~/.zprofile; shims by default
4650
+ *
4516
4651
  * @schema bootstrap_mise_shell_activate#zprofile
4517
4652
  */
4518
4653
  readonly zprofile?: any;
4519
4654
  /**
4655
+ * manage the activation block in ~/.zshrc; activate by default
4656
+ *
4520
4657
  * @schema bootstrap_mise_shell_activate#zshrc
4521
4658
  */
4522
4659
  readonly zshrc?: any;
@@ -4527,6 +4664,8 @@ export interface BootstrapMiseShellActivate {
4527
4664
  */
4528
4665
  export declare function toJson_BootstrapMiseShellActivate(obj: BootstrapMiseShellActivate | undefined): Record<string, any> | undefined;
4529
4666
  /**
4667
+ * local Linux group that bootstrap creates, updates, or removes
4668
+ *
4530
4669
  * @schema MiseTomlSchemaBootstrapGroups
4531
4670
  */
4532
4671
  export interface MiseTomlSchemaBootstrapGroups {
@@ -4555,6 +4694,8 @@ export interface MiseTomlSchemaBootstrapGroups {
4555
4694
  */
4556
4695
  export declare function toJson_MiseTomlSchemaBootstrapGroups(obj: MiseTomlSchemaBootstrapGroups | undefined): Record<string, any> | undefined;
4557
4696
  /**
4697
+ * local Linux user that bootstrap creates, updates, or removes
4698
+ *
4558
4699
  * @schema MiseTomlSchemaBootstrapUsers
4559
4700
  */
4560
4701
  export interface MiseTomlSchemaBootstrapUsers {
@@ -4637,6 +4778,8 @@ export interface MiseTomlSchemaBootstrapUsers {
4637
4778
  */
4638
4779
  export declare function toJson_MiseTomlSchemaBootstrapUsers(obj: MiseTomlSchemaBootstrapUsers | undefined): Record<string, any> | undefined;
4639
4780
  /**
4781
+ * encryption for dotfiles tracked with encrypt = true
4782
+ *
4640
4783
  * @schema MiseTomlSchemaHistoryEncryption
4641
4784
  */
4642
4785
  export interface MiseTomlSchemaHistoryEncryption {
@@ -4713,6 +4856,8 @@ export interface TaskConfigCache {
4713
4856
  */
4714
4857
  export declare function toJson_TaskConfigCache(obj: TaskConfigCache | undefined): Record<string, any> | undefined;
4715
4858
  /**
4859
+ * A check: a command that passes when it exits zero.
4860
+ *
4716
4861
  * @schema DoctorChecks
4717
4862
  */
4718
4863
  export interface DoctorChecks {
@@ -4766,6 +4911,8 @@ export interface DoctorChecks {
4766
4911
  */
4767
4912
  export declare function toJson_DoctorChecks(obj: DoctorChecks | undefined): Record<string, any> | undefined;
4768
4913
  /**
4914
+ * Service preset that runs the server.
4915
+ *
4769
4916
  * @schema MiseTomlSchemaDaemonProvidersPreset
4770
4917
  */
4771
4918
  export declare enum MiseTomlSchemaDaemonProvidersPreset {
@@ -5038,6 +5185,8 @@ export declare enum BootstrapFilePhase {
5038
5185
  POST_HYPHEN_PACKAGES = "post-packages"
5039
5186
  }
5040
5187
  /**
5188
+ * present creates or updates the file; absent removes it whatever its content
5189
+ *
5041
5190
  * @schema MiseTomlSchemaBootstrapFilesState
5042
5191
  */
5043
5192
  export declare enum MiseTomlSchemaBootstrapFilesState {
@@ -5047,6 +5196,8 @@ export declare enum MiseTomlSchemaBootstrapFilesState {
5047
5196
  ABSENT = "absent"
5048
5197
  }
5049
5198
  /**
5199
+ * present creates the directory with any missing parents; absent removes it, which must then be empty unless recursive is set
5200
+ *
5050
5201
  * @schema MiseTomlSchemaBootstrapDirectoriesState
5051
5202
  */
5052
5203
  export declare enum MiseTomlSchemaBootstrapDirectoriesState {
@@ -5065,6 +5216,8 @@ export declare class BootstrapRemoteInstallMise {
5065
5216
  private constructor();
5066
5217
  }
5067
5218
  /**
5219
+ * SSH target that `mise bootstrap remote` can bootstrap, selected by name or tag
5220
+ *
5068
5221
  * @schema MiseTomlSchemaBootstrapRemoteHosts
5069
5222
  */
5070
5223
  export interface MiseTomlSchemaBootstrapRemoteHosts {
@@ -5165,6 +5318,8 @@ export interface MiseTomlSchemaBootstrapRemoteHosts {
5165
5318
  */
5166
5319
  export declare function toJson_MiseTomlSchemaBootstrapRemoteHosts(obj: MiseTomlSchemaBootstrapRemoteHosts | undefined): Record<string, any> | undefined;
5167
5320
  /**
5321
+ * running or stopped; absent removes a user service's definition (user scope only)
5322
+ *
5168
5323
  * @schema MiseTomlSchemaBootstrapServicesState
5169
5324
  */
5170
5325
  export declare enum MiseTomlSchemaBootstrapServicesState {
@@ -5214,6 +5369,8 @@ export declare enum MiseTomlSchemaBootstrapServicesBuiltin {
5214
5369
  TOOL_HYPHEN_UPDATE = "tool-update"
5215
5370
  }
5216
5371
  /**
5372
+ * when to restart the process after it exits: on-failure, always, or never; on Windows, always and on-failure both retry failed runs only; user scope only
5373
+ *
5217
5374
  * @schema MiseTomlSchemaBootstrapServicesRestart
5218
5375
  */
5219
5376
  export declare enum MiseTomlSchemaBootstrapServicesRestart {
@@ -5225,6 +5382,8 @@ export declare enum MiseTomlSchemaBootstrapServicesRestart {
5225
5382
  NEVER = "never"
5226
5383
  }
5227
5384
  /**
5385
+ * running (compose up), stopped (compose stop, keeping containers and data), or absent (compose down)
5386
+ *
5228
5387
  * @schema MiseTomlSchemaBootstrapComposeState
5229
5388
  */
5230
5389
  export declare enum MiseTomlSchemaBootstrapComposeState {
@@ -5236,6 +5395,8 @@ export declare enum MiseTomlSchemaBootstrapComposeState {
5236
5395
  ABSENT = "absent"
5237
5396
  }
5238
5397
  /**
5398
+ * image pull policy passed to compose up as --pull
5399
+ *
5239
5400
  * @schema MiseTomlSchemaBootstrapComposePull
5240
5401
  */
5241
5402
  export declare enum MiseTomlSchemaBootstrapComposePull {
@@ -5247,6 +5408,8 @@ export declare enum MiseTomlSchemaBootstrapComposePull {
5247
5408
  NEVER = "never"
5248
5409
  }
5249
5410
  /**
5411
+ * auto lets Compose decide, always passes --build, never passes --no-build
5412
+ *
5250
5413
  * @schema MiseTomlSchemaBootstrapComposeBuild
5251
5414
  */
5252
5415
  export declare enum MiseTomlSchemaBootstrapComposeBuild {
@@ -5258,6 +5421,8 @@ export declare enum MiseTomlSchemaBootstrapComposeBuild {
5258
5421
  NEVER = "never"
5259
5422
  }
5260
5423
  /**
5424
+ * auto lets Compose decide, always passes --force-recreate, never passes --no-recreate
5425
+ *
5261
5426
  * @schema MiseTomlSchemaBootstrapComposeRecreate
5262
5427
  */
5263
5428
  export declare enum MiseTomlSchemaBootstrapComposeRecreate {
@@ -5269,6 +5434,8 @@ export declare enum MiseTomlSchemaBootstrapComposeRecreate {
5269
5434
  NEVER = "never"
5270
5435
  }
5271
5436
  /**
5437
+ * images compose down removes, passed as --rmi
5438
+ *
5272
5439
  * @schema MiseTomlSchemaBootstrapComposeDownImages
5273
5440
  */
5274
5441
  export declare enum MiseTomlSchemaBootstrapComposeDownImages {
@@ -5480,14 +5647,20 @@ export declare function toJson_BootstrapMacosTrackpad(obj: BootstrapMacosTrackpa
5480
5647
  */
5481
5648
  export interface MiseTomlSchemaBootstrapMacosDefaultsEntries {
5482
5649
  /**
5650
+ * preferences domain, such as "com.apple.dock" or "NSGlobalDomain"; -g and -globalDomain mean NSGlobalDomain
5651
+ *
5483
5652
  * @schema MiseTomlSchemaBootstrapMacosDefaultsEntries#domain
5484
5653
  */
5485
5654
  readonly domain: string;
5486
5655
  /**
5656
+ * preference key within the domain
5657
+ *
5487
5658
  * @schema MiseTomlSchemaBootstrapMacosDefaultsEntries#key
5488
5659
  */
5489
5660
  readonly key: string;
5490
5661
  /**
5662
+ * any writes the preference for every host; current writes it for this machine only, like defaults -currentHost
5663
+ *
5491
5664
  * @schema MiseTomlSchemaBootstrapMacosDefaultsEntries#host
5492
5665
  */
5493
5666
  readonly host?: MiseTomlSchemaBootstrapMacosDefaultsEntriesHost;
@@ -5498,6 +5671,8 @@ export interface MiseTomlSchemaBootstrapMacosDefaultsEntries {
5498
5671
  */
5499
5672
  readonly path?: string[];
5500
5673
  /**
5674
+ * desired value, written with the matching property list type; replaces the selected value in full
5675
+ *
5501
5676
  * @schema MiseTomlSchemaBootstrapMacosDefaultsEntries#value
5502
5677
  */
5503
5678
  readonly value: any;
@@ -5626,6 +5801,8 @@ export interface MiseTomlSchemaBootstrapLinuxSystemd {
5626
5801
  */
5627
5802
  export declare function toJson_MiseTomlSchemaBootstrapLinuxSystemd(obj: MiseTomlSchemaBootstrapLinuxSystemd | undefined): Record<string, any> | undefined;
5628
5803
  /**
5804
+ * apt source: a Launchpad PPA, or repository URIs with the key that signs them
5805
+ *
5629
5806
  * @schema BootstrapAptSources
5630
5807
  */
5631
5808
  export interface BootstrapAptSources {
@@ -5678,6 +5855,8 @@ export interface BootstrapAptSources {
5678
5855
  */
5679
5856
  export declare function toJson_BootstrapAptSources(obj: BootstrapAptSources | undefined): Record<string, any> | undefined;
5680
5857
  /**
5858
+ * dnf repository to enable, given as a COPR project
5859
+ *
5681
5860
  * @schema BootstrapDnfRepos
5682
5861
  */
5683
5862
  export interface BootstrapDnfRepos {
@@ -5744,6 +5923,8 @@ export declare enum BootstrapMacosFinderPreferredViewStyle {
5744
5923
  GALLERY = "gallery"
5745
5924
  }
5746
5925
  /**
5926
+ * any writes the preference for every host; current writes it for this machine only, like defaults -currentHost
5927
+ *
5747
5928
  * @schema MiseTomlSchemaBootstrapMacosDefaultsEntriesHost
5748
5929
  */
5749
5930
  export declare enum MiseTomlSchemaBootstrapMacosDefaultsEntriesHost {
@@ -5753,6 +5934,8 @@ export declare enum MiseTomlSchemaBootstrapMacosDefaultsEntriesHost {
5753
5934
  CURRENT = "current"
5754
5935
  }
5755
5936
  /**
5937
+ * macOS LaunchAgent written to ~/Library/LaunchAgents/dev.mise.<name>.plist and loaded for the current user
5938
+ *
5756
5939
  * @schema MiseTomlSchemaBootstrapMacosLaunchdAgents
5757
5940
  */
5758
5941
  export interface MiseTomlSchemaBootstrapMacosLaunchdAgents {
@@ -5925,14 +6108,20 @@ export interface MiseTomlSchemaBootstrapLinuxFirewallRules {
5925
6108
  */
5926
6109
  readonly name: string;
5927
6110
  /**
6111
+ * present adds the rule; absent removes a rule mise added earlier
6112
+ *
5928
6113
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRules#state
5929
6114
  */
5930
6115
  readonly state?: MiseTomlSchemaBootstrapLinuxFirewallRulesState;
5931
6116
  /**
6117
+ * traffic direction the rule matches
6118
+ *
5932
6119
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRules#direction
5933
6120
  */
5934
6121
  readonly direction?: MiseTomlSchemaBootstrapLinuxFirewallRulesDirection;
5935
6122
  /**
6123
+ * what to do with matching traffic; limit needs incoming TCP and is not available on firewalld
6124
+ *
5936
6125
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRules#action
5937
6126
  */
5938
6127
  readonly action?: MiseTomlSchemaBootstrapLinuxFirewallRulesAction;
@@ -5943,6 +6132,8 @@ export interface MiseTomlSchemaBootstrapLinuxFirewallRules {
5943
6132
  */
5944
6133
  readonly port?: MiseTomlSchemaBootstrapLinuxFirewallRulesPort;
5945
6134
  /**
6135
+ * protocol to match; any when unset, and UFW supports only tcp and udp
6136
+ *
5946
6137
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRules#protocol
5947
6138
  */
5948
6139
  readonly protocol?: MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol;
@@ -5971,6 +6162,8 @@ export interface MiseTomlSchemaBootstrapLinuxFirewallRules {
5971
6162
  */
5972
6163
  export declare function toJson_MiseTomlSchemaBootstrapLinuxFirewallRules(obj: MiseTomlSchemaBootstrapLinuxFirewallRules | undefined): Record<string, any> | undefined;
5973
6164
  /**
6165
+ * systemd user unit written to ~/.config/systemd/user/dev.mise.<name>.service, or .timer when it sets a timer key
6166
+ *
5974
6167
  * @schema MiseTomlSchemaBootstrapLinuxSystemdUnits
5975
6168
  */
5976
6169
  export interface MiseTomlSchemaBootstrapLinuxSystemdUnits {
@@ -6238,22 +6431,32 @@ export declare enum MiseTomlSchemaBootstrapMacosLaunchdAgentsProcessType {
6238
6431
  */
6239
6432
  export interface LaunchdCalendarInterval {
6240
6433
  /**
6434
+ * minute of the hour, 0-59; every minute when unset
6435
+ *
6241
6436
  * @schema launchd_calendar_interval#minute
6242
6437
  */
6243
6438
  readonly minute?: number;
6244
6439
  /**
6440
+ * hour of the day, 0-23; every hour when unset
6441
+ *
6245
6442
  * @schema launchd_calendar_interval#hour
6246
6443
  */
6247
6444
  readonly hour?: number;
6248
6445
  /**
6446
+ * day of the month, 1-31; every day when unset
6447
+ *
6249
6448
  * @schema launchd_calendar_interval#day
6250
6449
  */
6251
6450
  readonly day?: number;
6252
6451
  /**
6452
+ * day of the week, 0-7, where 0 and 7 are Sunday; every day when unset
6453
+ *
6253
6454
  * @schema launchd_calendar_interval#weekday
6254
6455
  */
6255
6456
  readonly weekday?: number;
6256
6457
  /**
6458
+ * month of the year, 1-12; every month when unset
6459
+ *
6257
6460
  * @schema launchd_calendar_interval#month
6258
6461
  */
6259
6462
  readonly month?: number;
@@ -6264,6 +6467,8 @@ export interface LaunchdCalendarInterval {
6264
6467
  */
6265
6468
  export declare function toJson_LaunchdCalendarInterval(obj: LaunchdCalendarInterval | undefined): Record<string, any> | undefined;
6266
6469
  /**
6470
+ * present adds the rule; absent removes a rule mise added earlier
6471
+ *
6267
6472
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRulesState
6268
6473
  */
6269
6474
  export declare enum MiseTomlSchemaBootstrapLinuxFirewallRulesState {
@@ -6273,6 +6478,8 @@ export declare enum MiseTomlSchemaBootstrapLinuxFirewallRulesState {
6273
6478
  ABSENT = "absent"
6274
6479
  }
6275
6480
  /**
6481
+ * traffic direction the rule matches
6482
+ *
6276
6483
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRulesDirection
6277
6484
  */
6278
6485
  export declare enum MiseTomlSchemaBootstrapLinuxFirewallRulesDirection {
@@ -6282,6 +6489,8 @@ export declare enum MiseTomlSchemaBootstrapLinuxFirewallRulesDirection {
6282
6489
  OUTGOING = "outgoing"
6283
6490
  }
6284
6491
  /**
6492
+ * what to do with matching traffic; limit needs incoming TCP and is not available on firewalld
6493
+ *
6285
6494
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRulesAction
6286
6495
  */
6287
6496
  export declare enum MiseTomlSchemaBootstrapLinuxFirewallRulesAction {
@@ -6306,6 +6515,8 @@ export declare class MiseTomlSchemaBootstrapLinuxFirewallRulesPort {
6306
6515
  private constructor();
6307
6516
  }
6308
6517
  /**
6518
+ * protocol to match; any when unset, and UFW supports only tcp and udp
6519
+ *
6309
6520
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol
6310
6521
  */
6311
6522
  export declare enum MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol {