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/schemas/mise.json CHANGED
@@ -7,11 +7,9 @@
7
7
  "bootstrap_apt_sources": {
8
8
  "type": "object",
9
9
  "description": "apt repositories added before apt packages are installed, keyed by a name used in the files mise writes",
10
- "propertyNames": {
11
- "pattern": "^[A-Za-z0-9_-][A-Za-z0-9_.-]*$"
12
- },
13
10
  "additionalProperties": {
14
11
  "type": "object",
12
+ "description": "apt source: a Launchpad PPA, or repository URIs with the key that signs them",
15
13
  "additionalProperties": false,
16
14
  "properties": {
17
15
  "ppa": {
@@ -106,36 +104,40 @@
106
104
  }
107
105
  }
108
106
  ]
107
+ },
108
+ "propertyNames": {
109
+ "pattern": "^[A-Za-z0-9_-][A-Za-z0-9_.-]*$"
109
110
  }
110
111
  },
111
112
  "bootstrap_dnf_repos": {
112
113
  "type": "object",
113
114
  "description": "dnf repositories enabled before dnf packages are installed, keyed by a name for the entry",
114
- "propertyNames": {
115
- "pattern": "^[A-Za-z0-9_-][A-Za-z0-9_.-]*$"
116
- },
117
115
  "additionalProperties": {
118
116
  "type": "object",
117
+ "description": "dnf repository to enable, given as a COPR project",
119
118
  "additionalProperties": false,
120
- "required": [
121
- "copr"
122
- ],
123
119
  "properties": {
124
120
  "copr": {
125
121
  "type": "string",
126
122
  "description": "COPR project as owner/project or @group/project, such as scottames/ghostty; enabled as dnf copr enable would"
127
123
  }
128
- }
124
+ },
125
+ "required": [
126
+ "copr"
127
+ ]
128
+ },
129
+ "propertyNames": {
130
+ "pattern": "^[A-Za-z0-9_-][A-Za-z0-9_.-]*$"
129
131
  }
130
132
  },
131
133
  "bootstrap_file_phase": {
132
134
  "type": "string",
135
+ "description": "When to apply the managed path during bootstrap; pre-packages runs before the pre-packages hook",
133
136
  "enum": [
134
137
  "pre-packages",
135
138
  "post-packages"
136
139
  ],
137
- "default": "post-packages",
138
- "description": "When to apply the managed path during bootstrap; pre-packages runs before the pre-packages hook"
140
+ "default": "post-packages"
139
141
  },
140
142
  "bootstrap_hook": {
141
143
  "description": "command or commands to run for a bootstrap phase",
@@ -153,6 +155,7 @@
153
155
  "type": "object",
154
156
  "properties": {
155
157
  "run": {
158
+ "description": "shell command or commands to run in order, with the default inline shell; Tera templates are rendered first",
156
159
  "oneOf": [
157
160
  {
158
161
  "type": "string"
@@ -262,23 +265,24 @@
262
265
  "type": "object",
263
266
  "description": "defaults keys and their desired values for this domain",
264
267
  "additionalProperties": {
265
- "$ref": "#/$defs/macos_defaults_value",
266
- "description": "desired value, written with the matching `defaults write` type; arrays and tables become property list arrays and dictionaries"
268
+ "description": "desired value, written with the matching `defaults write` type; arrays and tables become property list arrays and dictionaries",
269
+ "$ref": "#/$defs/macos_defaults_value"
267
270
  }
268
271
  }
269
272
  },
270
273
  "bootstrap_macos_dock": {
271
274
  "type": "object",
272
275
  "description": "curated Dock preferences that compile into macOS defaults",
276
+ "additionalProperties": false,
273
277
  "properties": {
274
278
  "apps": {
275
279
  "type": "array",
280
+ "description": "Pinned application paths in order; absolute or ~/ paths ending in .app. An empty array removes application tiles.",
276
281
  "items": {
277
282
  "type": "string",
278
283
  "pattern": "^(?:/|~/(?!/)).+\\.[aA][pP][pP]/*$"
279
284
  },
280
- "uniqueItems": true,
281
- "description": "Pinned application paths in order; absolute or ~/ paths ending in .app. An empty array removes application tiles."
285
+ "uniqueItems": true
282
286
  },
283
287
  "autohide_delay": {
284
288
  "type": "number",
@@ -294,12 +298,12 @@
294
298
  },
295
299
  "orientation": {
296
300
  "type": "string",
301
+ "description": "Dock screen edge",
297
302
  "enum": [
298
303
  "bottom",
299
304
  "left",
300
305
  "right"
301
- ],
302
- "description": "Dock screen edge"
306
+ ]
303
307
  },
304
308
  "tilesize": {
305
309
  "type": "integer",
@@ -321,12 +325,12 @@
321
325
  "type": "boolean",
322
326
  "description": "automatically rearrange Spaces based on most recent use"
323
327
  }
324
- },
325
- "additionalProperties": false
328
+ }
326
329
  },
327
330
  "bootstrap_macos_finder": {
328
331
  "type": "object",
329
332
  "description": "curated Finder preferences that compile into macOS defaults",
333
+ "additionalProperties": false,
330
334
  "properties": {
331
335
  "sort_folders_first": {
332
336
  "type": "boolean",
@@ -354,20 +358,20 @@
354
358
  },
355
359
  "preferred_view_style": {
356
360
  "type": "string",
361
+ "description": "Finder preferred view style",
357
362
  "enum": [
358
363
  "icon",
359
364
  "list",
360
365
  "column",
361
366
  "gallery"
362
- ],
363
- "description": "Finder preferred view style"
367
+ ]
364
368
  }
365
- },
366
- "additionalProperties": false
369
+ }
367
370
  },
368
371
  "bootstrap_macos_keyboard": {
369
372
  "type": "object",
370
373
  "description": "curated keyboard preferences that compile into macOS defaults",
374
+ "additionalProperties": false,
371
375
  "properties": {
372
376
  "automatic_capitalization": {
373
377
  "type": "boolean",
@@ -393,12 +397,12 @@
393
397
  "type": "boolean",
394
398
  "description": "use F1, F2, etc. as standard function keys"
395
399
  }
396
- },
397
- "additionalProperties": false
400
+ }
398
401
  },
399
402
  "bootstrap_macos_trackpad": {
400
403
  "type": "object",
401
404
  "description": "curated trackpad preferences that compile into macOS defaults",
405
+ "additionalProperties": false,
402
406
  "properties": {
403
407
  "tap_to_click": {
404
408
  "type": "boolean",
@@ -408,39 +412,46 @@
408
412
  "type": "boolean",
409
413
  "description": "enable three finger drag for built-in and Bluetooth trackpads"
410
414
  }
411
- },
412
- "additionalProperties": false
415
+ }
413
416
  },
414
417
  "bootstrap_mise_shell_activate": {
415
418
  "type": "object",
416
419
  "description": "declarative mise shell activation snippets, applied with `mise bootstrap mise-shell-activate apply`",
420
+ "additionalProperties": false,
417
421
  "properties": {
418
422
  "bash": {
423
+ "description": "manage the activation blocks in ~/.bash_profile (shims) and ~/.bashrc (activate); a mode applies to both files",
419
424
  "$ref": "#/$defs/bootstrap_shell_activation"
420
425
  },
421
426
  "zsh": {
427
+ "description": "manage the activation blocks in ~/.zprofile (shims) and ~/.zshrc (activate); a mode applies to both files, and ~/.zshenv is never written",
422
428
  "$ref": "#/$defs/bootstrap_shell_activation"
423
429
  },
424
430
  "fish": {
431
+ "description": "manage the activation block in ~/.config/fish/config.fish; activate by default, and auto activates interactive shells and uses shims otherwise",
425
432
  "$ref": "#/$defs/bootstrap_shell_activation"
426
433
  },
427
434
  "bash_profile": {
435
+ "description": "manage the activation block in ~/.bash_profile; shims by default",
428
436
  "$ref": "#/$defs/bootstrap_shell_activation"
429
437
  },
430
438
  "bashrc": {
439
+ "description": "manage the activation block in ~/.bashrc; activate by default",
431
440
  "$ref": "#/$defs/bootstrap_shell_activation"
432
441
  },
433
442
  "zshenv": {
443
+ "description": "manage the activation block in ~/.zshenv, which zsh reads for every script; shims by default",
434
444
  "$ref": "#/$defs/bootstrap_shell_activation"
435
445
  },
436
446
  "zprofile": {
447
+ "description": "manage the activation block in ~/.zprofile; shims by default",
437
448
  "$ref": "#/$defs/bootstrap_shell_activation"
438
449
  },
439
450
  "zshrc": {
451
+ "description": "manage the activation block in ~/.zshrc; activate by default",
440
452
  "$ref": "#/$defs/bootstrap_shell_activation"
441
453
  }
442
- },
443
- "additionalProperties": false
454
+ }
444
455
  },
445
456
  "bootstrap_remote_install_mise": {
446
457
  "oneOf": [
@@ -462,16 +473,17 @@
462
473
  },
463
474
  {
464
475
  "type": "string",
476
+ "description": "enable the target with the selected activation mode",
465
477
  "enum": [
466
478
  "activate",
467
479
  "shims",
468
480
  "auto"
469
- ],
470
- "description": "enable the target with the selected activation mode"
481
+ ]
471
482
  },
472
483
  {
473
484
  "type": "object",
474
485
  "description": "shell activation settings for the target",
486
+ "additionalProperties": false,
475
487
  "properties": {
476
488
  "enabled": {
477
489
  "type": "boolean",
@@ -479,18 +491,17 @@
479
491
  },
480
492
  "mode": {
481
493
  "type": "string",
494
+ "description": "activation mode; defaults according to the target",
482
495
  "enum": [
483
496
  "activate",
484
497
  "shims",
485
498
  "auto"
486
- ],
487
- "description": "activation mode; defaults according to the target"
499
+ ]
488
500
  }
489
501
  },
490
502
  "required": [
491
503
  "enabled"
492
- ],
493
- "additionalProperties": false
504
+ ]
494
505
  }
495
506
  ]
496
507
  },
@@ -513,38 +524,38 @@
513
524
  "oneOf": [
514
525
  {
515
526
  "type": "integer",
516
- "minimum": 1,
517
- "maximum": 65535
527
+ "maximum": 65535,
528
+ "minimum": 1
518
529
  },
519
530
  {
520
531
  "type": "string",
521
- "const": "auto",
522
- "description": "Offset the preset's default port by this project root's worktree slot."
532
+ "description": "Offset the preset's default port by this project root's worktree slot.",
533
+ "const": "auto"
523
534
  },
524
535
  {
525
536
  "type": "object",
526
- "required": [
527
- "auto"
528
- ],
537
+ "additionalProperties": false,
529
538
  "properties": {
530
539
  "auto": {
531
- "const": true,
532
- "description": "Enable per-worktree port allocation."
540
+ "description": "Enable per-worktree port allocation.",
541
+ "const": true
533
542
  },
534
543
  "base": {
535
544
  "type": "integer",
545
+ "description": "Port used by the primary checkout. Defaults to the preset's port; required for custom daemons.",
536
546
  "minimum": 1,
537
- "maximum": 65535,
538
- "description": "Port used by the primary checkout. Defaults to the preset's port; required for custom daemons."
547
+ "maximum": 65535
539
548
  },
540
549
  "stride": {
541
550
  "type": "integer",
551
+ "description": "Distance between consecutive worktree slots. Defaults to 1.",
542
552
  "minimum": 1,
543
- "maximum": 65535,
544
- "description": "Distance between consecutive worktree slots. Defaults to 1."
553
+ "maximum": 65535
545
554
  }
546
555
  },
547
- "additionalProperties": false
556
+ "required": [
557
+ "auto"
558
+ ]
548
559
  }
549
560
  ]
550
561
  },
@@ -553,8 +564,8 @@
553
564
  "oneOf": [
554
565
  {
555
566
  "type": "string",
556
- "pattern": "^[a-z0-9]([a-z0-9-]*[a-z0-9])?$",
557
- "maxLength": 63
567
+ "maxLength": 63,
568
+ "pattern": "^[a-z0-9]([a-z0-9-]*[a-z0-9])?$"
558
569
  },
559
570
  {
560
571
  "type": "boolean",
@@ -578,8 +589,8 @@
578
589
  ]
579
590
  },
580
591
  "daemon_proxy_tls": {
581
- "description": "Whether the proxy terminates TLS for this daemon or passes the connection through to it.",
582
592
  "type": "string",
593
+ "description": "Whether the proxy terminates TLS for this daemon or passes the connection through to it.",
583
594
  "enum": [
584
595
  "terminate",
585
596
  "passthrough"
@@ -587,36 +598,38 @@
587
598
  },
588
599
  "deps_provider": {
589
600
  "type": "object",
601
+ "description": "Prepare provider configuration",
590
602
  "properties": {
591
603
  "auto": {
592
604
  "type": "boolean",
593
- "default": false,
594
- "description": "Auto-run before `mise x` and `mise run`"
605
+ "description": "Auto-run before `mise x` and `mise run`",
606
+ "default": false
607
+ },
608
+ "run": {
609
+ "type": "string",
610
+ "description": "Command to run when stale"
595
611
  },
596
612
  "sources": {
597
613
  "type": "array",
614
+ "description": "Files/patterns to check for changes",
598
615
  "items": {
599
616
  "type": "string"
600
- },
601
- "description": "Files/patterns to check for changes"
617
+ }
602
618
  },
603
619
  "outputs": {
604
620
  "type": "array",
621
+ "description": "Files/directories that should be newer than sources",
605
622
  "items": {
606
623
  "type": "string"
607
- },
608
- "description": "Files/directories that should be newer than sources"
609
- },
610
- "run": {
611
- "type": "string",
612
- "description": "Command to run when stale"
624
+ }
613
625
  },
614
626
  "env": {
615
627
  "type": "object",
628
+ "description": "Environment variables to set",
616
629
  "additionalProperties": {
617
- "type": "string"
618
- },
619
- "description": "Environment variables to set"
630
+ "type": "string",
631
+ "description": "value of this environment variable"
632
+ }
620
633
  },
621
634
  "dir": {
622
635
  "type": "string",
@@ -628,18 +641,17 @@
628
641
  },
629
642
  "depends": {
630
643
  "type": "array",
644
+ "description": "Other deps providers that must complete before this one runs",
631
645
  "items": {
632
646
  "type": "string"
633
- },
634
- "description": "Other deps providers that must complete before this one runs"
647
+ }
635
648
  },
636
649
  "timeout": {
637
650
  "type": "string",
638
651
  "description": "Timeout for the run command (e.g., \"30s\", \"5m\", \"1h\")"
639
652
  }
640
653
  },
641
- "unevaluatedProperties": false,
642
- "description": "Prepare provider configuration"
654
+ "unevaluatedProperties": false
643
655
  },
