mise-projen 0.0.21 → 0.0.23

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.
@@ -3047,6 +3086,12 @@ export declare function toJson_SettingsPrune(obj: SettingsPrune | undefined): Re
3047
3086
  * @schema SettingsPypi
3048
3087
  */
3049
3088
  export interface SettingsPypi {
3089
+ /**
3090
+ * Read a `pypi:` index password from a `keyring` command when the index URL names a user but no password.
3091
+ *
3092
+ * @schema SettingsPypi#keyring_provider
3093
+ */
3094
+ readonly keyringProvider?: SettingsPypiKeyringProvider;
3050
3095
  /**
3051
3096
  * Package index URL that `pypi:` tools list versions from, with `{}` in place of the package name.
3052
3097
  *
@@ -3868,6 +3913,8 @@ export declare enum MiseTomlSchemaDotfileGroupsManifest {
3868
3913
  GIT = "git"
3869
3914
  }
3870
3915
  /**
3916
+ * file whose content, owner, group, and mode mise manages, keyed by an absolute or ~/ target path
3917
+ *
3871
3918
  * @schema MiseTomlSchemaBootstrapFiles
3872
3919
  */
3873
3920
  export interface MiseTomlSchemaBootstrapFiles {
@@ -3876,26 +3923,38 @@ export interface MiseTomlSchemaBootstrapFiles {
3876
3923
  */
3877
3924
  readonly phase?: BootstrapFilePhase;
3878
3925
  /**
3926
+ * file to copy the content from; a relative path resolves from the declaring config's directory and ~/ from your home directory
3927
+ *
3879
3928
  * @schema MiseTomlSchemaBootstrapFiles#source
3880
3929
  */
3881
3930
  readonly source?: string;
3882
3931
  /**
3932
+ * inline file content; cannot be combined with source
3933
+ *
3883
3934
  * @schema MiseTomlSchemaBootstrapFiles#content
3884
3935
  */
3885
3936
  readonly content?: string;
3886
3937
  /**
3938
+ * user that should own the file; left as it is when unset
3939
+ *
3887
3940
  * @schema MiseTomlSchemaBootstrapFiles#owner
3888
3941
  */
3889
3942
  readonly owner?: string;
3890
3943
  /**
3944
+ * group that should own the file; left as it is when unset
3945
+ *
3891
3946
  * @schema MiseTomlSchemaBootstrapFiles#group
3892
3947
  */
3893
3948
  readonly group?: string;
3894
3949
  /**
3950
+ * octal permissions such as "0640"; defaults to "0644" for a file with source or content, otherwise left as it is
3951
+ *
3895
3952
  * @schema MiseTomlSchemaBootstrapFiles#mode
3896
3953
  */
3897
3954
  readonly mode?: string;
3898
3955
  /**
3956
+ * render source or content with mise's template engine; without it, template syntax is written unchanged
3957
+ *
3899
3958
  * @schema MiseTomlSchemaBootstrapFiles#template
3900
3959
  */
3901
3960
  readonly template?: boolean;
@@ -3906,14 +3965,20 @@ export interface MiseTomlSchemaBootstrapFiles {
3906
3965
  */
3907
3966
  readonly removeEmpty?: boolean;
3908
3967
  /**
3968
+ * present creates or updates the file; absent removes it whatever its content
3969
+ *
3909
3970
  * @schema MiseTomlSchemaBootstrapFiles#state
3910
3971
  */
3911
3972
  readonly state?: MiseTomlSchemaBootstrapFilesState;
3912
3973
  /**
3974
+ * replace a path of another type at the target, such as an empty directory; requires source or content
3975
+ *
3913
3976
  * @schema MiseTomlSchemaBootstrapFiles#replace
3914
3977
  */
3915
3978
  readonly replace?: boolean;
3916
3979
  /**
3980
+ * system services declared in [bootstrap.services] to reload or restart when mise changes this file
3981
+ *
3917
3982
  * @schema MiseTomlSchemaBootstrapFiles#notify
3918
3983
  */
3919
3984
  readonly notify?: string[];
@@ -3930,6 +3995,8 @@ export interface MiseTomlSchemaBootstrapFiles {
3930
3995
  */
3931
3996
  export declare function toJson_MiseTomlSchemaBootstrapFiles(obj: MiseTomlSchemaBootstrapFiles | undefined): Record<string, any> | undefined;
3932
3997
  /**
3998
+ * directory whose owner, group, and mode mise manages, keyed by an absolute or ~/ target path
3999
+ *
3933
4000
  * @schema MiseTomlSchemaBootstrapDirectories
3934
4001
  */
3935
4002
  export interface MiseTomlSchemaBootstrapDirectories {
@@ -3938,30 +4005,44 @@ export interface MiseTomlSchemaBootstrapDirectories {
3938
4005
  */
3939
4006
  readonly phase?: BootstrapFilePhase;
3940
4007
  /**
4008
+ * user that should own the directory; left as it is when unset, and parents mise creates get the system defaults
4009
+ *
3941
4010
  * @schema MiseTomlSchemaBootstrapDirectories#owner
3942
4011
  */
3943
4012
  readonly owner?: string;
3944
4013
  /**
4014
+ * group that should own the directory; left as it is when unset, and parents mise creates get the system defaults
4015
+ *
3945
4016
  * @schema MiseTomlSchemaBootstrapDirectories#group
3946
4017
  */
3947
4018
  readonly group?: string;
3948
4019
  /**
4020
+ * octal permissions such as "0755"; defaults to "0755"
4021
+ *
3949
4022
  * @schema MiseTomlSchemaBootstrapDirectories#mode
3950
4023
  */
3951
4024
  readonly mode?: string;
3952
4025
  /**
4026
+ * present creates the directory with any missing parents; absent removes it, which must then be empty unless recursive is set
4027
+ *
3953
4028
  * @schema MiseTomlSchemaBootstrapDirectories#state
3954
4029
  */
3955
4030
  readonly state?: MiseTomlSchemaBootstrapDirectoriesState;
3956
4031
  /**
4032
+ * with state = "absent", delete the directory and everything in it
4033
+ *
3957
4034
  * @schema MiseTomlSchemaBootstrapDirectories#recursive
3958
4035
  */
3959
4036
  readonly recursive?: boolean;
3960
4037
  /**
4038
+ * replace a path of another type at the target, such as a file
4039
+ *
3961
4040
  * @schema MiseTomlSchemaBootstrapDirectories#replace
3962
4041
  */
3963
4042
  readonly replace?: boolean;
3964
4043
  /**
4044
+ * system services declared in [bootstrap.services] to reload or restart when mise changes this directory
4045
+ *
3965
4046
  * @schema MiseTomlSchemaBootstrapDirectories#notify
3966
4047
  */
3967
4048
  readonly notify?: string[];
@@ -4034,14 +4115,20 @@ export interface MiseTomlSchemaBootstrapRemote {
4034
4115
  */
4035
4116
  export declare function toJson_MiseTomlSchemaBootstrapRemote(obj: MiseTomlSchemaBootstrapRemote | undefined): Record<string, any> | undefined;
4036
4117
  /**
4118
+ * Linux systemd system unit that mise starts, stops, enables, or masks, or a user service mise defines from command or builtin
4119
+ *
4037
4120
  * @schema MiseTomlSchemaBootstrapServices
4038
4121
  */
4039
4122
  export interface MiseTomlSchemaBootstrapServices {
4040
4123
  /**
4124
+ * running or stopped; absent removes a user service's definition (user scope only)
4125
+ *
4041
4126
  * @schema MiseTomlSchemaBootstrapServices#state
4042
4127
  */
4043
4128
  readonly state?: MiseTomlSchemaBootstrapServicesState;
4044
4129
  /**
4130
+ * start the service at boot (system scope) or at login (user scope)
4131
+ *
4045
4132
  * @schema MiseTomlSchemaBootstrapServices#enabled
4046
4133
  */
4047
4134
  readonly enabled?: boolean;
@@ -4077,24 +4164,34 @@ export interface MiseTomlSchemaBootstrapServices {
4077
4164
  */
4078
4165
  readonly command?: string;
4079
4166
  /**
4167
+ * text the service manager shows for the service; user scope only
4168
+ *
4080
4169
  * @schema MiseTomlSchemaBootstrapServices#description
4081
4170
  */
4082
4171
  readonly description?: string;
4083
4172
  /**
4173
+ * 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
4174
+ *
4084
4175
  * @schema MiseTomlSchemaBootstrapServices#restart
4085
4176
  */
4086
4177
  readonly restart?: MiseTomlSchemaBootstrapServicesRestart;
4087
4178
  /**
4179
+ * environment variables for the process; user scope only
4180
+ *
4088
4181
  * @schema MiseTomlSchemaBootstrapServices#environment
4089
4182
  */
4090
4183
  readonly environment?: {
4091
4184
  [key: string]: string;
4092
4185
  };
4093
4186
  /**
4187
+ * directory to run the process in, with ~ expanded; user scope only
4188
+ *
4094
4189
  * @schema MiseTomlSchemaBootstrapServices#working_directory
4095
4190
  */
4096
4191
  readonly workingDirectory?: string;
4097
4192
  /**
4193
+ * start the service only after `mise bootstrap` installs [tools] and plugin packages; user scope only
4194
+ *
4098
4195
  * @schema MiseTomlSchemaBootstrapServices#requires_tools
4099
4196
  */
4100
4197
  readonly requiresTools?: boolean;
@@ -4105,6 +4202,8 @@ export interface MiseTomlSchemaBootstrapServices {
4105
4202
  */
4106
4203
  export declare function toJson_MiseTomlSchemaBootstrapServices(obj: MiseTomlSchemaBootstrapServices | undefined): Record<string, any> | undefined;
4107
4204
  /**
4205
+ * Docker Compose project that mise brings up, stops, or removes
4206
+ *
4108
4207
  * @schema MiseTomlSchemaBootstrapCompose
4109
4208
  */
4110
4209
  export interface MiseTomlSchemaBootstrapCompose {
@@ -4133,34 +4232,50 @@ export interface MiseTomlSchemaBootstrapCompose {
4133
4232
  */
4134
4233
  readonly projectName?: string;
4135
4234
  /**
4235
+ * Compose profiles to enable, passed with --profile
4236
+ *
4136
4237
  * @schema MiseTomlSchemaBootstrapCompose#profiles
4137
4238
  */
4138
4239
  readonly profiles?: string[];
4139
4240
  /**
4241
+ * services to manage; defaults to every service the files and profiles enable
4242
+ *
4140
4243
  * @schema MiseTomlSchemaBootstrapCompose#services
4141
4244
  */
4142
4245
  readonly services?: string[];
4143
4246
  /**
4247
+ * services that run once and count as converged after exiting with code 0; when services is set, they must be listed there too
4248
+ *
4144
4249
  * @schema MiseTomlSchemaBootstrapCompose#oneshot
4145
4250
  */
4146
4251
  readonly oneshot?: string[];
4147
4252
  /**
4253
+ * running (compose up), stopped (compose stop, keeping containers and data), or absent (compose down)
4254
+ *
4148
4255
  * @schema MiseTomlSchemaBootstrapCompose#state
4149
4256
  */
4150
4257
  readonly state?: MiseTomlSchemaBootstrapComposeState;
4151
4258
  /**
4259
+ * image pull policy passed to compose up as --pull
4260
+ *
4152
4261
  * @schema MiseTomlSchemaBootstrapCompose#pull
4153
4262
  */
4154
4263
  readonly pull?: MiseTomlSchemaBootstrapComposePull;
4155
4264
  /**
4265
+ * auto lets Compose decide, always passes --build, never passes --no-build
4266
+ *
4156
4267
  * @schema MiseTomlSchemaBootstrapCompose#build
4157
4268
  */
4158
4269
  readonly buildValue?: MiseTomlSchemaBootstrapComposeBuild;
4159
4270
  /**
4271
+ * auto lets Compose decide, always passes --force-recreate, never passes --no-recreate
4272
+ *
4160
4273
  * @schema MiseTomlSchemaBootstrapCompose#recreate
4161
4274
  */
4162
4275
  readonly recreate?: MiseTomlSchemaBootstrapComposeRecreate;
4163
4276
  /**
4277
+ * pass --wait to compose up, so it waits for services to be running and healthy
4278
+ *
4164
4279
  * @schema MiseTomlSchemaBootstrapCompose#wait
4165
4280
  */
4166
4281
  readonly wait?: boolean;
@@ -4177,22 +4292,32 @@ export interface MiseTomlSchemaBootstrapCompose {
4177
4292
  */
4178
4293
  readonly timeout?: number;
4179
4294
  /**
4295
+ * remove containers for services that are no longer in the Compose model
4296
+ *
4180
4297
  * @schema MiseTomlSchemaBootstrapCompose#remove_orphans
4181
4298
  */
4182
4299
  readonly removeOrphans?: boolean;
4183
4300
  /**
4301
+ * pass --renew-anon-volumes to compose up, recreating anonymous volumes
4302
+ *
4184
4303
  * @schema MiseTomlSchemaBootstrapCompose#renew_anonymous_volumes
4185
4304
  */
4186
4305
  readonly renewAnonymousVolumes?: boolean;
4187
4306
  /**
4307
+ * pass --volumes to compose down, removing the project's volumes
4308
+ *
4188
4309
  * @schema MiseTomlSchemaBootstrapCompose#down_volumes
4189
4310
  */
4190
4311
  readonly downVolumes?: boolean;
4191
4312
  /**
4313
+ * images compose down removes, passed as --rmi
4314
+ *
4192
4315
  * @schema MiseTomlSchemaBootstrapCompose#down_images
4193
4316
  */
4194
4317
  readonly downImages?: MiseTomlSchemaBootstrapComposeDownImages;
4195
4318
  /**
4319
+ * run every Compose and engine command through sudo, for a project on the system Docker daemon
4320
+ *
4196
4321
  * @schema MiseTomlSchemaBootstrapCompose#sudo
4197
4322
  */
4198
4323
  readonly sudo?: boolean;
@@ -4221,6 +4346,8 @@ export interface MiseTomlSchemaBootstrapCompose {
4221
4346
  */
4222
4347
  export declare function toJson_MiseTomlSchemaBootstrapCompose(obj: MiseTomlSchemaBootstrapCompose | undefined): Record<string, any> | undefined;
4223
4348
  /**
4349
+ * git repository to clone to this path, then keep on ref when one is set
4350
+ *
4224
4351
  * @schema MiseTomlSchemaBootstrapRepos
4225
4352
  */
4226
4353
  export interface MiseTomlSchemaBootstrapRepos {
@@ -4345,7 +4472,7 @@ export declare function toJson_MiseTomlSchemaBootstrapLinux(obj: MiseTomlSchemaB
4345
4472
  */
4346
4473
  export interface MiseTomlSchemaBootstrapUser {
4347
4474
  /**
4348
- * current user's desired login shell, applied with `chsh -s`; a template that must render to an absolute path
4475
+ * current user's desired login shell, applied with `chsh -s`; an absolute path or a bare shell name resolved after packages are installed; may be a template
4349
4476
  *
4350
4477
  * @schema MiseTomlSchemaBootstrapUser#login_shell
4351
4478
  */
@@ -4489,34 +4616,50 @@ export declare function toJson_BootstrapHooks(obj: BootstrapHooks | undefined):
4489
4616
  */
4490
4617
  export interface BootstrapMiseShellActivate {
4491
4618
  /**
4619
+ * manage the activation blocks in ~/.bash_profile (shims) and ~/.bashrc (activate); a mode applies to both files
4620
+ *
4492
4621
  * @schema bootstrap_mise_shell_activate#bash
4493
4622
  */
4494
4623
  readonly bash?: any;
4495
4624
  /**
4625
+ * manage the activation blocks in ~/.zprofile (shims) and ~/.zshrc (activate); a mode applies to both files, and ~/.zshenv is never written
4626
+ *
4496
4627
  * @schema bootstrap_mise_shell_activate#zsh
4497
4628
  */
4498
4629
  readonly zsh?: any;
4499
4630
  /**
4631
+ * manage the activation block in ~/.config/fish/config.fish; activate by default, and auto activates interactive shells and uses shims otherwise
4632
+ *
4500
4633
  * @schema bootstrap_mise_shell_activate#fish
4501
4634
  */
4502
4635
  readonly fish?: any;
4503
4636
  /**
4637
+ * manage the activation block in ~/.bash_profile; shims by default
4638
+ *
4504
4639
  * @schema bootstrap_mise_shell_activate#bash_profile
4505
4640
  */
4506
4641
  readonly bashProfile?: any;
4507
4642
  /**
4643
+ * manage the activation block in ~/.bashrc; activate by default
4644
+ *
4508
4645
  * @schema bootstrap_mise_shell_activate#bashrc
4509
4646
  */
4510
4647
  readonly bashrc?: any;
4511
4648
  /**
4649
+ * manage the activation block in ~/.zshenv, which zsh reads for every script; shims by default
4650
+ *
4512
4651
  * @schema bootstrap_mise_shell_activate#zshenv
4513
4652
  */
4514
4653
  readonly zshenv?: any;
4515
4654
  /**
4655
+ * manage the activation block in ~/.zprofile; shims by default
4656
+ *
4516
4657
  * @schema bootstrap_mise_shell_activate#zprofile
4517
4658
  */
4518
4659
  readonly zprofile?: any;
4519
4660
  /**
4661
+ * manage the activation block in ~/.zshrc; activate by default
4662
+ *
4520
4663
  * @schema bootstrap_mise_shell_activate#zshrc
4521
4664
  */
4522
4665
  readonly zshrc?: any;
@@ -4527,6 +4670,8 @@ export interface BootstrapMiseShellActivate {
4527
4670
  */
4528
4671
  export declare function toJson_BootstrapMiseShellActivate(obj: BootstrapMiseShellActivate | undefined): Record<string, any> | undefined;
4529
4672
  /**
4673
+ * local Linux group that bootstrap creates, updates, or removes
4674
+ *
4530
4675
  * @schema MiseTomlSchemaBootstrapGroups
4531
4676
  */
4532
4677
  export interface MiseTomlSchemaBootstrapGroups {
@@ -4555,6 +4700,8 @@ export interface MiseTomlSchemaBootstrapGroups {
4555
4700
  */
4556
4701
  export declare function toJson_MiseTomlSchemaBootstrapGroups(obj: MiseTomlSchemaBootstrapGroups | undefined): Record<string, any> | undefined;
4557
4702
  /**
4703
+ * local Linux user that bootstrap creates, updates, or removes
4704
+ *
4558
4705
  * @schema MiseTomlSchemaBootstrapUsers
4559
4706
  */
4560
4707
  export interface MiseTomlSchemaBootstrapUsers {
@@ -4637,6 +4784,8 @@ export interface MiseTomlSchemaBootstrapUsers {
4637
4784
  */
4638
4785
  export declare function toJson_MiseTomlSchemaBootstrapUsers(obj: MiseTomlSchemaBootstrapUsers | undefined): Record<string, any> | undefined;
4639
4786
  /**
4787
+ * encryption for dotfiles tracked with encrypt = true
4788
+ *
4640
4789
  * @schema MiseTomlSchemaHistoryEncryption
4641
4790
  */
4642
4791
  export interface MiseTomlSchemaHistoryEncryption {
@@ -4713,6 +4862,8 @@ export interface TaskConfigCache {
4713
4862
  */
4714
4863
  export declare function toJson_TaskConfigCache(obj: TaskConfigCache | undefined): Record<string, any> | undefined;
4715
4864
  /**
4865
+ * A check: a command that passes when it exits zero.
4866
+ *
4716
4867
  * @schema DoctorChecks
4717
4868
  */
4718
4869
  export interface DoctorChecks {
@@ -4766,6 +4917,8 @@ export interface DoctorChecks {
4766
4917
  */
4767
4918
  export declare function toJson_DoctorChecks(obj: DoctorChecks | undefined): Record<string, any> | undefined;
4768
4919
  /**
4920
+ * Service preset that runs the server.
4921
+ *
4769
4922
  * @schema MiseTomlSchemaDaemonProvidersPreset
4770
4923
  */
4771
4924
  export declare enum MiseTomlSchemaDaemonProvidersPreset {
@@ -4877,6 +5030,17 @@ export declare enum SettingsNpmPackageManager {
4877
5030
  /** pnpm */
4878
5031
  PNPM = "pnpm"
4879
5032
  }
5033
+ /**
5034
+ * Read a `pypi:` index password from a `keyring` command when the index URL names a user but no password.
5035
+ *
5036
+ * @schema SettingsPypiKeyringProvider
5037
+ */
5038
+ export declare enum SettingsPypiKeyringProvider {
5039
+ /** disabled */
5040
+ DISABLED = "disabled",
5041
+ /** subprocess */
5042
+ SUBPROCESS = "subprocess"
5043
+ }
4880
5044
  /**
4881
5045
  * Activate, and optionally create, the virtualenv of the uv project around the current directory.
4882
5046
  *
@@ -5038,6 +5202,8 @@ export declare enum BootstrapFilePhase {
5038
5202
  POST_HYPHEN_PACKAGES = "post-packages"
5039
5203
  }
5040
5204
  /**
5205
+ * present creates or updates the file; absent removes it whatever its content
5206
+ *
5041
5207
  * @schema MiseTomlSchemaBootstrapFilesState
5042
5208
  */
5043
5209
  export declare enum MiseTomlSchemaBootstrapFilesState {
@@ -5047,6 +5213,8 @@ export declare enum MiseTomlSchemaBootstrapFilesState {
5047
5213
  ABSENT = "absent"
5048
5214
  }
5049
5215
  /**
5216
+ * present creates the directory with any missing parents; absent removes it, which must then be empty unless recursive is set
5217
+ *
5050
5218
  * @schema MiseTomlSchemaBootstrapDirectoriesState
5051
5219
  */
5052
5220
  export declare enum MiseTomlSchemaBootstrapDirectoriesState {
@@ -5065,6 +5233,8 @@ export declare class BootstrapRemoteInstallMise {
5065
5233
  private constructor();
5066
5234
  }
5067
5235
  /**
5236
+ * SSH target that `mise bootstrap remote` can bootstrap, selected by name or tag
5237
+ *
5068
5238
  * @schema MiseTomlSchemaBootstrapRemoteHosts
5069
5239
  */
5070
5240
  export interface MiseTomlSchemaBootstrapRemoteHosts {
@@ -5165,6 +5335,8 @@ export interface MiseTomlSchemaBootstrapRemoteHosts {
5165
5335
  */
5166
5336
  export declare function toJson_MiseTomlSchemaBootstrapRemoteHosts(obj: MiseTomlSchemaBootstrapRemoteHosts | undefined): Record<string, any> | undefined;
5167
5337
  /**
5338
+ * running or stopped; absent removes a user service's definition (user scope only)
5339
+ *
5168
5340
  * @schema MiseTomlSchemaBootstrapServicesState
5169
5341
  */
5170
5342
  export declare enum MiseTomlSchemaBootstrapServicesState {
@@ -5214,6 +5386,8 @@ export declare enum MiseTomlSchemaBootstrapServicesBuiltin {
5214
5386
  TOOL_HYPHEN_UPDATE = "tool-update"
5215
5387
  }
5216
5388
  /**
5389
+ * 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
5390
+ *
5217
5391
  * @schema MiseTomlSchemaBootstrapServicesRestart
5218
5392
  */
5219
5393
  export declare enum MiseTomlSchemaBootstrapServicesRestart {
@@ -5225,6 +5399,8 @@ export declare enum MiseTomlSchemaBootstrapServicesRestart {
5225
5399
  NEVER = "never"
5226
5400
  }
5227
5401
  /**
5402
+ * running (compose up), stopped (compose stop, keeping containers and data), or absent (compose down)
5403
+ *
5228
5404
  * @schema MiseTomlSchemaBootstrapComposeState
5229
5405
  */
5230
5406
  export declare enum MiseTomlSchemaBootstrapComposeState {
@@ -5236,6 +5412,8 @@ export declare enum MiseTomlSchemaBootstrapComposeState {
5236
5412
  ABSENT = "absent"
5237
5413
  }
5238
5414
  /**
5415
+ * image pull policy passed to compose up as --pull
5416
+ *
5239
5417
  * @schema MiseTomlSchemaBootstrapComposePull
5240
5418
  */
5241
5419
  export declare enum MiseTomlSchemaBootstrapComposePull {
@@ -5247,6 +5425,8 @@ export declare enum MiseTomlSchemaBootstrapComposePull {
5247
5425
  NEVER = "never"
5248
5426
  }
5249
5427
  /**
5428
+ * auto lets Compose decide, always passes --build, never passes --no-build
5429
+ *
5250
5430
  * @schema MiseTomlSchemaBootstrapComposeBuild
5251
5431
  */
5252
5432
  export declare enum MiseTomlSchemaBootstrapComposeBuild {
@@ -5258,6 +5438,8 @@ export declare enum MiseTomlSchemaBootstrapComposeBuild {
5258
5438
  NEVER = "never"
5259
5439
  }
5260
5440
  /**
5441
+ * auto lets Compose decide, always passes --force-recreate, never passes --no-recreate
5442
+ *
5261
5443
  * @schema MiseTomlSchemaBootstrapComposeRecreate
5262
5444
  */
5263
5445
  export declare enum MiseTomlSchemaBootstrapComposeRecreate {
@@ -5269,6 +5451,8 @@ export declare enum MiseTomlSchemaBootstrapComposeRecreate {
5269
5451
  NEVER = "never"
5270
5452
  }
5271
5453
  /**
5454
+ * images compose down removes, passed as --rmi
5455
+ *
5272
5456
  * @schema MiseTomlSchemaBootstrapComposeDownImages
5273
5457
  */
5274
5458
  export declare enum MiseTomlSchemaBootstrapComposeDownImages {
@@ -5480,14 +5664,20 @@ export declare function toJson_BootstrapMacosTrackpad(obj: BootstrapMacosTrackpa
5480
5664
  */
5481
5665
  export interface MiseTomlSchemaBootstrapMacosDefaultsEntries {
5482
5666
  /**
5667
+ * preferences domain, such as "com.apple.dock" or "NSGlobalDomain"; -g and -globalDomain mean NSGlobalDomain
5668
+ *
5483
5669
  * @schema MiseTomlSchemaBootstrapMacosDefaultsEntries#domain
5484
5670
  */
5485
5671
  readonly domain: string;
5486
5672
  /**
5673
+ * preference key within the domain
5674
+ *
5487
5675
  * @schema MiseTomlSchemaBootstrapMacosDefaultsEntries#key
5488
5676
  */
5489
5677
  readonly key: string;
5490
5678
  /**
5679
+ * any writes the preference for every host; current writes it for this machine only, like defaults -currentHost
5680
+ *
5491
5681
  * @schema MiseTomlSchemaBootstrapMacosDefaultsEntries#host
5492
5682
  */
5493
5683
  readonly host?: MiseTomlSchemaBootstrapMacosDefaultsEntriesHost;
@@ -5498,6 +5688,8 @@ export interface MiseTomlSchemaBootstrapMacosDefaultsEntries {
5498
5688
  */
5499
5689
  readonly path?: string[];
5500
5690
  /**
5691
+ * desired value, written with the matching property list type; replaces the selected value in full
5692
+ *
5501
5693
  * @schema MiseTomlSchemaBootstrapMacosDefaultsEntries#value
5502
5694
  */
5503
5695
  readonly value: any;
@@ -5626,6 +5818,8 @@ export interface MiseTomlSchemaBootstrapLinuxSystemd {
5626
5818
  */
5627
5819
  export declare function toJson_MiseTomlSchemaBootstrapLinuxSystemd(obj: MiseTomlSchemaBootstrapLinuxSystemd | undefined): Record<string, any> | undefined;
5628
5820
  /**
5821
+ * apt source: a Launchpad PPA, or repository URIs with the key that signs them
5822
+ *
5629
5823
  * @schema BootstrapAptSources
5630
5824
  */
5631
5825
  export interface BootstrapAptSources {
@@ -5678,6 +5872,8 @@ export interface BootstrapAptSources {
5678
5872
  */
5679
5873
  export declare function toJson_BootstrapAptSources(obj: BootstrapAptSources | undefined): Record<string, any> | undefined;
5680
5874
  /**
5875
+ * dnf repository to enable, given as a COPR project
5876
+ *
5681
5877
  * @schema BootstrapDnfRepos
5682
5878
  */
5683
5879
  export interface BootstrapDnfRepos {
@@ -5744,6 +5940,8 @@ export declare enum BootstrapMacosFinderPreferredViewStyle {
5744
5940
  GALLERY = "gallery"
5745
5941
  }
5746
5942
  /**
5943
+ * any writes the preference for every host; current writes it for this machine only, like defaults -currentHost
5944
+ *
5747
5945
  * @schema MiseTomlSchemaBootstrapMacosDefaultsEntriesHost
5748
5946
  */
5749
5947
  export declare enum MiseTomlSchemaBootstrapMacosDefaultsEntriesHost {
@@ -5753,6 +5951,8 @@ export declare enum MiseTomlSchemaBootstrapMacosDefaultsEntriesHost {
5753
5951
  CURRENT = "current"
5754
5952
  }
5755
5953
  /**
5954
+ * macOS LaunchAgent written to ~/Library/LaunchAgents/dev.mise.<name>.plist and loaded for the current user
5955
+ *
5756
5956
  * @schema MiseTomlSchemaBootstrapMacosLaunchdAgents
5757
5957
  */
5758
5958
  export interface MiseTomlSchemaBootstrapMacosLaunchdAgents {
@@ -5925,14 +6125,20 @@ export interface MiseTomlSchemaBootstrapLinuxFirewallRules {
5925
6125
  */
5926
6126
  readonly name: string;
5927
6127
  /**
6128
+ * present adds the rule; absent removes a rule mise added earlier
6129
+ *
5928
6130
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRules#state
5929
6131
  */
5930
6132
  readonly state?: MiseTomlSchemaBootstrapLinuxFirewallRulesState;
5931
6133
  /**
6134
+ * traffic direction the rule matches
6135
+ *
5932
6136
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRules#direction
5933
6137
  */
5934
6138
  readonly direction?: MiseTomlSchemaBootstrapLinuxFirewallRulesDirection;
5935
6139
  /**
6140
+ * what to do with matching traffic; limit needs incoming TCP and is not available on firewalld
6141
+ *
5936
6142
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRules#action
5937
6143
  */
5938
6144
  readonly action?: MiseTomlSchemaBootstrapLinuxFirewallRulesAction;
@@ -5943,6 +6149,8 @@ export interface MiseTomlSchemaBootstrapLinuxFirewallRules {
5943
6149
  */
5944
6150
  readonly port?: MiseTomlSchemaBootstrapLinuxFirewallRulesPort;
5945
6151
  /**
6152
+ * protocol to match; any when unset, and UFW supports only tcp and udp
6153
+ *
5946
6154
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRules#protocol
5947
6155
  */
5948
6156
  readonly protocol?: MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol;
@@ -5971,6 +6179,8 @@ export interface MiseTomlSchemaBootstrapLinuxFirewallRules {
5971
6179
  */
5972
6180
  export declare function toJson_MiseTomlSchemaBootstrapLinuxFirewallRules(obj: MiseTomlSchemaBootstrapLinuxFirewallRules | undefined): Record<string, any> | undefined;
5973
6181
  /**
6182
+ * systemd user unit written to ~/.config/systemd/user/dev.mise.<name>.service, or .timer when it sets a timer key
6183
+ *
5974
6184
  * @schema MiseTomlSchemaBootstrapLinuxSystemdUnits
5975
6185
  */
5976
6186
  export interface MiseTomlSchemaBootstrapLinuxSystemdUnits {
@@ -6238,22 +6448,32 @@ export declare enum MiseTomlSchemaBootstrapMacosLaunchdAgentsProcessType {
6238
6448
  */
6239
6449
  export interface LaunchdCalendarInterval {
6240
6450
  /**
6451
+ * minute of the hour, 0-59; every minute when unset
6452
+ *
6241
6453
  * @schema launchd_calendar_interval#minute
6242
6454
  */
6243
6455
  readonly minute?: number;
6244
6456
  /**
6457
+ * hour of the day, 0-23; every hour when unset
6458
+ *
6245
6459
  * @schema launchd_calendar_interval#hour
6246
6460
  */
6247
6461
  readonly hour?: number;
6248
6462
  /**
6463
+ * day of the month, 1-31; every day when unset
6464
+ *
6249
6465
  * @schema launchd_calendar_interval#day
6250
6466
  */
6251
6467
  readonly day?: number;
6252
6468
  /**
6469
+ * day of the week, 0-7, where 0 and 7 are Sunday; every day when unset
6470
+ *
6253
6471
  * @schema launchd_calendar_interval#weekday
6254
6472
  */
6255
6473
  readonly weekday?: number;
6256
6474
  /**
6475
+ * month of the year, 1-12; every month when unset
6476
+ *
6257
6477
  * @schema launchd_calendar_interval#month
6258
6478
  */
6259
6479
  readonly month?: number;
@@ -6264,6 +6484,8 @@ export interface LaunchdCalendarInterval {
6264
6484
  */
6265
6485
  export declare function toJson_LaunchdCalendarInterval(obj: LaunchdCalendarInterval | undefined): Record<string, any> | undefined;
6266
6486
  /**
6487
+ * present adds the rule; absent removes a rule mise added earlier
6488
+ *
6267
6489
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRulesState
6268
6490
  */
6269
6491
  export declare enum MiseTomlSchemaBootstrapLinuxFirewallRulesState {
@@ -6273,6 +6495,8 @@ export declare enum MiseTomlSchemaBootstrapLinuxFirewallRulesState {
6273
6495
  ABSENT = "absent"
6274
6496
  }
6275
6497
  /**
6498
+ * traffic direction the rule matches
6499
+ *
6276
6500
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRulesDirection
6277
6501
  */
6278
6502
  export declare enum MiseTomlSchemaBootstrapLinuxFirewallRulesDirection {
@@ -6282,6 +6506,8 @@ export declare enum MiseTomlSchemaBootstrapLinuxFirewallRulesDirection {
6282
6506
  OUTGOING = "outgoing"
6283
6507
  }
6284
6508
  /**
6509
+ * what to do with matching traffic; limit needs incoming TCP and is not available on firewalld
6510
+ *
6285
6511
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRulesAction
6286
6512
  */
6287
6513
  export declare enum MiseTomlSchemaBootstrapLinuxFirewallRulesAction {
@@ -6306,6 +6532,8 @@ export declare class MiseTomlSchemaBootstrapLinuxFirewallRulesPort {
6306
6532
  private constructor();
6307
6533
  }
6308
6534
  /**
6535
+ * protocol to match; any when unset, and UFW supports only tcp and udp
6536
+ *
6309
6537
  * @schema MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol
6310
6538
  */
6311
6539
  export declare enum MiseTomlSchemaBootstrapLinuxFirewallRulesProtocol {