644
656
  "doctor": {
645
657
  "type": "object",
@@ -647,8 +659,10 @@
647
659
  "properties": {
648
660
  "checks": {
649
661
  "type": "object",
662
+ "description": "Checks run by mise doctor project, keyed by check name.",
650
663
  "additionalProperties": {
651
664
  "type": "object",
665
+ "description": "A check: a command that passes when it exits zero.",
652
666
  "additionalProperties": false,
653
667
  "properties": {
654
668
  "run": {
@@ -694,160 +708,31 @@
694
708
  "additionalProperties": true
695
709
  },
696
710
  "env": {
697
- "additionalProperties": {
698
- "description": "an environment variable: its value, or a table with `value`, `default`, `required` or `age`",
699
- "oneOf": [
700
- {
701
- "type": "object",
702
- "properties": {
703
- "value": {
704
- "$ref": "#/$defs/env_value"
705
- },
706
- "tools": {
707
- "$ref": "#/$defs/env_tools"
708
- },
709
- "redact": {
710
- "$ref": "#/$defs/env_redact"
711
- },
712
- "required": {
713
- "const": false,
714
- "description": "a variable with its own value cannot be required; only `required = false` is accepted"
715
- }
716
- },
717
- "required": [
718
- "value"
719
- ],
720
- "unevaluatedProperties": false
721
- },
722
- {
723
- "type": "object",
724
- "properties": {
725
- "default": {
726
- "$ref": "#/$defs/env_default"
727
- },
728
- "tools": {
729
- "$ref": "#/$defs/env_tools"
730
- },
731
- "redact": {
732
- "$ref": "#/$defs/env_redact"
733
- }
734
- },
735
- "required": [
736
- "default"
737
- ],
738
- "unevaluatedProperties": false
739
- },
740
- {
741
- "type": "object",
742
- "properties": {
743
- "tools": {
744
- "$ref": "#/$defs/env_tools"
745
- },
746
- "redact": {
747
- "$ref": "#/$defs/env_redact"
748
- },
749
- "required": {
750
- "oneOf": [
751
- {
752
- "const": true
753
- },
754
- {
755
- "type": "string"
756
- }
757
- ],
758
- "description": "a variable without a value must be required: `true` or help text on how to set it"
759
- }
760
- },
761
- "required": [
762
- "required"
763
- ],
764
- "unevaluatedProperties": false
765
- },
766
- {
767
- "type": "object",
768
- "properties": {
769
- "age": {
770
- "$ref": "#/$defs/env_age"
771
- },
772
- "tools": {
773
- "$ref": "#/$defs/env_tools"
774
- },
775
- "redact": {
776
- "$ref": "#/$defs/env_redact"
777
- },
778
- "required": {
779
- "$ref": "#/$defs/env_required"
780
- }
781
- },
782
- "required": [
783
- "age"
784
- ],
785
- "unevaluatedProperties": false,
786
- "description": "[experimental] age-encrypted environment variable"
787
- },
788
- {
789
- "type": "object",
790
- "properties": {
791
- "age": {
792
- "type": "object",
793
- "properties": {
794
- "value": {
795
- "$ref": "#/$defs/env_age_value"
796
- },
797
- "format": {
798
- "$ref": "#/$defs/env_age_format"
799
- },
800
- "tools": {
801
- "$ref": "#/$defs/env_tools"
802
- },
803
- "redact": {
804
- "$ref": "#/$defs/env_redact"
805
- },
806
- "required": {
807
- "$ref": "#/$defs/env_required"
808
- }
809
- },
810
- "required": [
811
- "value"
812
- ],
813
- "unevaluatedProperties": false,
814
- "description": "[experimental] age-encrypted value (complex format)"
815
- }
816
- },
817
- "required": [
818
- "age"
819
- ],
820
- "unevaluatedProperties": false,
821
- "description": "[experimental] age-encrypted environment variable"
822
- },
823
- {
824
- "$ref": "#/$defs/env_value"
825
- }
826
- ]
827
- },
711
+ "type": "object",
828
712
  "description": "environment variables",
829
713
  "properties": {
830
714
  "_": {
715
+ "type": "object",
831
716
  "description": "environment modules",
832
- "additionalProperties": true,
833
717
  "properties": {
834
718
  "file": {
719
+ "description": "files to load variables from (dotenv, json, yaml, or toml)",
835
720
  "oneOf": [
836
721
  {
837
722
  "$ref": "#/$defs/env_directive"
838
723
  },
839
724
  {
840
- "description": "environment file to load (dotenv, json, yaml, or toml)",
841
- "type": "string"
725
+ "type": "string",
726
+ "description": "environment file to load (dotenv, json, yaml, or toml)"
842
727
  },
843
728
  {
844
- "description": "environment files to load (dotenv, json, yaml, or toml)",
845
729
  "type": "array",
730
+ "description": "environment files to load (dotenv, json, yaml, or toml)",
846
731
  "items": {
847
732
  "oneOf": [
848
733
  {
849
- "description": "environment file to load (dotenv, json, yaml, or toml)",
850
- "type": "string"
734
+ "type": "string",
735
+ "description": "environment file to load (dotenv, json, yaml, or toml)"
851
736
  },
852
737
  {
853
738
  "$ref": "#/$defs/env_directive"
@@ -858,14 +743,17 @@
858
743
  ]
859
744
  },
860
745
  "path": {
746
+ "description": "directories to add to the front of PATH",
861
747
  "oneOf": [
862
748
  {
863
749
  "type": "object",
864
750
  "properties": {
865
751
  "path": {
752
+ "description": "directory to add to PATH, or a list of them",
866
753
  "$ref": "#/$defs/env_path"
867
754
  },
868
755
  "paths": {
756
+ "description": "directories to add to PATH",
869
757
  "$ref": "#/$defs/env_paths"
870
758
  },
871
759
  "tools": {
@@ -875,45 +763,46 @@
875
763
  "oneOf": [
876
764
  {
877
765
  "type": "object",
766
+ "required": [
767
+ "path"
768
+ ],
878
769
  "properties": {
879
770
  "path": {
880
771
  "$ref": "#/$defs/env_path"
881
772
  }
882
- },
883
- "required": [
884
- "path"
885
- ]
773
+ }
886
774
  },
887
775
  {
888
776
  "type": "object",
777
+ "required": [
778
+ "paths"
779
+ ],
889
780
  "properties": {
890
781
  "paths": {
891
782
  "$ref": "#/$defs/env_paths"
892
783
  }
893
- },
894
- "required": [
895
- "paths"
896
- ]
784
+ }
897
785
  }
898
786
  ]
899
787
  },
900
788
  {
901
- "description": "PATH entry to add",
902
- "type": "string"
789
+ "type": "string",
790
+ "description": "PATH entry to add"
903
791
  },
904
792
  {
905
- "description": "PATH entries to add",
906
793
  "type": "array",
794
+ "description": "PATH entries to add",
907
795
  "items": {
908
796
  "oneOf": [
909
797
  {
910
- "description": "PATH entry to add",
911
- "type": "string"
798
+ "type": "string",
799
+ "description": "PATH entry to add"
912
800
  },
913
801
  {
914
802
  "type": "object",
915
803
  "properties": {
916
804
  "path": {
805
+ "description": "directory to add to PATH, or a list of them",
917
806
  "$ref": "#/$defs/env_path"
918
807
  },
919
808
  "tools": {
@@ -927,40 +816,45 @@
927
816
  ]
928
817
  },
929
818
  "python": {
819
+ "type": "object",
930
820
  "description": "python environment",
821
+ "additionalProperties": false,
931
822
  "properties": {
932
823
  "venv": {
824
+ "description": "python virtual environment to activate",
933
825
  "oneOf": [
934
826
  {
935
- "description": "path to python virtual environment to use",
936
- "type": "string"
827
+ "type": "string",
828
+ "description": "path to python virtual environment to use"
937
829
  },
938
830
  {
831
+ "type": "object",
939
832
  "description": "virtualenv options",
833
+ "additionalProperties": false,
940
834
  "properties": {
941
835
  "create": {
942
- "default": false,
836
+ "type": "boolean",
943
837
  "description": "create a new virtual environment if one does not exist",
944
- "type": "boolean"
838
+ "default": false
945
839
  },
946
840
  "path": {
947
- "description": "path to python virtual environment to use",
948
- "type": "string"
841
+ "type": "string",
842
+ "description": "path to python virtual environment to use"
949
843
  },
950
844
  "python": {
951
- "description": "python version to use",
952
- "type": "string"
845
+ "type": "string",
846
+ "description": "python version to use"
953
847
  },
954
848
  "python_create_args": {
955
- "description": "additional arguments to pass to python when creating a virtual environment",
956
849
  "type": "array",
850
+ "description": "additional arguments to pass to python when creating a virtual environment",
957
851
  "items": {
958
852
  "type": "string"
959
853
  }
960
854
  },
961
855
  "uv_create_args": {
962
- "description": "additional arguments to pass to uv when creating a virtual environment",
963
856
  "type": "array",
857
+ "description": "additional arguments to pass to uv when creating a virtual environment",
964
858
  "items": {
965
859
  "type": "string"
966
860
  }
@@ -968,47 +862,174 @@
968
862
  },
969
863
  "required": [
970
864
  "path"
971
- ],
972
- "additionalProperties": false,
973
- "type": "object"
865
+ ]
974
866
  }
975
867
  ]
976
868
  }
977
- },
978
- "additionalProperties": false,
979
- "type": "object"
869
+ }
980
870
  },
981
871
  "source": {
872
+ "description": "bash scripts to run, taking the variables they export",
982
873
  "oneOf": [
983
874
  {
984
875
  "$ref": "#/$defs/env_directive"
985
876
  },
986
877
  {
987
- "description": "bash script to load",
988
- "type": "string"
878
+ "type": "string",
879
+ "description": "bash script to load"
989
880
  },
990
881
  {
991
- "description": "bash scripts to load",
992
882
  "type": "array",
883
+ "description": "bash scripts to load",
993
884
  "items": {
994
885
  "oneOf": [
995
886
  {
996
- "description": "bash script to load",
997
- "type": "string"
887
+ "type": "string",
888
+ "description": "bash script to load"
998
889
  },
999
890
  {
1000
891
  "$ref": "#/$defs/env_directive"
1001
892
  }
1002
893
  ]
1003
894
  }
1004
- }
1005
- ]
1006
- }
895
+ }
896
+ ]
897
+ }
898
+ },
899
+ "additionalProperties": true
900
+ }
901
+ },
902
+ "additionalProperties": {
903
+ "description": "an environment variable: its value, or a table with `value`, `default`, `required` or `age`",
904
+ "oneOf": [
905
+ {
906
+ "type": "object",
907
+ "required": [
908
+ "value"
909
+ ],
910
+ "properties": {
911
+ "value": {
912
+ "$ref": "#/$defs/env_value"
913
+ },
914
+ "tools": {
915
+ "$ref": "#/$defs/env_tools"
916
+ },
917
+ "redact": {
918
+ "$ref": "#/$defs/env_redact"
919
+ },
920
+ "required": {
921
+ "description": "a variable with its own value cannot be required; only `required = false` is accepted",
922
+ "const": false
923
+ }
924
+ },
925
+ "unevaluatedProperties": false
926
+ },
927
+ {
928
+ "type": "object",
929
+ "required": [
930
+ "default"
931
+ ],
932
+ "properties": {
933
+ "default": {
934
+ "$ref": "#/$defs/env_default"
935
+ },
936
+ "tools": {
937
+ "$ref": "#/$defs/env_tools"
938
+ },
939
+ "redact": {
940
+ "$ref": "#/$defs/env_redact"
941
+ }
942
+ },
943
+ "unevaluatedProperties": false
944
+ },
945
+ {
946
+ "type": "object",
947
+ "required": [
948
+ "required"
949
+ ],
950
+ "properties": {
951
+ "tools": {
952
+ "$ref": "#/$defs/env_tools"
953
+ },
954
+ "redact": {
955
+ "$ref": "#/$defs/env_redact"
956
+ },
957
+ "required": {
958
+ "description": "a variable without a value must be required: `true` or help text on how to set it",
959
+ "oneOf": [
960
+ {
961
+ "const": true
962
+ },
963
+ {
964
+ "type": "string"
965
+ }
966
+ ]
967
+ }
968
+ },
969
+ "unevaluatedProperties": false
970
+ },
971
+ {
972
+ "type": "object",
973
+ "description": "[experimental] age-encrypted environment variable",
974
+ "required": [
975
+ "age"
976
+ ],
977
+ "properties": {
978
+ "age": {
979
+ "$ref": "#/$defs/env_age"
980
+ },
981
+ "tools": {
982
+ "$ref": "#/$defs/env_tools"
983
+ },
984
+ "redact": {
985
+ "$ref": "#/$defs/env_redact"
986
+ },
987
+ "required": {
988
+ "$ref": "#/$defs/env_required"
989
+ }
990
+ },
991
+ "unevaluatedProperties": false
992
+ },
993
+ {
994
+ "type": "object",
995
+ "description": "[experimental] age-encrypted environment variable",
996
+ "required": [
997
+ "age"
998
+ ],
999
+ "properties": {
1000
+ "age": {
1001
+ "type": "object",
1002
+ "description": "[experimental] age-encrypted value (complex format)",
1003
+ "properties": {
1004
+ "value": {
1005
+ "$ref": "#/$defs/env_age_value"
1006
+ },
1007
+ "format": {
1008
+ "$ref": "#/$defs/env_age_format"
1009
+ },
1010
+ "tools": {
1011
+ "$ref": "#/$defs/env_tools"
1012
+ },
1013
+ "redact": {
1014
+ "$ref": "#/$defs/env_redact"
1015
+ },
1016
+ "required": {
1017
+ "$ref": "#/$defs/env_required"
1018
+ }
1019
+ },
1020
+ "required": [
1021
+ "value"
1022
+ ],
1023
+ "unevaluatedProperties": false
1024
+ }
1025
+ },
1026
+ "unevaluatedProperties": false
1007
1027
  },
1008
- "type": "object"
1009
- }
1010
- },
1011
- "type": "object"
1028
+ {
1029
+ "$ref": "#/$defs/env_value"
1030
+ }
1031
+ ]
1032
+ }
1012
1033
  },
1013
1034
  "env_age": {
1014
1035
  "type": "string",
@@ -1016,17 +1037,18 @@
1016
1037
  },
1017
1038
  "env_age_format": {
1018
1039
  "type": "string",
1040
+ "description": "[experimental] compression format for the encrypted value",
1019
1041
  "enum": [
1020
1042
  "raw",
1021
1043
  "zstd"
1022
- ],
1023
- "description": "[experimental] compression format for the encrypted value"
1044
+ ]
1024
1045
  },
1025
1046
  "env_age_value": {
1026
1047
  "type": "string",
1027
1048
  "description": "[experimental] age-encrypted value"
1028
1049
  },
1029
1050
  "env_default": {
1051
+ "description": "fallback value to use when the environment variable is unset or empty",
1030
1052
  "oneOf": [
1031
1053
  {
1032
1054
  "type": "string",
@@ -1036,16 +1058,17 @@
1036
1058
  "type": "integer",
1037
1059
  "description": "fallback value to use when the environment variable is unset or empty"
1038
1060
  }
1039
- ],
1040
- "description": "fallback value to use when the environment variable is unset or empty"
1061
+ ]
1041
1062
  },
1042
1063
  "env_directive": {
1043
1064
  "type": "object",
1044
1065
  "properties": {
1045
1066
  "path": {
1067
+ "description": "file to load, or a list of them; may be a glob pattern",
1046
1068
  "$ref": "#/$defs/env_path"
1047
1069
  },
1048
1070
  "paths": {
1071
+ "description": "files to load; each may be a glob pattern",
1049
1072
  "$ref": "#/$defs/env_paths"
1050
1073
  },
1051
1074
  "tools": {
@@ -1067,37 +1090,37 @@
1067
1090
  "oneOf": [
1068
1091
  {
1069
1092
  "type": "object",
1093
+ "required": [
1094
+ "path"
1095
+ ],
1070
1096
  "properties": {
1071
1097
  "path": {
1072
1098
  "$ref": "#/$defs/env_path"
1073
1099
  }
1074
- },
1075
- "required": [
1076
- "path"
1077
- ]
1100
+ }
1078
1101
  },
1079
1102
  {
1080
1103
  "type": "object",
1104
+ "required": [
1105
+ "paths"
1106
+ ],
1081
1107
  "properties": {
1082
1108
  "paths": {
1083
1109
  "$ref": "#/$defs/env_paths"
1084
1110
  }
1085
- },
1086
- "required": [
1087
- "paths"
1088
- ]
1111
+ }
1089
1112
  }
1090
1113
  ]
1091
1114
  },
1092
1115
  "env_file_expand": {
1093
1116
  "type": "boolean",
1094
- "default": false,
1095
- "description": "enable shell-style variable expansion for values loaded by env._.file"
1117
+ "description": "enable shell-style variable expansion for values loaded by env._.file",
1118
+ "default": false
1096
1119
  },
1097
1120
  "env_file_find_up": {
1098
1121
  "type": "boolean",
1099
- "default": false,
1100
- "description": "look for a relative env._.file path in the current directory and each parent directory"
1122
+ "description": "look for a relative env._.file path in the current directory and each parent directory",
1123
+ "default": false
1101
1124
  },
1102
1125
  "env_path": {
1103
1126
  "oneOf": [
@@ -1123,6 +1146,7 @@
1123
1146
  "description": "redact the value from logs"
1124
1147
  },
1125
1148
  "env_required": {
1149
+ "description": "require this environment variable to be defined before mise runs or in a later config file. Can be a boolean or a help string. A variable that carries its own `value` cannot also be `required = true`.",
1126
1150
  "oneOf": [
1127
1151
  {
1128
1152
  "type": "boolean",
@@ -1132,8 +1156,7 @@
1132
1156
  "type": "string",
1133
1157
  "description": "require this environment variable with user help text on how to set it"
1134
1158
  }
1135
- ],
1136
- "description": "require this environment variable to be defined before mise runs or in a later config file. Can be a boolean or a help string. A variable that carries its own `value` cannot also be `required = true`."
1159
+ ]
1137
1160
  },
1138
1161
  "env_tools": {
1139
1162
  "type": "boolean",
@@ -1154,40 +1177,40 @@
1154
1177
  ]
1155
1178
  },
1156
1179
  "hook_current_shell_script_table": {
1157
- "unevaluatedProperties": false,
1180
+ "type": "object",
1181
+ "required": [
1182
+ "script",
1183
+ "shell"
1184
+ ],
1158
1185
  "properties": {
1159
1186
  "script": {
1160
1187
  "description": "script or scripts to evaluate in the active shell for enter/leave/cd hooks",
1161
1188
  "$ref": "#/$defs/hook_script_value"
1162
1189
  },
1163
1190
  "shell": {
1164
- "description": "active shell name for current-shell hooks, such as \"bash\"",
1165
- "type": "string"
1191
+ "type": "string",
1192
+ "description": "active shell name for current-shell hooks, such as \"bash\""
1166
1193
  }
1167
1194
  },
1195
+ "unevaluatedProperties": false
1196
+ },
1197
+ "hook_current_shell_scripts_table": {
1198
+ "type": "object",
1168
1199
  "required": [
1169
- "script",
1200
+ "scripts",
1170
1201
  "shell"
1171
1202
  ],
1172
- "type": "object"
1173
- },
1174
- "hook_current_shell_scripts_table": {
1175
- "unevaluatedProperties": false,
1176
1203
  "properties": {
1177
1204
  "scripts": {
1178
1205
  "description": "scripts to evaluate in the active shell for enter/leave/cd hooks",
1179
1206
  "$ref": "#/$defs/hook_scripts_value"
1180
1207
  },
1181
1208
  "shell": {
1182
- "description": "active shell name for current-shell hooks, such as \"bash\"",
1183
- "type": "string"
1209
+ "type": "string",
1210
+ "description": "active shell name for current-shell hooks, such as \"bash\""
1184
1211
  }
1185
1212
  },
1186
- "required": [
1187
- "scripts",
1188
- "shell"
1189
- ],
1190
- "type": "object"
1213
+ "unevaluatedProperties": false
1191
1214
  },
1192
1215
  "hook_definition": {
1193
1216
  "oneOf": [
@@ -1195,11 +1218,11 @@
1195
1218
  "$ref": "#/$defs/hook_definition_item"
1196
1219
  },
1197
1220
  {
1221
+ "type": "array",
1198
1222
  "description": "scripts/tasks to run",
1199
1223
  "items": {
1200
1224
  "$ref": "#/$defs/hook_definition_item"
1201
- },
1202
- "type": "array"
1225
+ }
1203
1226
  }
1204
1227
  ]
1205
1228
  },
@@ -1234,11 +1257,11 @@
1234
1257
  "$ref": "#/$defs/hook_install_definition_item"
1235
1258
  },
1236
1259
  {
1260
+ "type": "array",
1237
1261
  "description": "install hooks to run",
1238
1262
  "items": {
1239
1263
  "$ref": "#/$defs/hook_install_definition_item"
1240
- },
1241
- "type": "array"
1264
+ }
1242
1265
  }
1243
1266
  ]
1244
1267
  },
@@ -1262,65 +1285,51 @@
1262
1285
  ]
1263
1286
  },
1264
1287
  "hook_install_script_table": {
1288
+ "type": "object",
1265
1289
  "deprecated": true,
1266
- "unevaluatedProperties": false,
1267
1290
  "properties": {
1268
1291
  "script": {
1269
- "deprecated": true,
1270
1292
  "description": "deprecated alias for run in preinstall/postinstall hooks; executes in a subprocess",
1271
- "$ref": "#/$defs/hook_script_value"
1293
+ "$ref": "#/$defs/hook_script_value",
1294
+ "deprecated": true
1272
1295
  },
1273
1296
  "shell": {
1274
- "deprecated": true,
1297
+ "type": "string",
1275
1298
  "description": "ignored for preinstall/postinstall hooks that use script; use a run hook to select an inline shell",
1276
- "type": "string"
1299
+ "deprecated": true
1277
1300
  }
1278
1301
  },
1279
1302
  "required": [
1280
1303
  "script"
1281
1304
  ],
1282
- "type": "object"
1305
+ "unevaluatedProperties": false
1283
1306
  },
1284
1307
  "hook_install_scripts_table": {
1308
+ "type": "object",
1285
1309
  "deprecated": true,
1286
- "unevaluatedProperties": false,
1287
1310
  "properties": {
1288
1311
  "scripts": {
1289
- "deprecated": true,
1290
1312
  "description": "deprecated alias for run in preinstall/postinstall hooks; joins the scripts and executes them in a subprocess",
1291
- "$ref": "#/$defs/hook_scripts_value"
1313
+ "$ref": "#/$defs/hook_scripts_value",
1314
+ "deprecated": true
1292
1315
  },
1293
1316
  "shell": {
1294
- "deprecated": true,
1317
+ "type": "string",
1295
1318
  "description": "ignored for preinstall/postinstall hooks that use scripts; use a run hook to select an inline shell",
1296
- "type": "string"
1319
+ "deprecated": true
1297
1320
  }
1298
1321
  },
1299
1322
  "required": [
1300
1323
  "scripts"
1301
1324
  ],
1302
- "type": "object"
1325
+ "unevaluatedProperties": false
1303
1326
  },
1304
1327
  "hook_run_string": {
1305
- "description": "inline hook command to run",
1306
- "type": "string"
1328
+ "type": "string",
1329
+ "description": "inline hook command to run"
1307
1330
  },
1308
1331
  "hook_run_table": {
1309
- "unevaluatedProperties": false,
1310
- "properties": {
1311
- "run": {
1312
- "description": "inline hook command to run",
1313
- "type": "string"
1314
- },
1315
- "run_windows": {
1316
- "description": "inline hook command to run on Windows",
1317
- "type": "string"
1318
- },
1319
- "shell": {
1320
- "description": "inline shell command to use for run hooks, such as \"bash -c\"",
1321
- "type": "string"
1322
- }
1323
- },
1332
+ "type": "object",
1324
1333
  "anyOf": [
1325
1334
  {
1326
1335
  "required": [
@@ -1333,7 +1342,21 @@
1333
1342
  ]
1334
1343
  }
1335
1344
  ],
1336
- "type": "object"
1345
+ "properties": {
1346
+ "run": {
1347
+ "type": "string",
1348
+ "description": "inline hook command to run"
1349
+ },
1350
+ "run_windows": {
1351
+ "type": "string",
1352
+ "description": "inline hook command to run on Windows"
1353
+ },
1354
+ "shell": {
1355
+ "type": "string",
1356
+ "description": "inline shell command to use for run hooks, such as \"bash -c\""
1357
+ }
1358
+ },
1359
+ "unevaluatedProperties": false
1337
1360
  },
1338
1361
  "hook_script_value": {
1339
1362
  "oneOf": [
@@ -1355,69 +1378,74 @@
1355
1378
  }
1356
1379
  },
1357
1380
  "hook_spawned_script_table": {
1381
+ "type": "object",
1358
1382
  "deprecated": true,
1359
- "unevaluatedProperties": false,
1360
1383
  "properties": {
1361
1384
  "script": {
1362
- "deprecated": true,
1363
1385
  "description": "deprecated alias for run when an enter/leave/cd hook has no shell",
1364
- "$ref": "#/$defs/hook_script_value"
1386
+ "$ref": "#/$defs/hook_script_value",
1387
+ "deprecated": true
1365
1388
  }
1366
1389
  },
1367
1390
  "required": [
1368
1391
  "script"
1369
1392
  ],
1370
- "type": "object"
1393
+ "unevaluatedProperties": false
1371
1394
  },
1372
1395
  "hook_spawned_scripts_table": {
1396
+ "type": "object",
1373
1397
  "deprecated": true,
1374
- "unevaluatedProperties": false,
1375
1398
  "properties": {
1376
1399
  "scripts": {
1377
- "deprecated": true,
1378
1400
  "description": "deprecated alias for run when an enter/leave/cd hook has no shell",
1379
- "$ref": "#/$defs/hook_scripts_value"
1401
+ "$ref": "#/$defs/hook_scripts_value",
1402
+ "deprecated": true
1380
1403
  }
1381
1404
  },
1382
1405
  "required": [
1383
1406
  "scripts"
1384
1407
  ],
1385
- "type": "object"
1408
+ "unevaluatedProperties": false
1386
1409
  },
1387
1410
  "hook_task_ref": {
1388
- "unevaluatedProperties": false,
1411
+ "type": "object",
1412
+ "required": [
1413
+ "task"
1414
+ ],
1389
1415
  "properties": {
1390
1416
  "task": {
1391
- "description": "mise task to run",
1392
- "type": "string"
1417
+ "type": "string",
1418
+ "description": "mise task to run"
1393
1419
  }
1394
1420
  },
1395
- "required": [
1396
- "task"
1397
- ],
1398
- "type": "object"
1421
+ "unevaluatedProperties": false
1399
1422
  },
1400
1423
  "hooks": {
1401
- "description": "hooks to run",
1402
1424
  "type": "object",
1425
+ "description": "hooks to run",
1426
+ "additionalProperties": false,
1403
1427
  "properties": {
1404
1428
  "enter": {
1429
+ "description": "hooks to run when an activated shell moves into the project",
1405
1430
  "$ref": "#/$defs/hook_definition"
1406
1431
  },
1407
1432
  "leave": {
1433
+ "description": "hooks to run when an activated shell moves out of the project",
1408
1434
  "$ref": "#/$defs/hook_definition"
1409
1435
  },
1410
1436
  "cd": {
1437
+ "description": "hooks to run when an activated shell changes to a directory inside the project",
1411
1438
  "$ref": "#/$defs/hook_definition"
1412
1439
  },
1413
1440
  "preinstall": {
1441
+ "description": "hooks to run before mise installs tools",
1414
1442
  "$ref": "#/$defs/hook_install_definition"
1415
1443
  },
1416
1444
  "postinstall": {
1445
+ "description": "hooks to run after mise installs tools",
1417
1446
  "$ref": "#/$defs/hook_install_definition"
1418
1447
  }
1419
- },
1420
- "additionalProperties": false
1448
+ }
1421
1449
  },
1422
1450
  "launchd_calendar_interval": {
1423
1451
  "type": "object",
@@ -1425,28 +1453,33 @@
1425
1453
  "properties": {
1426
1454
  "minute": {
1427
1455
  "type": "integer",
1428
- "maximum": 59,
1429
- "minimum": 0
1456
+ "description": "minute of the hour, 0-59; every minute when unset",
1457
+ "minimum": 0,
1458
+ "maximum": 59
1430
1459
  },
1431
1460
  "hour": {
1432
1461
  "type": "integer",
1433
- "maximum": 23,
1434
- "minimum": 0
1462
+ "description": "hour of the day, 0-23; every hour when unset",
1463
+ "minimum": 0,
1464
+ "maximum": 23
1435
1465
  },
1436
1466
  "day": {
1437
1467
  "type": "integer",
1438
- "maximum": 31,
1439
- "minimum": 1
1468
+ "description": "day of the month, 1-31; every day when unset",
1469
+ "minimum": 1,
1470
+ "maximum": 31
1440
1471
  },
1441
1472
  "weekday": {
1442
1473
  "type": "integer",
1443
- "maximum": 7,
1444
- "minimum": 0
1474
+ "description": "day of the week, 0-7, where 0 and 7 are Sunday; every day when unset",
1475
+ "minimum": 0,
1476
+ "maximum": 7
1445
1477
  },
1446
1478
  "month": {
1447
1479
  "type": "integer",
1448
- "maximum": 12,
1449
- "minimum": 1
1480
+ "description": "month of the year, 1-12; every month when unset",
1481
+ "minimum": 1,
1482
+ "maximum": 12
1450
1483
  }
1451
1484
  },
1452
1485
  "minProperties": 1,
@@ -1496,7 +1529,8 @@
1496
1529
  "type": "object",
1497
1530
  "description": "Short names for configured monorepo task roots. Keys are single path segments; values are paths in config_roots.",
1498
1531
  "additionalProperties": {
1499
- "type": "string"
1532
+ "type": "string",
1533
+ "description": "Config root this alias names, as listed in config_roots"
1500
1534
  }
1501
1535
  },
1502
1536
  "lockfile": {
@@ -1515,6 +1549,7 @@
1515
1549
  "description": "Explicit additions, removals, and overrides applied to provider-inferred workspace projects",
1516
1550
  "additionalProperties": {
1517
1551
  "type": "object",
1552
+ "description": "Changes to the workspace project with this ID, or a new project when the ID is new",
1518
1553
  "properties": {
1519
1554
  "remove": {
1520
1555
  "type": "boolean",
@@ -1883,6 +1918,11 @@
1883
1918
  "default": "~/.dotfiles",
1884
1919
  "description": "Directory that holds dotfile sources for entries without a `source`.",
1885
1920
  "type": "string"
1921
+ },
1922
+ "windows_symlinks": {
1923
+ "default": false,
1924
+ "description": "On Windows, deploy dotfile files as symbolic links instead of copies.",
1925
+ "type": "boolean"
1886
1926
  }
1887
1927
  }
1888
1928
  },
@@ -3803,7 +3843,6 @@
3803
3843
  "cache": {
3804
3844
  "type": "object",
3805
3845
  "description": "default experimental local artifact cache configuration for eligible tasks with sources and explicit outputs",
3806
- "unevaluatedProperties": false,
3807
3846
  "properties": {
3808
3847
  "enabled": {
3809
3848
  "type": "boolean",
@@ -3829,7 +3868,8 @@
3829
3868
  "type": "string"
3830
3869
  }
3831
3870
  }
3832
- }
3871
+ },
3872
+ "unevaluatedProperties": false
3833
3873
  },
3834
3874
  "rust_cache": {
3835
3875
  "description": "deprecated no-op; use mbx for Rust action caching instead: https://mr-boxington.jdx.dev/getting-started",
@@ -3840,11 +3880,12 @@
3840
3880
  },
3841
3881
  {
3842
3882
  "type": "object",
3843
- "unevaluatedProperties": false,
3844
3883
  "properties": {
3845
3884
  "enabled": {
3846
3885
  "type": "boolean",
3847
- "default": true
3886
+ "description": "deprecated no-op",
3887
+ "default": true,
3888
+ "deprecated": true
3848
3889
  },
3849
3890
  "verify": {
3850
3891
  "type": "boolean",
@@ -3852,7 +3893,8 @@
3852
3893
  "default": false,
3853
3894
  "deprecated": true
3854
3895
  }
3855
- }
3896
+ },
3897
+ "unevaluatedProperties": false
3856
3898
  }
3857
3899
  ]
3858
3900
  },
@@ -3882,6 +3924,7 @@
3882
3924
  "description": "experimental reusable config-root-relative source groups referenced with @group:<name>",
3883
3925
  "additionalProperties": {
3884
3926
  "type": "array",
3927
+ "description": "source patterns in this group, relative to the config root; may reference other groups with @group:<name>",
3885
3928
  "items": {
3886
3929
  "type": "string"
3887
3930
  }
@@ -3924,27 +3967,31 @@
3924
3967
  ]
3925
3968
  },
3926
3969
  "task_dependency_table": {
3927
- "description": "task dependency with args, env, and optional flag",
3928
3970
  "type": "object",
3971
+ "description": "task dependency with args, env, and optional flag",
3929
3972
  "properties": {
3930
3973
  "task": {
3931
- "type": "string"
3974
+ "type": "string",
3975
+ "description": "task name, alias, or pattern"
3932
3976
  },
3933
3977
  "args": {
3934
3978
  "type": "array",
3979
+ "description": "arguments to pass to the task",
3935
3980
  "items": {
3936
3981
  "type": "string"
3937
3982
  }
3938
3983
  },
3939
3984
  "env": {
3940
3985
  "type": "object",
3986
+ "description": "environment variables to set for this dependency only",
3941
3987
  "additionalProperties": {
3942
- "type": "string"
3988
+ "type": "string",
3989
+ "description": "value of this environment variable"
3943
3990
  }
3944
3991
  },
3945
3992
  "optional": {
3946
- "description": "do not fail when the task name or pattern has no matches",
3947
- "type": "boolean"
3993
+ "type": "boolean",
3994
+ "description": "do not fail when the task name or pattern has no matches"
3948
3995
  }
3949
3996
  },
3950
3997
  "required": [
@@ -3973,6 +4020,7 @@
3973
4020
  ]
3974
4021
  },
3975
4022
  "confirm": {
4023
+ "description": "prompt to answer before this task's own command runs, after its dependencies",
3976
4024
  "oneOf": [
3977
4025
  {
3978
4026
  "type": "string",
@@ -3981,6 +4029,9 @@
3981
4029
  {
3982
4030
  "type": "object",
3983
4031
  "description": "confirmation message before running this task with optional default value and custom answer labels",
4032
+ "required": [
4033
+ "message"
4034
+ ],
3984
4035
  "properties": {
3985
4036
  "message": {
3986
4037
  "type": "string",
@@ -4007,14 +4058,12 @@
4007
4058
  "description": "custom label for the negative answer"
4008
4059
  }
4009
4060
  },
4010
- "required": [
4011
- "message"
4012
- ],
4013
4061
  "unevaluatedProperties": false
4014
4062
  }
4015
4063
  ]
4016
4064
  },
4017
4065
  "depends": {
4066
+ "description": "tasks that must finish before this task runs",
4018
4067
  "oneOf": [
4019
4068
  {
4020
4069
  "type": "string",
@@ -4053,6 +4102,7 @@
4053
4102
  ]
4054
4103
  },
4055
4104
  "depends_post": {
4105
+ "description": "tasks to run after this task finishes",
4056
4106
  "oneOf": [
4057
4107
  {
4058
4108
  "type": "string",
@@ -4071,6 +4121,7 @@
4071
4121
  ]
4072
4122
  },
4073
4123
  "wait_for": {
4124
+ "description": "tasks to wait for if they are already scheduled, without adding them to the run",
4074
4125
  "oneOf": [
4075
4126
  {
4076
4127
  "type": "string",
@@ -4178,6 +4229,7 @@
4178
4229
  "default": false
4179
4230
  },
4180
4231
  "outputs": {
4232
+ "description": "files or directories this task creates; compared with `sources` to skip the task when it is up to date",
4181
4233
  "oneOf": [
4182
4234
  {
4183
4235
  "type": "array",
@@ -4193,23 +4245,22 @@
4193
4245
  },
4194
4246
  {
4195
4247
  "type": "object",
4196
- "unevaluatedProperties": false,
4248
+ "required": [
4249
+ "auto"
4250
+ ],
4197
4251
  "properties": {
4198
4252
  "auto": {
4199
4253
  "type": "boolean",
4200
4254
  "description": "automatically touch an internal tracked file instead of specifying outputs; `false` is the same as leaving `outputs` unset"
4201
4255
  }
4202
4256
  },
4203
- "required": [
4204
- "auto"
4205
- ]
4257
+ "unevaluatedProperties": false
4206
4258
  }
4207
4259
  ]
4208
4260
  },
4209
4261
  "cache": {
4210
4262
  "type": "object",
4211
4263
  "description": "experimental local artifact cache for declared task outputs",
4212
- "unevaluatedProperties": false,
4213
4264
  "properties": {
4214
4265
  "enabled": {
4215
4266
  "type": "boolean",
@@ -4235,7 +4286,8 @@
4235
4286
  "type": "string"
4236
4287
  }
4237
4288
  }
4238
- }
4289
+ },
4290
+ "unevaluatedProperties": false
4239
4291
  },
4240
4292
  "rust_cache": {
4241
4293
  "description": "deprecated no-op; use mbx for Rust action caching instead: https://mr-boxington.jdx.dev/getting-started",
@@ -4246,11 +4298,12 @@
4246
4298
  },
4247
4299
  {
4248
4300
  "type": "object",
4249
- "unevaluatedProperties": false,
4250
4301
  "properties": {
4251
4302
  "enabled": {
4252
4303
  "type": "boolean",
4253
- "default": true
4304
+ "description": "deprecated no-op",
4305
+ "default": true,
4306
+ "deprecated": true
4254
4307
  },
4255
4308
  "verify": {
4256
4309
  "type": "boolean",
@@ -4258,7 +4311,8 @@
4258
4311
  "default": false,
4259
4312
  "deprecated": true
4260
4313
  }
4261
- }
4314
+ },
4315
+ "unevaluatedProperties": false
4262
4316
  }
4263
4317
  ]
4264
4318
  },
@@ -4342,6 +4396,7 @@
4342
4396
  "description": "Execute an external script"
4343
4397
  },
4344
4398
  "sources": {
4399
+ "description": "files this task reads; mise skips the task when none changed since its outputs were written",
4345
4400
  "oneOf": [
4346
4401
  {
4347
4402
  "type": "array",
@@ -4457,52 +4512,53 @@
4457
4512
  "task_run_entry": {
4458
4513
  "oneOf": [
4459
4514
  {
4460
- "description": "script to run",
4461
- "type": "string"
4515
+ "type": "string",
4516
+ "description": "script to run"
4462
4517
  },
4463
4518
  {
4464
4519
  "type": "object",
4465
- "unevaluatedProperties": false,
4520
+ "required": [
4521
+ "task"
4522
+ ],
4466
4523
  "properties": {
4467
4524
  "task": {
4468
- "description": "single task name to run",
4469
- "type": "string"
4525
+ "type": "string",
4526
+ "description": "single task name to run"
4470
4527
  },
4471
4528
  "args": {
4472
- "description": "arguments to pass to the task",
4473
4529
  "type": "array",
4530
+ "description": "arguments to pass to the task",
4474
4531
  "items": {
4475
4532
  "type": "string"
4476
4533
  }
4477
4534
  },
4478
4535
  "env": {
4479
- "description": "environment variables to set for the task",
4480
4536
  "type": "object",
4537
+ "description": "environment variables to set for the task",
4481
4538
  "additionalProperties": {
4482
- "type": "string"
4539
+ "type": "string",
4540
+ "description": "value of this environment variable"
4483
4541
  }
4484
4542
  }
4485
4543
  },
4486
- "required": [
4487
- "task"
4488
- ]
4544
+ "unevaluatedProperties": false
4489
4545
  },
4490
4546
  {
4491
4547
  "type": "object",
4492
- "unevaluatedProperties": false,
4548
+ "required": [
4549
+ "tasks"
4550
+ ],
4493
4551
  "properties": {
4494
4552
  "tasks": {
4553
+ "type": "array",
4495
4554
  "description": "parallel task group to run",
4496
4555
  "items": {
4497
- "description": "task name and args",
4498
- "type": "string"
4499
- },
4500
- "type": "array"
4556
+ "type": "string",
4557
+ "description": "task name and args"
4558
+ }
4501
4559
  }
4502
4560
  },
4503
- "required": [
4504
- "tasks"
4505
- ]
4561
+ "unevaluatedProperties": false
4506
4562
  }
4507
4563
  ]
4508
4564
  },
@@ -4527,16 +4583,16 @@
4527
4583
  "type": "object"
4528
4584
  },
4529
4585
  "task_watch": {
4530
- "description": "options used by `mise watch` for this task",
4531
4586
  "type": "object",
4532
- "unevaluatedProperties": false,
4587
+ "description": "options used by `mise watch` for this task",
4533
4588
  "properties": {
4534
4589
  "no_vcs_ignore": {
4535
- "default": false,
4590
+ "type": "boolean",
4536
4591
  "description": "do not load VCS ignore files such as `.gitignore` when watching this task",
4537
- "type": "boolean"
4592
+ "default": false
4538
4593
  }
4539
- }
4594
+ },
4595
+ "unevaluatedProperties": false
4540
4596
  },
4541
4597
  "tool": {
4542
4598
  "description": "a version of the tool, or a table with its version and options",
@@ -4618,9 +4674,11 @@
4618
4674
  "type": "object",
4619
4675
  "properties": {
4620
4676
  "run": {
4677
+ "description": "command to run after the tool installs",
4621
4678
  "type": "string"
4622
4679
  },
4623
4680
  "when": {
4681
+ "description": "install runs the command only when mise installs the tool; always runs it on every mise install and mise use",
4624
4682
  "type": "string",
4625
4683
  "enum": [
4626
4684
  "install",
@@ -4664,6 +4722,7 @@
4664
4722
  ]
4665
4723
  },
4666
4724
  "tool_alias_entry": {
4725
+ "description": "the backend this tool name points to, or a table with its backend and version aliases",
4667
4726
  "oneOf": [
4668
4727
  {
4669
4728
  "description": "where the alias goes",
@@ -4724,8 +4783,8 @@
4724
4783
  "$ref": "#/$defs/tool_bool"
4725
4784
  },
4726
4785
  "libc": {
4727
- "description": "force strict glibc or musl asset selection on linux",
4728
4786
  "type": "string",
4787
+ "description": "force strict glibc or musl asset selection on linux",
4729
4788
  "enum": [
4730
4789
  "glibc",
4731
4790
  "gnu",
@@ -4733,18 +4792,19 @@
4733
4792
  ]
4734
4793
  },
4735
4794
  "slsa_signer_identity": {
4736
- "description": "expected fulcio certificate subject for slsa provenance; requires slsa_signer_issuer",
4737
- "type": "string"
4795
+ "type": "string",
4796
+ "description": "expected fulcio certificate subject for slsa provenance; requires slsa_signer_issuer"
4738
4797
  },
4739
4798
  "slsa_signer_issuer": {
4740
- "description": "expected oidc issuer for slsa provenance; requires slsa_signer_identity",
4741
- "type": "string"
4799
+ "type": "string",
4800
+ "description": "expected oidc issuer for slsa provenance; requires slsa_signer_identity"
4742
4801
  },
4743
4802
  "vars": {
4744
- "description": "values for aqua registry template variables",
4745
4803
  "type": "object",
4804
+ "description": "values for aqua registry template variables",
4746
4805
  "additionalProperties": {
4747
- "type": "string"
4806
+ "type": "string",
4807
+ "description": "value of this aqua registry template variable"
4748
4808
  }
4749
4809
  }
4750
4810
  }
@@ -4834,8 +4894,8 @@
4834
4894
  "$ref": "#/$defs/tool_bool"
4835
4895
  },
4836
4896
  "bin": {
4837
- "description": "binary to install when a crate has several (cargo install --bin)",
4838
- "type": "string"
4897
+ "type": "string",
4898
+ "description": "binary to install when a crate has several (cargo install --bin)"
4839
4899
  },
4840
4900
  "rename_exe": {
4841
4901
  "description": "rename the installed executable: a name, or a table of glob = new name",
@@ -4846,14 +4906,15 @@
4846
4906
  {
4847
4907
  "type": "object",
4848
4908
  "additionalProperties": {
4849
- "type": "string"
4909
+ "type": "string",
4910
+ "description": "new name for the executables matching this glob"
4850
4911
  }
4851
4912
  }
4852
4913
  ]
4853
4914
  },
4854
4915
  "crate": {
4855
- "description": "crate to install when a git repository contains several",
4856
- "type": "string"
4916
+ "type": "string",
4917
+ "description": "crate to install when a git repository contains several"
4857
4918
  },
4858
4919
  "locked": {
4859
4920
  "description": "pass --locked to cargo install (default true)",
@@ -4868,6 +4929,7 @@
4868
4929
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
4869
4930
  },
4870
4931
  "additionalProperties": {
4932
+ "description": "options for this platform, overriding the same options set for the whole tool",
4871
4933
  "type": "object",
4872
4934
  "properties": {
4873
4935
  "bin": {
@@ -4900,8 +4962,8 @@
4900
4962
  "type": "object",
4901
4963
  "properties": {
4902
4964
  "channel": {
4903
- "description": "conda channel to resolve the package from (default conda-forge)",
4904
- "type": "string"
4965
+ "type": "string",
4966
+ "description": "conda channel to resolve the package from (default conda-forge)"
4905
4967
  }
4906
4968
  }
4907
4969
  },
@@ -4941,8 +5003,8 @@
4941
5003
  "type": "object",
4942
5004
  "properties": {
4943
5005
  "runtime": {
4944
- "description": "install a shared runtime instead of the sdk; the version is the runtime version",
4945
5006
  "type": "string",
5007
+ "description": "install a shared runtime instead of the sdk; the version is the runtime version",
4946
5008
  "enum": [
4947
5009
  "dotnet",
4948
5010
  "aspnetcore",
@@ -4975,8 +5037,8 @@
4975
5037
  "type": "object",
4976
5038
  "properties": {
4977
5039
  "release_type": {
4978
- "description": "jdk metadata channel: ga (default) or ea for early access builds",
4979
5040
  "type": "string",
5041
+ "description": "jdk metadata channel: ga (default) or ea for early access builds",
4980
5042
  "enum": [
4981
5043
  "ga",
4982
5044
  "ea"
@@ -5012,8 +5074,8 @@
5012
5074
  "$ref": "#/$defs/tool_bool"
5013
5075
  },
5014
5076
  "virtualenv": {
5015
- "description": "virtualenv path to activate; use env._.python.venv instead",
5016
5077
  "type": "string",
5078
+ "description": "virtualenv path to activate; use env._.python.venv instead",
5017
5079
  "deprecated": true
5018
5080
  }
5019
5081
  }
@@ -5042,8 +5104,8 @@
5042
5104
  "type": "object",
5043
5105
  "properties": {
5044
5106
  "profile": {
5045
- "description": "rustup profile to install, such as minimal, default or complete",
5046
- "type": "string"
5107
+ "type": "string",
5108
+ "description": "rustup profile to install, such as minimal, default or complete"
5047
5109
  },
5048
5110
  "components": {
5049
5111
  "description": "rustup components to install",
@@ -5083,12 +5145,12 @@
5083
5145
  "type": "object",
5084
5146
  "properties": {
5085
5147
  "version_prefix": {
5086
- "description": "release tag prefix stripped from versions and re-added when resolving tags",
5087
- "type": "string"
5148
+ "type": "string",
5149
+ "description": "release tag prefix stripped from versions and re-added when resolving tags"
5088
5150
  },
5089
5151
  "asset_pattern": {
5090
- "description": "glob (* and ?) matched against release asset names, tera templated; replaces autodetection",
5091
- "type": "string"
5152
+ "type": "string",
5153
+ "description": "glob (* and ?) matched against release asset names, tera templated; replaces autodetection"
5092
5154
  },
5093
5155
  "additional_asset_patterns": {
5094
5156
  "description": "extra archives from the same release extracted over the primary asset, in order",
@@ -5105,12 +5167,12 @@
5105
5167
  ]
5106
5168
  },
5107
5169
  "matching": {
5108
- "description": "substring an asset name must contain, applied before platform autodetection",
5109
- "type": "string"
5170
+ "type": "string",
5171
+ "description": "substring an asset name must contain, applied before platform autodetection"
5110
5172
  },
5111
5173
  "matching_regex": {
5112
- "description": "regex an asset name must match, applied before platform autodetection",
5113
- "type": "string"
5174
+ "type": "string",
5175
+ "description": "regex an asset name must match, applied before platform autodetection"
5114
5176
  },
5115
5177
  "no_app": {
5116
5178
  "description": "penalize macos .app bundle assets during autodetection",
@@ -5131,8 +5193,8 @@
5131
5193
  ]
5132
5194
  },
5133
5195
  "format": {
5134
- "description": "force the archive format instead of detecting it from the file name",
5135
5196
  "type": "string",
5197
+ "description": "force the archive format instead of detecting it from the file name",
5136
5198
  "enum": [
5137
5199
  "tar.gz",
5138
5200
  "tgz",
@@ -5165,8 +5227,8 @@
5165
5227
  ]
5166
5228
  },
5167
5229
  "checksum": {
5168
- "description": "expected artifact digest as algo:hash (sha256, sha512, sha1, md5, blake3)",
5169
- "type": "string"
5230
+ "type": "string",
5231
+ "description": "expected artifact digest as algo:hash (sha256, sha512, sha1, md5, blake3)"
5170
5232
  },
5171
5233
  "size": {
5172
5234
  "description": "expected artifact size in bytes",
@@ -5191,8 +5253,8 @@
5191
5253
  ]
5192
5254
  },
5193
5255
  "bin": {
5194
- "description": "executable name (or safe relative path) to install the downloaded binary as",
5195
- "type": "string"
5256
+ "type": "string",
5257
+ "description": "executable name (or safe relative path) to install the downloaded binary as"
5196
5258
  },
5197
5259
  "rename_exe": {
5198
5260
  "description": "rename the extracted executable: a name, or a table of glob = new name",
@@ -5203,14 +5265,15 @@
5203
5265
  {
5204
5266
  "type": "object",
5205
5267
  "additionalProperties": {
5206
- "type": "string"
5268
+ "type": "string",
5269
+ "description": "new name for the executables matching this glob"
5207
5270
  }
5208
5271
  }
5209
5272
  ]
5210
5273
  },
5211
5274
  "bin_path": {
5212
- "description": "directory inside the install that contains binaries (tera templated)",
5213
- "type": "string"
5275
+ "type": "string",
5276
+ "description": "directory inside the install that contains binaries (tera templated)"
5214
5277
  }
5215
5278
  }
5216
5279
  },
@@ -5221,6 +5284,7 @@
5221
5284
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
5222
5285
  },
5223
5286
  "additionalProperties": {
5287
+ "description": "options for this platform, overriding the same options set for the whole tool",
5224
5288
  "type": "object",
5225
5289
  "properties": {
5226
5290
  "asset_pattern": {
@@ -5229,10 +5293,6 @@
5229
5293
  "additional_asset_patterns": {
5230
5294
  "$ref": "#/$defs/tool_forge_options/properties/additional_asset_patterns"
5231
5295
  },
5232
- "url": {
5233
- "description": "direct download url for this platform, tera templated; skips release asset selection",
5234
- "type": "string"
5235
- },
5236
5296
  "no_app": {
5237
5297
  "$ref": "#/$defs/tool_forge_options/properties/no_app"
5238
5298
  },
@@ -5259,6 +5319,10 @@
5259
5319
  },
5260
5320
  "format": {
5261
5321
  "$ref": "#/$defs/tool_forge_options/properties/format"
5322
+ },
5323
+ "url": {
5324
+ "description": "direct download url for this platform, tera templated; skips release asset selection",
5325
+ "type": "string"
5262
5326
  }
5263
5327
  }
5264
5328
  }
@@ -5302,8 +5366,8 @@
5302
5366
  "type": "object",
5303
5367
  "properties": {
5304
5368
  "api_url": {
5305
- "description": "api base url, for self-hosted forgejo or gitea instances",
5306
- "type": "string"
5369
+ "type": "string",
5370
+ "description": "api base url, for self-hosted forgejo or gitea instances"
5307
5371
  }
5308
5372
  }
5309
5373
  },
@@ -5331,8 +5395,8 @@
5331
5395
  "type": "object",
5332
5396
  "properties": {
5333
5397
  "source": {
5334
- "description": "gem registry http(s) url used to resolve and install this gem",
5335
- "type": "string"
5398
+ "type": "string",
5399
+ "description": "gem registry http(s) url used to resolve and install this gem"
5336
5400
  }
5337
5401
  }
5338
5402
  },
@@ -5375,20 +5439,20 @@
5375
5439
  "type": "object",
5376
5440
  "properties": {
5377
5441
  "api_url": {
5378
- "description": "api base url, for github enterprise or self-hosted instances",
5379
- "type": "string"
5442
+ "type": "string",
5443
+ "description": "api base url, for github enterprise or self-hosted instances"
5380
5444
  },
5381
5445
  "github_attestations": {
5382
5446
  "description": "verify github artifact attestations when available",
5383
5447
  "$ref": "#/$defs/tool_bool"
5384
5448
  },
5385
5449
  "slsa_signer_identity": {
5386
- "description": "expected fulcio certificate identity for slsa provenance, tera templated",
5387
- "type": "string"
5450
+ "type": "string",
5451
+ "description": "expected fulcio certificate identity for slsa provenance, tera templated"
5388
5452
  },
5389
5453
  "slsa_signer_issuer": {
5390
- "description": "expected oidc issuer for slsa provenance; requires slsa_signer_identity",
5391
- "type": "string"
5454
+ "type": "string",
5455
+ "description": "expected oidc issuer for slsa provenance; requires slsa_signer_identity"
5392
5456
  }
5393
5457
  }
5394
5458
  },
@@ -5431,8 +5495,8 @@
5431
5495
  "type": "object",
5432
5496
  "properties": {
5433
5497
  "api_url": {
5434
- "description": "api base url, for self-hosted gitlab instances",
5435
- "type": "string"
5498
+ "type": "string",
5499
+ "description": "api base url, for self-hosted gitlab instances"
5436
5500
  }
5437
5501
  }
5438
5502
  },
@@ -5511,32 +5575,34 @@
5511
5575
  "type": "object",
5512
5576
  "properties": {
5513
5577
  "url": {
5514
- "description": "download url, tera templated, http(s) or file://; required for each platform",
5515
- "type": "string"
5578
+ "type": "string",
5579
+ "description": "download url, tera templated, http(s) or file://; required for each platform"
5516
5580
  },
5517
5581
  "checksum": {
5518
- "description": "expected artifact digest as algo:hash",
5519
- "type": "string"
5582
+ "type": "string",
5583
+ "description": "expected artifact digest as algo:hash"
5520
5584
  },
5521
5585
  "checksum_url": {
5522
- "description": "checksum file or manifest url, used by mise lock without downloading",
5523
- "type": "string"
5586
+ "type": "string",
5587
+ "description": "checksum file or manifest url, used by mise lock without downloading"
5524
5588
  },
5525
5589
  "checksum_expr": {
5526
- "description": "expr-lang expression extracting algo:hash from the checksum_url manifest",
5527
- "type": "string"
5590
+ "type": "string",
5591
+ "description": "expr-lang expression extracting algo:hash from the checksum_url manifest"
5528
5592
  },
5529
5593
  "headers": {
5530
- "description": "request headers sent with the download, version_list_url and checksum_url requests; values are tera templated (e.g. Bearer {{ env.TOKEN }})",
5531
5594
  "type": "object",
5595
+ "description": "request headers sent with the download, version_list_url and checksum_url requests; values are tera templated (e.g. Bearer {{ env.TOKEN }})",
5532
5596
  "additionalProperties": {
5533
- "type": "string"
5597
+ "type": "string",
5598
+ "description": "value of this request header; tera templated"
5534
5599
  }
5535
5600
  },
5536
5601
  "headers_forward": {
5537
- "description": "hosts each header in headers may follow a redirect to; exact hosts or *.suffix, and a header with no entry is never forwarded",
5538
5602
  "type": "object",
5603
+ "description": "hosts each header in headers may follow a redirect to; exact hosts or *.suffix, and a header with no entry is never forwarded",
5539
5604
  "additionalProperties": {
5605
+ "description": "hosts this header may follow a redirect to: exact hosts or *.suffix",
5540
5606
  "oneOf": [
5541
5607
  {
5542
5608
  "type": "string"
@@ -5562,8 +5628,8 @@
5562
5628
  ]
5563
5629
  },
5564
5630
  "format": {
5565
- "description": "force the archive format instead of detecting it from the url",
5566
5631
  "type": "string",
5632
+ "description": "force the archive format instead of detecting it from the url",
5567
5633
  "enum": [
5568
5634
  "tar.gz",
5569
5635
  "tgz",
@@ -5607,8 +5673,8 @@
5607
5673
  ]
5608
5674
  },
5609
5675
  "bin": {
5610
- "description": "name for a downloaded raw or compressed single binary (ignored for archives)",
5611
- "type": "string"
5676
+ "type": "string",
5677
+ "description": "name for a downloaded raw or compressed single binary (ignored for archives)"
5612
5678
  },
5613
5679
  "rename_exe": {
5614
5680
  "description": "rename the extracted executable: a name, or a table of glob = new name",
@@ -5619,38 +5685,51 @@
5619
5685
  {
5620
5686
  "type": "object",
5621
5687
  "additionalProperties": {
5622
- "type": "string"
5688
+ "type": "string",
5689
+ "description": "new name for the executables matching this glob"
5623
5690
  }
5624
5691
  }
5625
5692
  ]
5626
5693
  },
5627
5694
  "bin_path": {
5628
- "description": "directory inside the install that contains binaries (tera templated)",
5629
- "type": "string"
5695
+ "type": "string",
5696
+ "description": "directory inside the install that contains binaries (tera templated)"
5630
5697
  },
5631
5698
  "shared_extraction": {
5632
5699
  "description": "share extracted content between installs with identical artifacts",
5633
5700
  "$ref": "#/$defs/tool_bool"
5634
5701
  },
5635
5702
  "windows_script_interpreter": {
5636
- "description": "windows only: write a .cmd launcher running the raw script with this interpreter",
5637
- "type": "string"
5703
+ "type": "string",
5704
+ "description": "windows only: write a .cmd launcher running the raw script with this interpreter"
5638
5705
  },
5639
5706
  "version_list_url": {
5640
- "description": "url returning the version list (text, json or html)",
5641
- "type": "string"
5707
+ "type": "string",
5708
+ "description": "url returning the version list (text, json or html)"
5642
5709
  },
5643
5710
  "version_regex": {
5644
- "description": "regex extracting versions from the list (first capture group or whole match)",
5645
- "type": "string"
5711
+ "type": "string",
5712
+ "description": "regex extracting versions from the list (first capture group or whole match)"
5646
5713
  },
5647
5714
  "version_json_path": {
5648
- "description": "jq-like path extracting versions from json, such as .[].version",
5649
- "type": "string"
5715
+ "type": "string",
5716
+ "description": "jq-like path extracting versions from json, such as .[].version"
5650
5717
  },
5651
5718
  "version_expr": {
5652
- "description": "expr-lang expression post-processing versions (variables: body, versions)",
5653
- "type": "string"
5719
+ "type": "string",
5720
+ "description": "expr-lang expression post-processing versions (variables: body, versions)"
5721
+ },
5722
+ "version_date_url": {
5723
+ "type": "string",
5724
+ "description": "url holding release dates; defaults to the version_list_url body"
5725
+ },
5726
+ "version_date_next_expr": {
5727
+ "type": "string",
5728
+ "description": "expr-lang expression returning the url of the next page of version_date_url, or nil after the last (variables: body, url)"
5729
+ },
5730
+ "version_date_expr": {
5731
+ "type": "string",
5732
+ "description": "expr-lang expression mapping each version to its release date, as a list of [version, date] pairs or a map of version to date (variables: body, bodies, versions)"
5654
5733
  }
5655
5734
  }
5656
5735
  },
@@ -5661,6 +5740,7 @@
5661
5740
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
5662
5741
  },
5663
5742
  "additionalProperties": {
5743
+ "description": "options for this platform, overriding the same options set for the whole tool",
5664
5744
  "type": "object",
5665
5745
  "properties": {
5666
5746
  "url": {
@@ -5778,52 +5858,53 @@
5778
5858
  ]
5779
5859
  },
5780
5860
  "aube_args": {
5781
- "description": "extra arguments for aube add --global (only with npm.package_manager = aube_cli)",
5782
- "type": "string"
5861
+ "type": "string",
5862
+ "description": "extra arguments for aube add --global (only with npm.package_manager = aube_cli)"
5783
5863
  },
5784
5864
  "pnpm_args": {
5785
- "description": "extra arguments for pnpm installs (shell-split)",
5786
- "type": "string"
5865
+ "type": "string",
5866
+ "description": "extra arguments for pnpm installs (shell-split)"
5787
5867
  },
5788
5868
  "bun_args": {
5789
- "description": "extra arguments for bun installs (shell-split)",
5790
- "type": "string"
5869
+ "type": "string",
5870
+ "description": "extra arguments for bun installs (shell-split)"
5791
5871
  },
5792
5872
  "npm_args": {
5793
- "description": "extra arguments for npm installs (shell-split)",
5794
- "type": "string"
5873
+ "type": "string",
5874
+ "description": "extra arguments for npm installs (shell-split)"
5795
5875
  }
5796
5876
  }
5797
5877
  },
5798
5878
  "tool_options": {
5879
+ "type": "object",
5799
5880
  "properties": {
5800
5881
  "version": {
5801
- "description": "version of the tool to install",
5802
- "type": "string"
5882
+ "type": "string",
5883
+ "description": "version of the tool to install"
5803
5884
  },
5804
5885
  "path": {
5805
- "description": "path to a custom compiled version",
5806
- "type": "string"
5886
+ "type": "string",
5887
+ "description": "path to a custom compiled version"
5807
5888
  },
5808
5889
  "prefix": {
5809
- "description": "version prefix to resolve",
5810
- "type": "string"
5890
+ "type": "string",
5891
+ "description": "version prefix to resolve"
5811
5892
  },
5812
5893
  "ref": {
5813
- "description": "version control reference to compile",
5814
- "type": "string"
5894
+ "type": "string",
5895
+ "description": "version control reference to compile"
5815
5896
  },
5816
5897
  "os": {
5817
5898
  "$ref": "#/$defs/os_filter"
5818
5899
  },
5819
5900
  "minimum_release_age": {
5820
- "description": "minimum time since a version's release before mise selects it, as a duration such as \"7d\" or an absolute date",
5821
- "type": "string"
5901
+ "type": "string",
5902
+ "description": "minimum time since a version's release before mise selects it, as a duration such as \"7d\" or an absolute date"
5822
5903
  },
5823
5904
  "install_before": {
5905
+ "type": "string",
5824
5906
  "description": "deprecated alias for minimum_release_age",
5825
- "deprecated": true,
5826
- "type": "string"
5907
+ "deprecated": true
5827
5908
  },
5828
5909
  "version_order": {
5829
5910
  "description": "ordering applied to remote versions: \"source\" keeps the backend's order, \"semver\" sorts semantic versions",
@@ -5866,8 +5947,7 @@
5866
5947
  "ref"
5867
5948
  ]
5868
5949
  }
5869
- ],
5870
- "type": "object"
5950
+ ]
5871
5951
  },
5872
5952
  "tool_packslip": {
5873
5953
  "description": "a tool installed with the packslip backend",
@@ -5893,20 +5973,20 @@
5893
5973
  "type": "object",
5894
5974
  "properties": {
5895
5975
  "variant": {
5896
- "description": "publisher-declared alternative build to select, such as fips",
5897
- "type": "string"
5976
+ "type": "string",
5977
+ "description": "publisher-declared alternative build to select, such as fips"
5898
5978
  },
5899
5979
  "pubkey": {
5900
- "description": "minisign public key line or path to a .pub file pinning the signer",
5901
- "type": "string"
5980
+ "type": "string",
5981
+ "description": "minisign public key line or path to a .pub file pinning the signer"
5902
5982
  },
5903
5983
  "identity": {
5904
- "description": "exact keyless signer certificate identity",
5905
- "type": "string"
5984
+ "type": "string",
5985
+ "description": "exact keyless signer certificate identity"
5906
5986
  },
5907
5987
  "identity_prefix": {
5908
- "description": "keyless signer certificate identity prefix",
5909
- "type": "string"
5988
+ "type": "string",
5989
+ "description": "keyless signer certificate identity prefix"
5910
5990
  },
5911
5991
  "workflow": {
5912
5992
  "description": "repository workflow file, or a list of them, that signs releases on a tag (or on the ref a name ends with, as in release.yml@refs/heads/main); github.com projects only, not valid with pubkey, identity, identity_prefix, or issuer",
@@ -5924,12 +6004,12 @@
5924
6004
  ]
5925
6005
  },
5926
6006
  "list_identity_prefix": {
5927
- "description": "separate identity prefix for the vendor release list; needs an issuer, not valid with pubkey",
5928
- "type": "string"
6007
+ "type": "string",
6008
+ "description": "separate identity prefix for the vendor release list; needs an issuer, not valid with pubkey"
5929
6009
  },
5930
6010
  "issuer": {
5931
- "description": "oidc issuer for the keyless signer",
5932
- "type": "string"
6011
+ "type": "string",
6012
+ "description": "oidc issuer for the keyless signer"
5933
6013
  },
5934
6014
  "allow_unlogged": {
5935
6015
  "description": "accept key-signed bundles without transparency-log evidence",
@@ -5940,8 +6020,8 @@
5940
6020
  "$ref": "#/$defs/tool_bool"
5941
6021
  },
5942
6022
  "trust": {
5943
- "description": "vendor exempts this tool from configured packslip stampers",
5944
6023
  "type": "string",
6024
+ "description": "vendor exempts this tool from configured packslip stampers",
5945
6025
  "enum": [
5946
6026
  "vendor"
5947
6027
  ]
@@ -5955,6 +6035,7 @@
5955
6035
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
5956
6036
  },
5957
6037
  "additionalProperties": {
6038
+ "description": "options for this platform, overriding the same options set for the whole tool",
5958
6039
  "type": "object"
5959
6040
  }
5960
6041
  },
@@ -6024,8 +6105,8 @@
6024
6105
  ]
6025
6106
  },
6026
6107
  "dependency_prereleases": {
6027
- "description": "uv prerelease policy for dependency resolution (requires uv)",
6028
6108
  "type": "string",
6109
+ "description": "uv prerelease policy for dependency resolution (requires uv)",
6029
6110
  "enum": [
6030
6111
  "disallow",
6031
6112
  "allow",
@@ -6034,28 +6115,28 @@
6034
6115
  ]
6035
6116
  },
6036
6117
  "python": {
6037
- "description": "mise-managed CPython version for this tool (minor or exact patch)",
6038
- "type": "string"
6118
+ "type": "string",
6119
+ "description": "mise-managed CPython version for this tool (minor or exact patch)"
6039
6120
  },
6040
6121
  "package_name": {
6041
- "description": "distribution name for git sources, used to attach extras",
6042
- "type": "string"
6122
+ "type": "string",
6123
+ "description": "distribution name for git sources, used to attach extras"
6043
6124
  },
6044
6125
  "pipx_args": {
6045
- "description": "extra arguments for pipx install (shell-split)",
6046
- "type": "string"
6126
+ "type": "string",
6127
+ "description": "extra arguments for pipx install (shell-split)"
6047
6128
  },
6048
6129
  "uvx": {
6049
6130
  "description": "set to false to install with pipx instead of uv",
6050
6131
  "$ref": "#/$defs/tool_bool"
6051
6132
  },
6052
6133
  "uvx_args": {
6053
- "description": "extra arguments for uv tool install (shell-split)",
6054
- "type": "string"
6134
+ "type": "string",
6135
+ "description": "extra arguments for uv tool install (shell-split)"
6055
6136
  },
6056
6137
  "registry_url": {
6057
- "description": "version-listing url containing a {} placeholder for the package name",
6058
- "type": "string"
6138
+ "type": "string",
6139
+ "description": "version-listing url containing a {} placeholder for the package name"
6059
6140
  }
6060
6141
  }
6061
6142
  },
@@ -6095,12 +6176,12 @@
6095
6176
  "type": "object",
6096
6177
  "properties": {
6097
6178
  "url": {
6098
- "description": "s3://bucket/key object url, tera templated; required for each platform",
6099
- "type": "string"
6179
+ "type": "string",
6180
+ "description": "s3://bucket/key object url, tera templated; required for each platform"
6100
6181
  },
6101
6182
  "checksum": {
6102
- "description": "expected artifact digest as algo:hash",
6103
- "type": "string"
6183
+ "type": "string",
6184
+ "description": "expected artifact digest as algo:hash"
6104
6185
  },
6105
6186
  "size": {
6106
6187
  "description": "expected artifact size in bytes",
@@ -6114,8 +6195,8 @@
6114
6195
  ]
6115
6196
  },
6116
6197
  "format": {
6117
- "description": "force the archive format when the object key has no usable extension",
6118
6198
  "type": "string",
6199
+ "description": "force the archive format when the object key has no usable extension",
6119
6200
  "enum": [
6120
6201
  "tar.gz",
6121
6202
  "tgz",
@@ -6159,8 +6240,8 @@
6159
6240
  ]
6160
6241
  },
6161
6242
  "bin": {
6162
- "description": "executable name (or safe relative path) to install the downloaded binary as",
6163
- "type": "string"
6243
+ "type": "string",
6244
+ "description": "executable name (or safe relative path) to install the downloaded binary as"
6164
6245
  },
6165
6246
  "rename_exe": {
6166
6247
  "description": "rename the extracted executable: a name, or a table of glob = new name",
@@ -6171,42 +6252,43 @@
6171
6252
  {
6172
6253
  "type": "object",
6173
6254
  "additionalProperties": {
6174
- "type": "string"
6255
+ "type": "string",
6256
+ "description": "new name for the executables matching this glob"
6175
6257
  }
6176
6258
  }
6177
6259
  ]
6178
6260
  },
6179
6261
  "bin_path": {
6180
- "description": "directory inside the install that contains binaries (tera templated)",
6181
- "type": "string"
6262
+ "type": "string",
6263
+ "description": "directory inside the install that contains binaries (tera templated)"
6182
6264
  },
6183
6265
  "region": {
6184
- "description": "aws region used for the s3 client",
6185
- "type": "string"
6266
+ "type": "string",
6267
+ "description": "aws region used for the s3 client"
6186
6268
  },
6187
6269
  "endpoint": {
6188
- "description": "custom s3-compatible endpoint url (minio and similar); enables path-style addressing",
6189
- "type": "string"
6270
+ "type": "string",
6271
+ "description": "custom s3-compatible endpoint url (minio and similar); enables path-style addressing"
6190
6272
  },
6191
6273
  "version_list_url": {
6192
- "description": "s3:// url of a manifest file listing versions",
6193
- "type": "string"
6274
+ "type": "string",
6275
+ "description": "s3:// url of a manifest file listing versions"
6194
6276
  },
6195
6277
  "version_prefix": {
6196
- "description": "s3 key prefix to list objects under for version discovery",
6197
- "type": "string"
6278
+ "type": "string",
6279
+ "description": "s3 key prefix to list objects under for version discovery"
6198
6280
  },
6199
6281
  "version_regex": {
6200
- "description": "regex extracting versions from the manifest or object keys",
6201
- "type": "string"
6282
+ "type": "string",
6283
+ "description": "regex extracting versions from the manifest or object keys"
6202
6284
  },
6203
6285
  "version_json_path": {
6204
- "description": "jq-like path extracting versions from json, such as .[].version",
6205
- "type": "string"
6286
+ "type": "string",
6287
+ "description": "jq-like path extracting versions from json, such as .[].version"
6206
6288
  },
6207
6289
  "version_expr": {
6208
- "description": "expr-lang expression post-processing versions (variables: body, versions)",
6209
- "type": "string"
6290
+ "type": "string",
6291
+ "description": "expr-lang expression post-processing versions (variables: body, versions)"
6210
6292
  }
6211
6293
  }
6212
6294
  },
@@ -6217,6 +6299,7 @@
6217
6299
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
6218
6300
  },
6219
6301
  "additionalProperties": {
6302
+ "description": "options for this platform, overriding the same options set for the whole tool",
6220
6303
  "type": "object",
6221
6304
  "properties": {
6222
6305
  "url": {
@@ -6291,25 +6374,25 @@
6291
6374
  "type": "object",
6292
6375
  "properties": {
6293
6376
  "entrypoint": {
6294
- "description": "ruby file to compile, relative to the repository root (default main.rb)",
6295
- "type": "string"
6377
+ "type": "string",
6378
+ "description": "ruby file to compile, relative to the repository root (default main.rb)"
6296
6379
  },
6297
6380
  "bin": {
6298
- "description": "name of the executable written to bin/ (default: the repository name)",
6299
- "type": "string"
6381
+ "type": "string",
6382
+ "description": "name of the executable written to bin/ (default: the repository name)"
6300
6383
  },
6301
6384
  "tag_prefix": {
6302
- "description": "text before the version in each git tag, such as v",
6303
- "type": "string"
6385
+ "type": "string",
6386
+ "description": "text before the version in each git tag, such as v"
6304
6387
  },
6305
6388
  "source_ref": {
6306
- "description": "full 40-character commit SHA to build instead of the tag",
6307
6389
  "type": "string",
6390
+ "description": "full 40-character commit SHA to build instead of the tag",
6308
6391
  "pattern": "^[0-9a-fA-F]{40}$"
6309
6392
  },
6310
6393
  "spinel": {
6311
- "description": "spinel compiler to run (default: spinel on PATH)",
6312
- "type": "string"
6394
+ "type": "string",
6395
+ "description": "spinel compiler to run (default: spinel on PATH)"
6313
6396
  }
6314
6397
  }
6315
6398
  },
@@ -6349,24 +6432,24 @@
6349
6432
  "type": "object",
6350
6433
  "properties": {
6351
6434
  "provider": {
6352
- "description": "git host used for release info and assets",
6353
6435
  "type": "string",
6436
+ "description": "git host used for release info and assets",
6354
6437
  "enum": [
6355
6438
  "github",
6356
6439
  "gitlab"
6357
6440
  ]
6358
6441
  },
6359
6442
  "api_url": {
6360
- "description": "provider api url, for self-hosted instances",
6361
- "type": "string"
6443
+ "type": "string",
6444
+ "description": "provider api url, for self-hosted instances"
6362
6445
  },
6363
6446
  "artifactbundle": {
6364
6447
  "description": "true requires an artifactbundle, false forces a source build, unset tries the bundle first",
6365
6448
  "$ref": "#/$defs/tool_bool"
6366
6449
  },
6367
6450
  "artifactbundle_asset": {
6368
- "description": "specific *.artifactbundle.zip release asset to use",
6369
- "type": "string"
6451
+ "type": "string",
6452
+ "description": "specific *.artifactbundle.zip release asset to use"
6370
6453
  },
6371
6454
  "filter_bins": {
6372
6455
  "description": "executable products to install",
@@ -6383,8 +6466,8 @@
6383
6466
  ]
6384
6467
  },
6385
6468
  "install_command": {
6386
- "description": "command run in the checkout instead of swift build; incompatible with filter_bins",
6387
- "type": "string"
6469
+ "type": "string",
6470
+ "description": "command run in the checkout instead of swift build; incompatible with filter_bins"
6388
6471
  }
6389
6472
  }
6390
6473
  },
@@ -6395,6 +6478,7 @@
6395
6478
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
6396
6479
  },
6397
6480
  "additionalProperties": {
6481
+ "description": "options for this platform, overriding the same options set for the whole tool",
6398
6482
  "type": "object",
6399
6483
  "properties": {
6400
6484
  "provider": {
@@ -6448,44 +6532,44 @@
6448
6532
  "type": "object",
6449
6533
  "properties": {
6450
6534
  "exe": {
6451
- "description": "name of the executable inside the archive to extract",
6452
- "type": "string"
6535
+ "type": "string",
6536
+ "description": "name of the executable inside the archive to extract"
6453
6537
  },
6454
6538
  "rename_exe": {
6455
- "description": "name to give the extracted executable",
6456
- "type": "string"
6539
+ "type": "string",
6540
+ "description": "name to give the extracted executable"
6457
6541
  },
6458
6542
  "matching": {
6459
- "description": "substring to match release filenames when several match the os and arch",
6460
- "type": "string"
6543
+ "type": "string",
6544
+ "description": "substring to match release filenames when several match the os and arch"
6461
6545
  },
6462
6546
  "matching_regex": {
6463
- "description": "regex release filenames must match before os and arch matching",
6464
- "type": "string"
6547
+ "type": "string",
6548
+ "description": "regex release filenames must match before os and arch matching"
6465
6549
  },
6466
6550
  "provider": {
6467
- "description": "forge used to fetch releases and assets",
6468
6551
  "type": "string",
6552
+ "description": "forge used to fetch releases and assets",
6469
6553
  "enum": [
6470
6554
  "github",
6471
6555
  "gitlab"
6472
6556
  ]
6473
6557
  },
6474
6558
  "api_url": {
6475
- "description": "provider api base url, for self-hosted instances",
6476
- "type": "string"
6559
+ "type": "string",
6560
+ "description": "provider api base url, for self-hosted instances"
6477
6561
  },
6478
6562
  "tag_regex": {
6479
- "description": "regex release tags must match to be listed as versions",
6480
- "type": "string"
6563
+ "type": "string",
6564
+ "description": "regex release tags must match to be listed as versions"
6481
6565
  },
6482
6566
  "extract_all": {
6483
6567
  "description": "extract every file in the archive instead of only the binary",
6484
6568
  "$ref": "#/$defs/tool_bool"
6485
6569
  },
6486
6570
  "bin_path": {
6487
- "description": "directory in the install containing binaries, used with extract_all",
6488
- "type": "string"
6571
+ "type": "string",
6572
+ "description": "directory in the install containing binaries, used with extract_all"
6489
6573
  }
6490
6574
  }
6491
6575
  },
@@ -6496,6 +6580,7 @@
6496
6580
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
6497
6581
  },
6498
6582
  "additionalProperties": {
6583
+ "description": "options for this platform, overriding the same options set for the whole tool",
6499
6584
  "type": "object",
6500
6585
  "properties": {
6501
6586
  "bin_path": {
@@ -6505,79 +6590,81 @@
6505
6590
  }
6506
6591
  },
6507
6592
  "vars": {
6508
- "description": "variables to set",
6509
6593
  "type": "object",
6594
+ "description": "variables to set",
6510
6595
  "properties": {
6511
6596
  "_": {
6597
+ "type": "object",
6512
6598
  "description": "vars modules",
6513
- "additionalProperties": true,
6514
6599
  "properties": {
6515
6600
  "file": {
6601
+ "description": "files to load variables from (dotenv, json, yaml, or toml)",
6516
6602
  "oneOf": [
6517
6603
  {
6518
6604
  "$ref": "#/$defs/env_directive"
6519
6605
  },
6520
6606
  {
6521
- "description": "environment file to load (dotenv, json, yaml, or toml)",
6522
- "type": "string"
6607
+ "type": "string",
6608
+ "description": "environment file to load (dotenv, json, yaml, or toml)"
6523
6609
  },
6524
6610
  {
6611
+ "type": "array",
6525
6612
  "description": "environment files to load (dotenv, json, yaml, or toml)",
6526
6613
  "items": {
6527
6614
  "oneOf": [
6528
6615
  {
6529
- "description": "environment file to load (dotenv, json, yaml, or toml)",
6530
- "type": "string"
6616
+ "type": "string",
6617
+ "description": "environment file to load (dotenv, json, yaml, or toml)"
6531
6618
  },
6532
6619
  {
6533
6620
  "$ref": "#/$defs/env_directive"
6534
6621
  }
6535
6622
  ]
6536
- },
6537
- "type": "array"
6623
+ }
6538
6624
  }
6539
6625
  ]
6540
6626
  },
6541
6627
  "source": {
6628
+ "description": "bash scripts to run, taking the variables they export",
6542
6629
  "oneOf": [
6543
6630
  {
6544
6631
  "$ref": "#/$defs/env_directive"
6545
6632
  },
6546
6633
  {
6547
- "description": "bash script to load",
6548
- "type": "string"
6634
+ "type": "string",
6635
+ "description": "bash script to load"
6549
6636
  },
6550
6637
  {
6638
+ "type": "array",
6551
6639
  "description": "bash scripts to load",
6552
6640
  "items": {
6553
6641
  "oneOf": [
6554
6642
  {
6555
- "description": "bash script to load",
6556
- "type": "string"
6643
+ "type": "string",
6644
+ "description": "bash script to load"
6557
6645
  },
6558
6646
  {
6559
6647
  "$ref": "#/$defs/env_directive"
6560
6648
  }
6561
6649
  ]
6562
- },
6563
- "type": "array"
6650
+ }
6564
6651
  }
6565
6652
  ]
6566
6653
  }
6567
6654
  },
6568
- "type": "object"
6655
+ "additionalProperties": true
6569
6656
  }
6570
6657
  },
6571
6658
  "additionalProperties": {
6572
6659
  "description": "a variable: its value, or a table with `value`, `default`, `required` or `age`",
6573
6660
  "oneOf": [
6574
6661
  {
6575
- "description": "value of variable",
6576
- "type": "string"
6662
+ "type": "string",
6663
+ "description": "value of variable"
6577
6664
  },
6578
6665
  {
6579
- "description": "value of variable",
6580
- "type": "integer"
6666
+ "type": "integer",
6667
+ "description": "value of variable"
6581
6668
  },
6582
6669
  {
6583
6670
  "description": "value of variable",
@@ -6585,8 +6672,12 @@
6585
6672
  },
6586
6673
  {
6587
6674
  "type": "object",
6675
+ "required": [
6676
+ "value"
6677
+ ],
6588
6678
  "properties": {
6589
6679
  "value": {
6680
+ "description": "value of variable",
6590
6681
  "oneOf": [
6591
6682
  {
6592
6683
  "type": "string"
@@ -6606,20 +6697,20 @@
6606
6697
  "$ref": "#/$defs/env_redact"
6607
6698
  }
6608
6699
  },
6609
- "required": [
6610
- "value"
6611
- ],
6612
6700
  "unevaluatedProperties": false
6613
6701
  },
6614
6702
  {
6615
6703
  "type": "object",
6704
+ "required": [
6705
+ "default"
6706
+ ],
6616
6707
  "properties": {
6617
6708
  "default": {
6618
6709
  "$ref": "#/$defs/env_default"
6619
6710
  },
6620
6711
  "prompt": {
6621
- "description": "question to ask once, on a machine with no saved answer, when a command is run with a prompt flag such as mise bootstrap --prompt-vars",
6622
- "type": "string"
6712
+ "type": "string",
6713
+ "description": "question to ask once, on a machine with no saved answer, when a command is run with a prompt flag such as mise bootstrap --prompt-vars"
6623
6714
  },
6624
6715
  "tools": {
6625
6716
  "$ref": "#/$defs/env_tools"
@@ -6628,17 +6719,17 @@
6628
6719
  "$ref": "#/$defs/env_redact"
6629
6720
  }
6630
6721
  },
6631
- "required": [
6632
- "default"
6633
- ],
6634
6722
  "unevaluatedProperties": false
6635
6723
  },
6636
6724
  {
6637
6725
  "type": "object",
6726
+ "required": [
6727
+ "required"
6728
+ ],
6638
6729
  "properties": {
6639
6730
  "prompt": {
6640
- "description": "question to ask once, on a machine with no saved answer, when a command is run with a prompt flag such as mise bootstrap --prompt-vars",
6641
- "type": "string"
6731
+ "type": "string",
6732
+ "description": "question to ask once, on a machine with no saved answer, when a command is run with a prompt flag such as mise bootstrap --prompt-vars"
6642
6733
  },
6643
6734
  "tools": {
6644
6735
  "$ref": "#/$defs/env_tools"
@@ -6647,6 +6738,7 @@
6647
6738
  "$ref": "#/$defs/env_redact"
6648
6739
  },
6649
6740
  "required": {
6741
+ "description": "fail unless the process environment, a higher-precedence config file, or a saved answer supplies a value: true, or help text shown in the error",
6650
6742
  "oneOf": [
6651
6743
  {
6652
6744
  "const": true
@@ -6657,13 +6749,14 @@
6657
6749
  ]
6658
6750
  }
6659
6751
  },
6660
- "required": [
6661
- "required"
6662
- ],
6663
6752
  "unevaluatedProperties": false
6664
6753
  },
6665
6754
  {
6666
6755
  "type": "object",
6756
+ "description": "[experimental] age-encrypted variable",
6757
+ "required": [
6758
+ "age"
6759
+ ],
6667
6760
  "properties": {
6668
6761
  "age": {
6669
6762
  "$ref": "#/$defs/env_age"
@@ -6675,17 +6768,17 @@
6675
6768
  "$ref": "#/$defs/env_redact"
6676
6769
  }
6677
6770
  },
6678
- "required": [
6679
- "age"
6680
- ],
6681
- "unevaluatedProperties": false,
6682
- "description": "[experimental] age-encrypted variable"
6771
+ "unevaluatedProperties": false
6683
6772
  },
6684
6773
  {
6685
6774
  "type": "object",
6775
+ "required": [
6776
+ "age"
6777
+ ],
6686
6778
  "properties": {
6687
6779
  "age": {
6688
6780
  "type": "object",
6781
+ "description": "[experimental] age-encrypted value (complex format)",
6689
6782
  "properties": {
6690
6783
  "value": {
6691
6784
  "$ref": "#/$defs/env_age_value"
@@ -6703,13 +6796,9 @@
6703
6796
  "required": [
6704
6797
  "value"
6705
6798
  ],
6706
- "unevaluatedProperties": false,
6707
- "description": "[experimental] age-encrypted value (complex format)"
6799
+ "unevaluatedProperties": false
6708
6800
  }
6709
6801
  },
6710
- "required": [
6711
- "age"
6712
- ],
6713
6802
  "unevaluatedProperties": false
6714
6803
  }
6715
6804
  ]
@@ -6827,7 +6916,8 @@
6827
6916
  "type": "object",
6828
6917
  "description": "environment variables set for the wrapper",
6829
6918
  "additionalProperties": {
6830
- "type": "string"
6919
+ "type": "string",
6920
+ "description": "value of this environment variable"
6831
6921
  }
6832
6922
  }
6833
6923
  },
@@ -6960,10 +7050,11 @@
6960
7050
  },
6961
7051
  "secrets": {
6962
7052
  "type": "object",
7053
+ "description": "[experimental] Sources for mise secrets: values resolved only when mise starts a task or `mise x` command that was granted them. Project config only.",
6963
7054
  "properties": {
6964
7055
  "fnox": {
6965
- "description": "Use fnox (fnox.toml discovered from this config's directory). https://mise.jdx.dev/environments/secrets/fnox.html",
6966
7056
  "type": "object",
7057
+ "description": "Use fnox (fnox.toml discovered from this config's directory). https://mise.jdx.dev/environments/secrets/fnox.html",
6967
7058
  "additionalProperties": false,
6968
7059
  "properties": {
6969
7060
  "profile": {
@@ -6973,7 +7064,7 @@
6973
7064
  }
6974
7065
  }
6975
7066
  },
6976
- "description": "[experimental] Sources for mise secrets: values resolved only when mise starts a task or `mise x` command that was granted them. Project config only."
7067
+ "additionalProperties": true
6977
7068
  },
6978
7069
  "redactions": {
6979
7070
  "type": "array",
@@ -6992,13 +7083,14 @@
6992
7083
  },
6993
7084
  "deps": {
6994
7085
  "type": "object",
7086
+ "description": "[experimental] configure deps providers",
6995
7087
  "properties": {
6996
7088
  "disable": {
6997
7089
  "type": "array",
7090
+ "description": "Disable specific deps providers",
6998
7091
  "items": {
6999
7092
  "type": "string"
7000
- },
7001
- "description": "Disable specific deps providers"
7093
+ }
7002
7094
  },
7003
7095
  "npm": {
7004
7096
  "$ref": "#/$defs/deps_provider"
@@ -7048,12 +7140,11 @@
7048
7140
  },
7049
7141
  "additionalProperties": {
7050
7142
  "$ref": "#/$defs/deps_provider"
7051
- },
7052
- "description": "configure deps providers"
7143
+ }
7053
7144
  },
7054
7145
  "oci": {
7055
7146
  "type": "object",
7056
- "description": "configuration for `mise oci build`",
7147
+ "description": "[experimental] configuration for `mise oci build`",
7057
7148
  "additionalProperties": false,
7058
7149
  "properties": {
7059
7150
  "from": {
@@ -7133,14 +7224,16 @@
7133
7224
  "type": "object",
7134
7225
  "description": "Extra env vars baked into the image config",
7135
7226
  "additionalProperties": {
7136
- "type": "string"
7227
+ "type": "string",
7228
+ "description": "value of this environment variable"
7137
7229
  }
7138
7230
  },
7139
7231
  "labels": {
7140
7232
  "type": "object",
7141
7233
  "description": "Labels baked into the image config",
7142
7234
  "additionalProperties": {
7143
- "type": "string"
7235
+ "type": "string",
7236
+ "description": "value of this image label"
7144
7237
  }
7145
7238
  }
7146
7239
  }
@@ -7154,6 +7247,7 @@
7154
7247
  "type": "object",
7155
7248
  "description": "dotfiles applied with `mise dotfiles apply` or `mise bootstrap`, keyed by target path or a logical name when every variant overrides the target; an omitted source for the latter resolves the relative key under dotfiles.root",
7156
7249
  "additionalProperties": {
7250
+ "description": "a dotfile: the source path of a whole-file entry, or a table describing a whole-file entry or an edit",
7157
7251
  "oneOf": [
7158
7252
  {
7159
7253
  "type": "string",
@@ -7310,6 +7404,7 @@
7310
7404
  "type": "object",
7311
7405
  "properties": {
7312
7406
  "os": {
7407
+ "description": "operating system (linux, macos, windows, or unix), optionally with an architecture such as linux/arm64; a list matches any of its values",
7313
7408
  "oneOf": [
7314
7409
  {
7315
7410
  "type": "string"
@@ -7327,7 +7422,8 @@
7327
7422
  "description": "mise environment selected with -E or MISE_ENV"
7328
7423
  },
7329
7424
  "default": {
7330
- "type": "boolean"
7425
+ "type": "boolean",
7426
+ "description": "true marks the fallback for machines that match no other variant; takes no os or profile"
7331
7427
  },
7332
7428
  "machine": {
7333
7429
  "type": "boolean",
@@ -7722,6 +7818,7 @@
7722
7818
  "description": "named directory trees of dotfiles, applied with `mise dotfiles apply` or `mise bootstrap` while [bootstrap] dotfile_groups selects them (or is unset)",
7723
7819
  "additionalProperties": {
7724
7820
  "type": "object",
7821
+ "description": "a directory tree of dotfiles deployed into a target directory",
7725
7822
  "additionalProperties": false,
7726
7823
  "properties": {
7727
7824
  "root": {
@@ -7770,6 +7867,7 @@
7770
7867
  "type": "object",
7771
7868
  "description": "whole-file entries for parts of the tree, keyed by target path inside the group's target and written like [dotfiles] entries; each is cut out of the walk. A missing source is found under the root at the entry's path inside the target, and a relative source starts at the root",
7772
7869
  "additionalProperties": {
7870
+ "description": "a whole-file entry for a path inside the group's target: its source path, or a table as in [dotfiles]",
7773
7871
  "oneOf": [
7774
7872
  {
7775
7873
  "type": "string",
@@ -7800,28 +7898,35 @@
7800
7898
  "description": "Managed system files keyed by absolute target path",
7801
7899
  "additionalProperties": {
7802
7900
  "type": "object",
7901
+ "description": "file whose content, owner, group, and mode mise manages, keyed by an absolute or ~/ target path",
7803
7902
  "properties": {
7804
7903
  "phase": {
7805
7904
  "$ref": "#/$defs/bootstrap_file_phase",
7806
7905
  "default": "post-packages"
7807
7906
  },
7808
7907
  "source": {
7809
- "type": "string"
7908
+ "type": "string",
7909
+ "description": "file to copy the content from; a relative path resolves from the declaring config's directory and ~/ from your home directory"
7810
7910
  },
7811
7911
  "content": {
7812
- "type": "string"
7912
+ "type": "string",
7913
+ "description": "inline file content; cannot be combined with source"
7813
7914
  },
7814
7915
  "owner": {
7815
- "type": "string"
7916
+ "type": "string",
7917
+ "description": "user that should own the file; left as it is when unset"
7816
7918
  },
7817
7919
  "group": {
7818
- "type": "string"
7920
+ "type": "string",
7921
+ "description": "group that should own the file; left as it is when unset"
7819
7922
  },
7820
7923
  "mode": {
7821
- "type": "string"
7924
+ "type": "string",
7925
+ "description": "octal permissions such as \"0640\"; defaults to \"0644\" for a file with source or content, otherwise left as it is"
7822
7926
  },
7823
7927
  "template": {
7824
7928
  "type": "boolean",
7929
+ "description": "render source or content with mise's template engine; without it, template syntax is written unchanged",
7825
7930
  "default": false
7826
7931
  },
7827
7932
  "remove_empty": {
@@ -7831,6 +7936,7 @@
7831
7936
  },
7832
7937
  "state": {
7833
7938
  "type": "string",
7939
+ "description": "present creates or updates the file; absent removes it whatever its content",
7834
7940
  "enum": [
7835
7941
  "present",
7836
7942
  "absent"
@@ -7838,10 +7944,12 @@
7838
7944
  },
7839
7945
  "replace": {
7840
7946
  "type": "boolean",
7947
+ "description": "replace a path of another type at the target, such as an empty directory; requires source or content",
7841
7948
  "default": false
7842
7949
  },
7843
7950
  "notify": {
7844
7951
  "type": "array",
7952
+ "description": "system services declared in [bootstrap.services] to reload or restart when mise changes this file",
7845
7953
  "items": {
7846
7954
  "type": "string"
7847
7955
  }
@@ -7937,22 +8045,27 @@
7937
8045
  "description": "Managed system directories keyed by absolute target path",
7938
8046
  "additionalProperties": {
7939
8047
  "type": "object",
8048
+ "description": "directory whose owner, group, and mode mise manages, keyed by an absolute or ~/ target path",
7940
8049
  "properties": {
7941
8050
  "phase": {
7942
8051
  "$ref": "#/$defs/bootstrap_file_phase",
7943
8052
  "default": "post-packages"
7944
8053
  },
7945
8054
  "owner": {
7946
- "type": "string"
8055
+ "type": "string",
8056
+ "description": "user that should own the directory; left as it is when unset, and parents mise creates get the system defaults"
7947
8057
  },
7948
8058
  "group": {
7949
- "type": "string"
8059
+ "type": "string",
8060
+ "description": "group that should own the directory; left as it is when unset, and parents mise creates get the system defaults"
7950
8061
  },
7951
8062
  "mode": {
7952
- "type": "string"
8063
+ "type": "string",
8064
+ "description": "octal permissions such as \"0755\"; defaults to \"0755\""
7953
8065
  },
7954
8066
  "state": {
7955
8067
  "type": "string",
8068
+ "description": "present creates the directory with any missing parents; absent removes it, which must then be empty unless recursive is set",
7956
8069
  "enum": [
7957
8070
  "present",
7958
8071
  "absent"
@@ -7960,14 +8073,17 @@
7960
8073
  },
7961
8074
  "recursive": {
7962
8075
  "type": "boolean",
8076
+ "description": "with state = \"absent\", delete the directory and everything in it",
7963
8077
  "default": false
7964
8078
  },
7965
8079
  "replace": {
7966
8080
  "type": "boolean",
8081
+ "description": "replace a path of another type at the target, such as a file",
7967
8082
  "default": false
7968
8083
  },
7969
8084
  "notify": {
7970
8085
  "type": "array",
8086
+ "description": "system services declared in [bootstrap.services] to reload or restart when mise changes this directory",
7971
8087
  "items": {
7972
8088
  "type": "string"
7973
8089
  }
@@ -8038,6 +8154,7 @@
8038
8154
  "description": "remote bootstrap inventory keyed by target name",
8039
8155
  "additionalProperties": {
8040
8156
  "type": "object",
8157
+ "description": "SSH target that `mise bootstrap remote` can bootstrap, selected by name or tag",
8041
8158
  "properties": {
8042
8159
  "host": {
8043
8160
  "type": "string",
@@ -8131,9 +8248,11 @@
8131
8248
  "description": "System services and portable user services managed by mise bootstrap, keyed by service name",
8132
8249
  "additionalProperties": {
8133
8250
  "type": "object",
8251
+ "description": "Linux systemd system unit that mise starts, stops, enables, or masks, or a user service mise defines from command or builtin",
8134
8252
  "properties": {
8135
8253
  "state": {
8136
8254
  "type": "string",
8255
+ "description": "running or stopped; absent removes a user service's definition (user scope only)",
8137
8256
  "enum": [
8138
8257
  "running",
8139
8258
  "stopped",
@@ -8143,6 +8262,7 @@
8143
8262
  },
8144
8263
  "enabled": {
8145
8264
  "type": "boolean",
8265
+ "description": "start the service at boot (system scope) or at login (user scope)",
8146
8266
  "default": true
8147
8267
  },
8148
8268
  "masked": {
@@ -8183,10 +8303,12 @@
8183
8303
  "minLength": 1
8184
8304
  },
8185
8305
  "description": {
8186
- "type": "string"
8306
+ "type": "string",
8307
+ "description": "text the service manager shows for the service; user scope only"
8187
8308
  },
8188
8309
  "restart": {
8189
8310
  "type": "string",
8311
+ "description": "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",
8190
8312
  "enum": [
8191
8313
  "always",
8192
8314
  "on-failure",
@@ -8196,15 +8318,19 @@
8196
8318
  },
8197
8319
  "environment": {
8198
8320
  "type": "object",
8321
+ "description": "environment variables for the process; user scope only",
8199
8322
  "additionalProperties": {
8200
- "type": "string"
8323
+ "type": "string",
8324
+ "description": "value of the environment variable"
8201
8325
  }
8202
8326
  },
8203
8327
  "working_directory": {
8204
- "type": "string"
8328
+ "type": "string",
8329
+ "description": "directory to run the process in, with ~ expanded; user scope only"
8205
8330
  },
8206
8331
  "requires_tools": {
8207
8332
  "type": "boolean",
8333
+ "description": "start the service only after `mise bootstrap` installs [tools] and plugin packages; user scope only",
8208
8334
  "default": false
8209
8335
  }
8210
8336
  },
@@ -8222,6 +8348,7 @@
8222
8348
  "description": "Docker Compose projects managed with `mise bootstrap compose`, keyed by project name. Text fields support Tera templates.",
8223
8349
  "additionalProperties": {
8224
8350
  "type": "object",
8351
+ "description": "Docker Compose project that mise brings up, stops, or removes",
8225
8352
  "properties": {
8226
8353
  "project_dir": {
8227
8354
  "type": "string",
@@ -8248,24 +8375,28 @@
8248
8375
  },
8249
8376
  "profiles": {
8250
8377
  "type": "array",
8378
+ "description": "Compose profiles to enable, passed with --profile",
8251
8379
  "items": {
8252
8380
  "type": "string"
8253
8381
  }
8254
8382
  },
8255
8383
  "services": {
8256
8384
  "type": "array",
8385
+ "description": "services to manage; defaults to every service the files and profiles enable",
8257
8386
  "items": {
8258
8387
  "type": "string"
8259
8388
  }
8260
8389
  },
8261
8390
  "oneshot": {
8262
8391
  "type": "array",
8392
+ "description": "services that run once and count as converged after exiting with code 0; when services is set, they must be listed there too",
8263
8393
  "items": {
8264
8394
  "type": "string"
8265
8395
  }
8266
8396
  },
8267
8397
  "state": {
8268
8398
  "type": "string",
8399
+ "description": "running (compose up), stopped (compose stop, keeping containers and data), or absent (compose down)",
8269
8400
  "enum": [
8270
8401
  "running",
8271
8402
  "stopped",
@@ -8275,6 +8406,7 @@
8275
8406
  },
8276
8407
  "pull": {
8277
8408
  "type": "string",
8409
+ "description": "image pull policy passed to compose up as --pull",
8278
8410
  "enum": [
8279
8411
  "always",
8280
8412
  "missing",
@@ -8284,6 +8416,7 @@
8284
8416
  },
8285
8417
  "build": {
8286
8418
  "type": "string",
8419
+ "description": "auto lets Compose decide, always passes --build, never passes --no-build",
8287
8420
  "enum": [
8288
8421
  "auto",
8289
8422
  "always",
@@ -8293,6 +8426,7 @@
8293
8426
  },
8294
8427
  "recreate": {
8295
8428
  "type": "string",
8429
+ "description": "auto lets Compose decide, always passes --force-recreate, never passes --no-recreate",
8296
8430
  "enum": [
8297
8431
  "auto",
8298
8432
  "always",
@@ -8302,6 +8436,7 @@
8302
8436
  },
8303
8437
  "wait": {
8304
8438
  "type": "boolean",
8439
+ "description": "pass --wait to compose up, so it waits for services to be running and healthy",
8305
8440
  "default": true
8306
8441
  },
8307
8442
  "wait_timeout": {
@@ -8316,18 +8451,22 @@
8316
8451
  },
8317
8452
  "remove_orphans": {
8318
8453
  "type": "boolean",
8454
+ "description": "remove containers for services that are no longer in the Compose model",
8319
8455
  "default": true
8320
8456
  },
8321
8457
  "renew_anonymous_volumes": {
8322
8458
  "type": "boolean",
8459
+ "description": "pass --renew-anon-volumes to compose up, recreating anonymous volumes",
8323
8460
  "default": false
8324
8461
  },
8325
8462
  "down_volumes": {
8326
8463
  "type": "boolean",
8464
+ "description": "pass --volumes to compose down, removing the project's volumes",
8327
8465
  "default": false
8328
8466
  },
8329
8467
  "down_images": {
8330
8468
  "type": "string",
8469
+ "description": "images compose down removes, passed as --rmi",
8331
8470
  "enum": [
8332
8471
  "local",
8333
8472
  "all"
@@ -8335,6 +8474,7 @@
8335
8474
  },
8336
8475
  "sudo": {
8337
8476
  "type": "boolean",
8477
+ "description": "run every Compose and engine command through sudo, for a project on the system Docker daemon",
8338
8478
  "default": false
8339
8479
  },
8340
8480
  "command": {
@@ -8489,6 +8629,7 @@
8489
8629
  "description": "git repositories to clone or update with `mise bootstrap repos apply`, keyed by target path",
8490
8630
  "additionalProperties": {
8491
8631
  "type": "object",
8632
+ "description": "git repository to clone to this path, then keep on ref when one is set",
8492
8633
  "properties": {
8493
8634
  "url": {
8494
8635
  "type": "string",
@@ -8550,13 +8691,16 @@
8550
8691
  "type": "object",
8551
8692
  "properties": {
8552
8693
  "domain": {
8553
- "type": "string"
8694
+ "type": "string",
8695
+ "description": "preferences domain, such as \"com.apple.dock\" or \"NSGlobalDomain\"; -g and -globalDomain mean NSGlobalDomain"
8554
8696
  },
8555
8697
  "key": {
8556
- "type": "string"
8698
+ "type": "string",
8699
+ "description": "preference key within the domain"
8557
8700
  },
8558
8701
  "host": {
8559
8702
  "type": "string",
8703
+ "description": "any writes the preference for every host; current writes it for this machine only, like defaults -currentHost",
8560
8704
  "enum": [
8561
8705
  "any",
8562
8706
  "current"
@@ -8572,6 +8716,7 @@
8572
8716
  "minItems": 1
8573
8717
  },
8574
8718
  "value": {
8719
+ "description": "desired value, written with the matching property list type; replaces the selected value in full",
8575
8720
  "anyOf": [
8576
8721
  {
8577
8722
  "type": "boolean"
@@ -8608,6 +8753,7 @@
8608
8753
  "description": "macOS user LaunchAgents to write and load with `mise bootstrap macos launchd-agents apply`",
8609
8754
  "additionalProperties": {
8610
8755
  "type": "object",
8756
+ "description": "macOS LaunchAgent written to ~/Library/LaunchAgents/dev.mise.<name>.plist and loaded for the current user",
8611
8757
  "properties": {
8612
8758
  "program": {
8613
8759
  "type": "string",
@@ -8691,7 +8837,8 @@
8691
8837
  "type": "object",
8692
8838
  "description": "environment variables for EnvironmentVariables",
8693
8839
  "additionalProperties": {
8694
- "type": "string"
8840
+ "type": "string",
8841
+ "description": "value of the environment variable"
8695
8842
  }
8696
8843
  },
8697
8844
  "working_directory": {
@@ -8833,6 +8980,7 @@
8833
8980
  },
8834
8981
  "state": {
8835
8982
  "type": "string",
8983
+ "description": "present adds the rule; absent removes a rule mise added earlier",
8836
8984
  "enum": [
8837
8985
  "present",
8838
8986
  "absent"
@@ -8841,6 +8989,7 @@
8841
8989
  },
8842
8990
  "direction": {
8843
8991
  "type": "string",
8992
+ "description": "traffic direction the rule matches",
8844
8993
  "enum": [
8845
8994
  "incoming",
8846
8995
  "outgoing"
@@ -8849,6 +8998,7 @@
8849
8998
  },
8850
8999
  "action": {
8851
9000
  "type": "string",
9001
+ "description": "what to do with matching traffic; limit needs incoming TCP and is not available on firewalld",
8852
9002
  "enum": [
8853
9003
  "allow",
8854
9004
  "limit",
@@ -8873,6 +9023,7 @@
8873
9023
  },
8874
9024
  "protocol": {
8875
9025
  "type": "string",
9026
+ "description": "protocol to match; any when unset, and UFW supports only tcp and udp",
8876
9027
  "enum": [
8877
9028
  "tcp",
8878
9029
  "udp",
@@ -8914,6 +9065,7 @@
8914
9065
  "description": "systemd user services and timers to write and start with `mise bootstrap linux systemd-units apply`",
8915
9066
  "additionalProperties": {
8916
9067
  "type": "object",
9068
+ "description": "systemd user unit written to ~/.config/systemd/user/dev.mise.<name>.service, or .timer when it sets a timer key",
8917
9069
  "properties": {
8918
9070
  "description": {
8919
9071
  "type": "string",
@@ -9043,7 +9195,8 @@
9043
9195
  "type": "object",
9044
9196
  "description": "environment variables for Environment entries",
9045
9197
  "additionalProperties": {
9046
- "type": "string"
9198
+ "type": "string",
9199
+ "description": "value of the environment variable"
9047
9200
  }
9048
9201
  },
9049
9202
  "environment_file": {
@@ -9426,7 +9579,8 @@
9426
9579
  "type": "object",
9427
9580
  "description": "Homebrew tap names mapped to custom git URLs",
9428
9581
  "additionalProperties": {
9429
- "type": "string"
9582
+ "type": "string",
9583
+ "description": "git URL of the tap's GitHub repository, used instead of https://github.com/<owner>/homebrew-<tap>.git"
9430
9584
  }
9431
9585
  }
9432
9586
  },
@@ -9483,6 +9637,7 @@
9483
9637
  "description": "[experimental] Linux groups that bootstrap creates or removes, keyed by group name",
9484
9638
  "additionalProperties": {
9485
9639
  "type": "object",
9640
+ "description": "local Linux group that bootstrap creates, updates, or removes",
9486
9641
  "properties": {
9487
9642
  "state": {
9488
9643
  "description": "whether the group should exist",
@@ -9537,6 +9692,7 @@
9537
9692
  "description": "[experimental] Linux users that bootstrap creates or removes, keyed by user name",
9538
9693
  "additionalProperties": {
9539
9694
  "type": "object",
9695
+ "description": "local Linux user that bootstrap creates, updates, or removes",
9540
9696
  "properties": {
9541
9697
  "state": {
9542
9698
  "description": "whether the user should exist",
@@ -9709,6 +9865,7 @@
9709
9865
  "properties": {
9710
9866
  "encryption": {
9711
9867
  "type": "object",
9868
+ "description": "encryption for dotfiles tracked with encrypt = true",
9712
9869
  "additionalProperties": false,
9713
9870
  "properties": {
9714
9871
  "recipients": {
@@ -9738,9 +9895,10 @@
9738
9895
  },
9739
9896
  "reload": {
9740
9897
  "type": "object",
9741
- "description": "commands run once after a rollback or undo writes a path matching the glob (trusted global or system config only)",
9898
+ "description": "commands run once after a rollback, undo, pull, or dotfiles apply writes a path matching the glob (trusted global or system config only)",
9742
9899
  "additionalProperties": {
9743
- "type": "string"
9900
+ "type": "string",
9901
+ "description": "command to run once when a rollback, undo, pull, or dotfiles apply writes a path matching this glob"
9744
9902
  }
9745
9903
  },
9746
9904
  "origin": {
@@ -9790,6 +9948,7 @@
9790
9948
  "tools": {
9791
9949
  "patternProperties": {
9792
9950
  "^github:": {
9951
+ "description": "a tool installed with the github backend",
9793
9952
  "oneOf": [
9794
9953
  {
9795
9954
  "type": "array",
@@ -9803,6 +9962,7 @@
9803
9962
  ]
9804
9963
  },
9805
9964
  "^gitlab:": {
9965
+ "description": "a tool installed with the gitlab backend",
9806
9966
  "oneOf": [
9807
9967
  {
9808
9968
  "type": "array",
@@ -9816,6 +9976,7 @@
9816
9976
  ]
9817
9977
  },
9818
9978
  "^forgejo:": {
9979
+ "description": "a tool installed with the forgejo backend",
9819
9980
  "oneOf": [
9820
9981
  {
9821
9982
  "type": "array",
@@ -9829,6 +9990,7 @@
9829
9990
  ]
9830
9991
  },
9831
9992
  "^ubi:": {
9993
+ "description": "a tool installed with the ubi backend",
9832
9994
  "oneOf": [
9833
9995
  {
9834
9996
  "type": "array",
@@ -9842,6 +10004,7 @@
9842
10004
  ]
9843
10005
  },
9844
10006
  "^http:": {
10007
+ "description": "a tool installed with the http backend",
9845
10008
  "oneOf": [
9846
10009
  {
9847
10010
  "type": "array",
@@ -9855,6 +10018,7 @@
9855
10018
  ]
9856
10019
  },
9857
10020
  "^s3:": {
10021
+ "description": "a tool installed with the s3 backend",
9858
10022
  "oneOf": [
9859
10023
  {
9860
10024
  "type": "array",
@@ -9868,6 +10032,7 @@
9868
10032
  ]
9869
10033
  },
9870
10034
  "^aqua:": {
10035
+ "description": "a tool installed with the aqua backend",
9871
10036
  "oneOf": [
9872
10037
  {
9873
10038
  "type": "array",
@@ -9881,6 +10046,7 @@
9881
10046
  ]
9882
10047
  },
9883
10048
  "^cargo:": {
10049
+ "description": "a tool installed with the cargo backend",
9884
10050
  "oneOf": [
9885
10051
  {
9886
10052
  "type": "array",
@@ -9894,6 +10060,7 @@
9894
10060
  ]
9895
10061
  },
9896
10062
  "^npm:": {
10063
+ "description": "a tool installed with the npm backend",
9897
10064
  "oneOf": [
9898
10065
  {
9899
10066
  "type": "array",
@@ -9907,6 +10074,7 @@
9907
10074
  ]
9908
10075
  },
9909
10076
  "^(pypi|pipx):": {
10077
+ "description": "a tool installed with the pypi backend",
9910
10078
  "oneOf": [
9911
10079
  {
9912
10080
  "type": "array",
@@ -9920,6 +10088,7 @@
9920
10088
  ]
9921
10089
  },
9922
10090
  "^gem:": {
10091
+ "description": "a tool installed with the gem backend",
9923
10092
  "oneOf": [
9924
10093
  {
9925
10094
  "type": "array",
@@ -9933,6 +10102,7 @@
9933
10102
  ]
9934
10103
  },
9935
10104
  "^go:": {
10105
+ "description": "a tool installed with the go backend",
9936
10106
  "oneOf": [
9937
10107
  {
9938
10108
  "type": "array",
@@ -9946,6 +10116,7 @@
9946
10116
  ]
9947
10117
  },
9948
10118
  "^conda:": {
10119
+ "description": "a tool installed with the conda backend",
9949
10120
  "oneOf": [
9950
10121
  {
9951
10122
  "type": "array",
@@ -9959,6 +10130,7 @@
9959
10130
  ]
9960
10131
  },
9961
10132
  "^spm:": {
10133
+ "description": "a tool installed with the spm backend",
9962
10134
  "oneOf": [
9963
10135
  {
9964
10136
  "type": "array",
@@ -9972,6 +10144,7 @@
9972
10144
  ]
9973
10145
  },
9974
10146
  "^packslip:": {
10147
+ "description": "a tool installed with the packslip backend",
9975
10148
  "oneOf": [
9976
10149
  {
9977
10150
  "type": "array",
@@ -9985,6 +10158,7 @@
9985
10158
  ]
9986
10159
  },
9987
10160
  "^spinel:": {
10161
+ "description": "a tool installed with the spinel backend",
9988
10162
  "oneOf": [
9989
10163
  {
9990
10164
  "type": "array",
@@ -9998,6 +10172,7 @@
9998
10172
  ]
9999
10173
  },
10000
10174
  "^(core:)?python(\\[.*\\])?$": {
10175
+ "description": "the core python tool",
10001
10176
  "oneOf": [
10002
10177
  {
10003
10178
  "type": "array",
@@ -10011,6 +10186,7 @@
10011
10186
  ]
10012
10187
  },
10013
10188
  "^(core:)?java(\\[.*\\])?$": {
10189
+ "description": "the core java tool",
10014
10190
  "oneOf": [
10015
10191
  {
10016
10192
  "type": "array",
@@ -10024,6 +10200,7 @@
10024
10200
  ]
10025
10201
  },
10026
10202
  "^(core:)?rust(\\[.*\\])?$": {
10203
+ "description": "the core rust tool",
10027
10204
  "oneOf": [
10028
10205
  {
10029
10206
  "type": "array",
@@ -10037,6 +10214,7 @@
10037
10214
  ]
10038
10215
  },
10039
10216
  "^(core:dotnet|dotnet|dotnet-core)(\\[.*\\])?$": {
10217
+ "description": "the core dotnet tool",
10040
10218
  "oneOf": [
10041
10219
  {
10042
10220
  "type": "array",
@@ -10051,6 +10229,7 @@
10051
10229
  }
10052
10230
  },
10053
10231
  "additionalProperties": {
10232
+ "description": "a version of the tool, or a table with its version and options",
10054
10233
  "oneOf": [
10055
10234
  {
10056
10235
  "items": {
@@ -10080,6 +10259,7 @@
10080
10259
  },
10081
10260
  "_": {
10082
10261
  "type": "object",
10262
+ "description": "free-form data for your own use; mise never reads it",
10083
10263
  "additionalProperties": true
10084
10264
  },
10085
10265
  "doctor": {
@@ -10087,7 +10267,9 @@
10087
10267
  },
10088
10268
  "daemons": {
10089
10269
  "type": "object",
10270
+ "description": "Experimental project daemons: custom pitchfork commands or managed presets.",
10090
10271
  "additionalProperties": {
10272
+ "description": "A daemon: a version request for the preset of the same name, or a table describing a custom command, task, preset, another project's daemon, or a shared provider.",
10091
10273
  "oneOf": [
10092
10274
  {
10093
10275
  "type": "string",
@@ -10095,52 +10277,17 @@
10095
10277
  },
10096
10278
  {
10097
10279
  "type": "object",
10098
- "required": [
10099
- "run"
10100
- ],
10101
- "not": {
10102
- "anyOf": [
10103
- {
10104
- "required": [
10105
- "preset"
10106
- ]
10107
- },
10108
- {
10109
- "required": [
10110
- "project"
10111
- ]
10112
- },
10113
- {
10114
- "required": [
10115
- "task"
10116
- ]
10117
- },
10118
- {
10119
- "required": [
10120
- "args"
10121
- ]
10122
- },
10123
- {
10124
- "required": [
10125
- "provider"
10126
- ]
10127
- },
10128
- {
10129
- "required": [
10130
- "resource"
10131
- ]
10132
- }
10133
- ]
10134
- },
10135
10280
  "properties": {
10136
10281
  "run": {
10137
- "type": "string"
10282
+ "type": "string",
10283
+ "description": "Shell command for the daemon's long-running process."
10138
10284
  },
10139
10285
  "init": {
10140
10286
  "$ref": "#/$defs/daemon_init"
10141
10287
  },
10142
10288
  "mise": {
10143
- "type": "boolean"
10289
+ "type": "boolean",
10290
+ "description": "false runs the process and its setup without the project's tool environment."
10144
10291
  },
10145
10292
  "port": {
10146
10293
  "oneOf": [
@@ -10168,28 +10315,30 @@
10168
10315
  "$ref": "#/$defs/daemon_proxy_idle_timeout"
10169
10316
  }
10170
10317
  },
10171
- "additionalProperties": true
10172
- },
10173
- {
10174
- "type": "object",
10175
10318
  "required": [
10176
- "task"
10319
+ "run"
10177
10320
  ],
10321
+ "additionalProperties": true,
10178
10322
  "not": {
10179
10323
  "anyOf": [
10180
10324
  {
10181
10325
  "required": [
10182
- "run"
10326
+ "preset"
10183
10327
  ]
10184
10328
  },
10185
10329
  {
10186
10330
  "required": [
10187
- "preset"
10331
+ "project"
10188
10332
  ]
10189
10333
  },
10190
10334
  {
10191
10335
  "required": [
10192
- "project"
10336
+ "task"
10337
+ ]
10338
+ },
10339
+ {
10340
+ "required": [
10341
+ "args"
10193
10342
  ]
10194
10343
  },
10195
10344
  {
@@ -10203,15 +10352,18 @@
10203
10352
  ]
10204
10353
  }
10205
10354
  ]
10206
- },
10355
+ }
10356
+ },
10357
+ {
10358
+ "type": "object",
10207
10359
  "properties": {
10208
10360
  "task": {
10209
- "description": "mise task run as this daemon's long-running process",
10210
- "type": "string"
10361
+ "type": "string",
10362
+ "description": "mise task run as this daemon's long-running process"
10211
10363
  },
10212
10364
  "args": {
10213
- "description": "arguments passed to the task after `--`",
10214
10365
  "type": "array",
10366
+ "description": "arguments passed to the task after `--`",
10215
10367
  "items": {
10216
10368
  "type": "string"
10217
10369
  }
@@ -10229,29 +10381,25 @@
10229
10381
  "$ref": "#/$defs/daemon_proxy_idle_timeout"
10230
10382
  }
10231
10383
  },
10232
- "additionalProperties": true
10233
- },
10234
- {
10235
- "type": "object",
10236
10384
  "required": [
10237
- "preset",
10238
- "version"
10385
+ "task"
10239
10386
  ],
10387
+ "additionalProperties": true,
10240
10388
  "not": {
10241
10389
  "anyOf": [
10242
10390
  {
10243
10391
  "required": [
10244
- "project"
10392
+ "run"
10245
10393
  ]
10246
10394
  },
10247
10395
  {
10248
10396
  "required": [
10249
- "task"
10397
+ "preset"
10250
10398
  ]
10251
10399
  },
10252
10400
  {
10253
10401
  "required": [
10254
- "args"
10402
+ "project"
10255
10403
  ]
10256
10404
  },
10257
10405
  {
@@ -10265,15 +10413,19 @@
10265
10413
  ]
10266
10414
  }
10267
10415
  ]
10268
- },
10416
+ }
10417
+ },
10418
+ {
10419
+ "type": "object",
10269
10420
  "properties": {
10270
10421
  "data_dir": {
10271
10422
  "type": "string",
10272
- "minLength": 1,
10273
- "description": "Persistent preset data directory, relative to the declaring project root or absolute. Defaults to mise state storage."
10423
+ "description": "Persistent preset data directory, relative to the declaring project root or absolute. Defaults to mise state storage.",
10424
+ "minLength": 1
10274
10425
  },
10275
10426
  "preset": {
10276
10427
  "type": "string",
10428
+ "description": "Service preset that supplies the daemon's command, port and data directory.",
10277
10429
  "enum": [
10278
10430
  "cockroachdb",
10279
10431
  "nats",
@@ -10283,7 +10435,8 @@
10283
10435
  ]
10284
10436
  },
10285
10437
  "version": {
10286
- "type": "string"
10438
+ "type": "string",
10439
+ "description": "Version request for the preset's tool."
10287
10440
  },
10288
10441
  "port": {
10289
10442
  "$ref": "#/$defs/daemon_port"
@@ -10293,15 +10446,18 @@
10293
10446
  "description": "Overrides for the preset's additional named ports.",
10294
10447
  "additionalProperties": {
10295
10448
  "type": "integer",
10449
+ "description": "Port for this named port of the preset.",
10296
10450
  "minimum": 1,
10297
10451
  "maximum": 65535
10298
10452
  }
10299
10453
  },
10300
10454
  "options": {
10301
- "type": "object"
10455
+ "type": "object",
10456
+ "description": "Preset options, such as `database`."
10302
10457
  },
10303
10458
  "run": {
10304
- "type": "string"
10459
+ "type": "string",
10460
+ "description": "Shell command that replaces the preset's command."
10305
10461
  },
10306
10462
  "init": {
10307
10463
  "$ref": "#/$defs/daemon_init"
@@ -10316,14 +10472,45 @@
10316
10472
  "$ref": "#/$defs/daemon_proxy_idle_timeout"
10317
10473
  }
10318
10474
  },
10319
- "additionalProperties": true
10475
+ "required": [
10476
+ "preset",
10477
+ "version"
10478
+ ],
10479
+ "additionalProperties": true,
10480
+ "not": {
10481
+ "anyOf": [
10482
+ {
10483
+ "required": [
10484
+ "project"
10485
+ ]
10486
+ },
10487
+ {
10488
+ "required": [
10489
+ "task"
10490
+ ]
10491
+ },
10492
+ {
10493
+ "required": [
10494
+ "args"
10495
+ ]
10496
+ },
10497
+ {
10498
+ "required": [
10499
+ "provider"
10500
+ ]
10501
+ },
10502
+ {
10503
+ "required": [
10504
+ "resource"
10505
+ ]
10506
+ }
10507
+ ]
10508
+ }
10320
10509
  },
10321
10510
  {
10322
10511
  "type": "object",
10323
10512
  "description": "Daemon declared by another project, run under that project's namespace and root.",
10324
- "required": [
10325
- "project"
10326
- ],
10513
+ "additionalProperties": false,
10327
10514
  "properties": {
10328
10515
  "project": {
10329
10516
  "type": "string",
@@ -10334,13 +10521,12 @@
10334
10521
  "description": "Daemon name inside the referenced project, when it differs from this key."
10335
10522
  }
10336
10523
  },
10337
- "additionalProperties": false
10524
+ "required": [
10525
+ "project"
10526
+ ]
10338
10527
  },
10339
10528
  {
10340
10529
  "type": "object",
10341
- "required": [
10342
- "provider"
10343
- ],
10344
10530
  "additionalProperties": false,
10345
10531
  "properties": {
10346
10532
  "provider": {
@@ -10349,29 +10535,27 @@
10349
10535
  },
10350
10536
  "resource": {
10351
10537
  "type": "string",
10352
- "pattern": "^[a-z][a-z0-9_]{0,62}$",
10353
- "description": "Database or NATS account shared by consumers choosing this name. Omit for a checkout-specific resource."
10538
+ "description": "Database or NATS account shared by consumers choosing this name. Omit for a checkout-specific resource.",
10539
+ "pattern": "^[a-z][a-z0-9_]{0,62}$"
10354
10540
  }
10355
- }
10541
+ },
10542
+ "required": [
10543
+ "provider"
10544
+ ]
10356
10545
  }
10357
10546
  ]
10358
- },
10359
- "description": "Experimental project daemons: custom pitchfork commands or managed presets."
10547
+ }
10360
10548
  },
10361
10549
  "daemon_providers": {
10362
10550
  "type": "object",
10363
- "propertyNames": {
10364
- "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
10365
- },
10551
+ "description": "Experimental shared servers owned by the user. Only allowed in global configuration.",
10366
10552
  "additionalProperties": {
10367
10553
  "type": "object",
10368
- "required": [
10369
- "preset",
10370
- "version"
10371
- ],
10554
+ "description": "A PostgreSQL, CockroachDB or NATS server that every checkout shares, with a separate database or NATS account for each.",
10372
10555
  "additionalProperties": false,
10373
10556
  "properties": {
10374
10557
  "preset": {
10558
+ "description": "Service preset that runs the server.",
10375
10559
  "enum": [
10376
10560
  "postgres",
10377
10561
  "cockroachdb",
@@ -10379,32 +10563,44 @@
10379
10563
  ]
10380
10564
  },
10381
10565
  "version": {
10382
- "type": "string"
10566
+ "type": "string",
10567
+ "description": "Version request for the preset's tool."
10383
10568
  },
10384
10569
  "port": {
10385
10570
  "$ref": "#/$defs/daemon_port"
10386
10571
  },
10387
10572
  "ports": {
10388
10573
  "type": "object",
10574
+ "description": "Overrides for the preset's additional named ports.",
10389
10575
  "additionalProperties": {
10390
10576
  "type": "integer",
10577
+ "description": "Port for this named port of the preset.",
10391
10578
  "minimum": 1,
10392
10579
  "maximum": 65535
10393
10580
  }
10394
10581
  },
10395
10582
  "options": {
10396
- "type": "object"
10583
+ "type": "object",
10584
+ "description": "Preset options, such as `database`."
10397
10585
  },
10398
10586
  "data_dir": {
10399
10587
  "type": "string",
10588
+ "description": "Persistent server data directory; a relative path resolves inside the provider's state directory. Defaults to $MISE_STATE_DIR/daemon-providers/<name>/data.",
10400
10589
  "minLength": 1
10401
10590
  },
10402
10591
  "tool": {
10403
- "type": "string"
10592
+ "type": "string",
10593
+ "description": "Tool to install the server from, in place of the preset's default."
10404
10594
  }
10405
- }
10595
+ },
10596
+ "required": [
10597
+ "preset",
10598
+ "version"
10599
+ ]
10406
10600
  },
10407
- "description": "Experimental shared servers owned by the user. Only allowed in global configuration."
10601
+ "propertyNames": {
10602
+ "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
10603
+ }
10408
10604
  },
10409
10605
  "daemons_settings": {
10410
10606
  "type": "object",