mise-projen 0.0.21 → 0.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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": "search the config file's directory and each parent directory for a relative env._.file path. An absolute path searches its own directory and each parent for its file name",
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
  },
@@ -2850,6 +2890,14 @@
2850
2890
  "type": "object",
2851
2891
  "unevaluatedProperties": false,
2852
2892
  "properties": {
2893
+ "keyring_provider": {
2894
+ "description": "Read a `pypi:` index password from a `keyring` command when the index URL names a user but no password.",
2895
+ "type": "string",
2896
+ "enum": [
2897
+ "disabled",
2898
+ "subprocess"
2899
+ ]
2900
+ },
2853
2901
  "registry_url": {
2854
2902
  "description": "Package index URL that `pypi:` tools list versions from, with `{}` in place of the package name.",
2855
2903
  "type": "string"
@@ -3803,7 +3851,6 @@
3803
3851
  "cache": {
3804
3852
  "type": "object",
3805
3853
  "description": "default experimental local artifact cache configuration for eligible tasks with sources and explicit outputs",
3806
- "unevaluatedProperties": false,
3807
3854
  "properties": {
3808
3855
  "enabled": {
3809
3856
  "type": "boolean",
@@ -3829,7 +3876,8 @@
3829
3876
  "type": "string"
3830
3877
  }
3831
3878
  }
3832
- }
3879
+ },
3880
+ "unevaluatedProperties": false
3833
3881
  },
3834
3882
  "rust_cache": {
3835
3883
  "description": "deprecated no-op; use mbx for Rust action caching instead: https://mr-boxington.jdx.dev/getting-started",
@@ -3840,11 +3888,12 @@
3840
3888
  },
3841
3889
  {
3842
3890
  "type": "object",
3843
- "unevaluatedProperties": false,
3844
3891
  "properties": {
3845
3892
  "enabled": {
3846
3893
  "type": "boolean",
3847
- "default": true
3894
+ "description": "deprecated no-op",
3895
+ "default": true,
3896
+ "deprecated": true
3848
3897
  },
3849
3898
  "verify": {
3850
3899
  "type": "boolean",
@@ -3852,7 +3901,8 @@
3852
3901
  "default": false,
3853
3902
  "deprecated": true
3854
3903
  }
3855
- }
3904
+ },
3905
+ "unevaluatedProperties": false
3856
3906
  }
3857
3907
  ]
3858
3908
  },
@@ -3882,6 +3932,7 @@
3882
3932
  "description": "experimental reusable config-root-relative source groups referenced with @group:<name>",
3883
3933
  "additionalProperties": {
3884
3934
  "type": "array",
3935
+ "description": "source patterns in this group, relative to the config root; may reference other groups with @group:<name>",
3885
3936
  "items": {
3886
3937
  "type": "string"
3887
3938
  }
@@ -3924,27 +3975,31 @@
3924
3975
  ]
3925
3976
  },
3926
3977
  "task_dependency_table": {
3927
- "description": "task dependency with args, env, and optional flag",
3928
3978
  "type": "object",
3979
+ "description": "task dependency with args, env, and optional flag",
3929
3980
  "properties": {
3930
3981
  "task": {
3931
- "type": "string"
3982
+ "type": "string",
3983
+ "description": "task name, alias, or pattern"
3932
3984
  },
3933
3985
  "args": {
3934
3986
  "type": "array",
3987
+ "description": "arguments to pass to the task",
3935
3988
  "items": {
3936
3989
  "type": "string"
3937
3990
  }
3938
3991
  },
3939
3992
  "env": {
3940
3993
  "type": "object",
3994
+ "description": "environment variables to set for this dependency only",
3941
3995
  "additionalProperties": {
3942
- "type": "string"
3996
+ "type": "string",
3997
+ "description": "value of this environment variable"
3943
3998
  }
3944
3999
  },
3945
4000
  "optional": {
3946
- "description": "do not fail when the task name or pattern has no matches",
3947
- "type": "boolean"
4001
+ "type": "boolean",
4002
+ "description": "do not fail when the task name or pattern has no matches"
3948
4003
  }
3949
4004
  },
3950
4005
  "required": [
@@ -3973,6 +4028,7 @@
3973
4028
  ]
3974
4029
  },
3975
4030
  "confirm": {
4031
+ "description": "prompt to answer before this task's own command runs, after its dependencies",
3976
4032
  "oneOf": [
3977
4033
  {
3978
4034
  "type": "string",
@@ -3981,6 +4037,9 @@
3981
4037
  {
3982
4038
  "type": "object",
3983
4039
  "description": "confirmation message before running this task with optional default value and custom answer labels",
4040
+ "required": [
4041
+ "message"
4042
+ ],
3984
4043
  "properties": {
3985
4044
  "message": {
3986
4045
  "type": "string",
@@ -4007,14 +4066,12 @@
4007
4066
  "description": "custom label for the negative answer"
4008
4067
  }
4009
4068
  },
4010
- "required": [
4011
- "message"
4012
- ],
4013
4069
  "unevaluatedProperties": false
4014
4070
  }
4015
4071
  ]
4016
4072
  },
4017
4073
  "depends": {
4074
+ "description": "tasks that must finish before this task runs",
4018
4075
  "oneOf": [
4019
4076
  {
4020
4077
  "type": "string",
@@ -4053,6 +4110,7 @@
4053
4110
  ]
4054
4111
  },
4055
4112
  "depends_post": {
4113
+ "description": "tasks to run after this task finishes",
4056
4114
  "oneOf": [
4057
4115
  {
4058
4116
  "type": "string",
@@ -4071,6 +4129,7 @@
4071
4129
  ]
4072
4130
  },
4073
4131
  "wait_for": {
4132
+ "description": "tasks to wait for if they are already scheduled, without adding them to the run",
4074
4133
  "oneOf": [
4075
4134
  {
4076
4135
  "type": "string",
@@ -4178,6 +4237,7 @@
4178
4237
  "default": false
4179
4238
  },
4180
4239
  "outputs": {
4240
+ "description": "files or directories this task creates; compared with `sources` to skip the task when it is up to date",
4181
4241
  "oneOf": [
4182
4242
  {
4183
4243
  "type": "array",
@@ -4193,23 +4253,22 @@
4193
4253
  },
4194
4254
  {
4195
4255
  "type": "object",
4196
- "unevaluatedProperties": false,
4256
+ "required": [
4257
+ "auto"
4258
+ ],
4197
4259
  "properties": {
4198
4260
  "auto": {
4199
4261
  "type": "boolean",
4200
4262
  "description": "automatically touch an internal tracked file instead of specifying outputs; `false` is the same as leaving `outputs` unset"
4201
4263
  }
4202
4264
  },
4203
- "required": [
4204
- "auto"
4205
- ]
4265
+ "unevaluatedProperties": false
4206
4266
  }
4207
4267
  ]
4208
4268
  },
4209
4269
  "cache": {
4210
4270
  "type": "object",
4211
4271
  "description": "experimental local artifact cache for declared task outputs",
4212
- "unevaluatedProperties": false,
4213
4272
  "properties": {
4214
4273
  "enabled": {
4215
4274
  "type": "boolean",
@@ -4235,7 +4294,8 @@
4235
4294
  "type": "string"
4236
4295
  }
4237
4296
  }
4238
- }
4297
+ },
4298
+ "unevaluatedProperties": false
4239
4299
  },
4240
4300
  "rust_cache": {
4241
4301
  "description": "deprecated no-op; use mbx for Rust action caching instead: https://mr-boxington.jdx.dev/getting-started",
@@ -4246,11 +4306,12 @@
4246
4306
  },
4247
4307
  {
4248
4308
  "type": "object",
4249
- "unevaluatedProperties": false,
4250
4309
  "properties": {
4251
4310
  "enabled": {
4252
4311
  "type": "boolean",
4253
- "default": true
4312
+ "description": "deprecated no-op",
4313
+ "default": true,
4314
+ "deprecated": true
4254
4315
  },
4255
4316
  "verify": {
4256
4317
  "type": "boolean",
@@ -4258,7 +4319,8 @@
4258
4319
  "default": false,
4259
4320
  "deprecated": true
4260
4321
  }
4261
- }
4322
+ },
4323
+ "unevaluatedProperties": false
4262
4324
  }
4263
4325
  ]
4264
4326
  },
@@ -4342,6 +4404,7 @@
4342
4404
  "description": "Execute an external script"
4343
4405
  },
4344
4406
  "sources": {
4407
+ "description": "files this task reads; mise skips the task when none changed since its outputs were written",
4345
4408
  "oneOf": [
4346
4409
  {
4347
4410
  "type": "array",
@@ -4457,52 +4520,53 @@
4457
4520
  "task_run_entry": {
4458
4521
  "oneOf": [
4459
4522
  {
4460
- "description": "script to run",
4461
- "type": "string"
4523
+ "type": "string",
4524
+ "description": "script to run"
4462
4525
  },
4463
4526
  {
4464
4527
  "type": "object",
4465
- "unevaluatedProperties": false,
4528
+ "required": [
4529
+ "task"
4530
+ ],
4466
4531
  "properties": {
4467
4532
  "task": {
4468
- "description": "single task name to run",
4469
- "type": "string"
4533
+ "type": "string",
4534
+ "description": "single task name to run"
4470
4535
  },
4471
4536
  "args": {
4472
- "description": "arguments to pass to the task",
4473
4537
  "type": "array",
4538
+ "description": "arguments to pass to the task",
4474
4539
  "items": {
4475
4540
  "type": "string"
4476
4541
  }
4477
4542
  },
4478
4543
  "env": {
4479
- "description": "environment variables to set for the task",
4480
4544
  "type": "object",
4545
+ "description": "environment variables to set for the task",
4481
4546
  "additionalProperties": {
4482
- "type": "string"
4547
+ "type": "string",
4548
+ "description": "value of this environment variable"
4483
4549
  }
4484
4550
  }
4485
4551
  },
4486
- "required": [
4487
- "task"
4488
- ]
4552
+ "unevaluatedProperties": false
4489
4553
  },
4490
4554
  {
4491
4555
  "type": "object",
4492
- "unevaluatedProperties": false,
4556
+ "required": [
4557
+ "tasks"
4558
+ ],
4493
4559
  "properties": {
4494
4560
  "tasks": {
4561
+ "type": "array",
4495
4562
  "description": "parallel task group to run",
4496
4563
  "items": {
4497
- "description": "task name and args",
4498
- "type": "string"
4499
- },
4500
- "type": "array"
4564
+ "type": "string",
4565
+ "description": "task name and args"
4566
+ }
4501
4567
  }
4502
4568
  },
4503
- "required": [
4504
- "tasks"
4505
- ]
4569
+ "unevaluatedProperties": false
4506
4570
  }
4507
4571
  ]
4508
4572
  },
@@ -4527,16 +4591,16 @@
4527
4591
  "type": "object"
4528
4592
  },
4529
4593
  "task_watch": {
4530
- "description": "options used by `mise watch` for this task",
4531
4594
  "type": "object",
4532
- "unevaluatedProperties": false,
4595
+ "description": "options used by `mise watch` for this task",
4533
4596
  "properties": {
4534
4597
  "no_vcs_ignore": {
4535
- "default": false,
4598
+ "type": "boolean",
4536
4599
  "description": "do not load VCS ignore files such as `.gitignore` when watching this task",
4537
- "type": "boolean"
4600
+ "default": false
4538
4601
  }
4539
- }
4602
+ },
4603
+ "unevaluatedProperties": false
4540
4604
  },
4541
4605
  "tool": {
4542
4606
  "description": "a version of the tool, or a table with its version and options",
@@ -4618,9 +4682,11 @@
4618
4682
  "type": "object",
4619
4683
  "properties": {
4620
4684
  "run": {
4685
+ "description": "command to run after the tool installs",
4621
4686
  "type": "string"
4622
4687
  },
4623
4688
  "when": {
4689
+ "description": "install runs the command only when mise installs the tool; always runs it on every mise install and mise use",
4624
4690
  "type": "string",
4625
4691
  "enum": [
4626
4692
  "install",
@@ -4664,6 +4730,7 @@
4664
4730
  ]
4665
4731
  },
4666
4732
  "tool_alias_entry": {
4733
+ "description": "the backend this tool name points to, or a table with its backend and version aliases",
4667
4734
  "oneOf": [
4668
4735
  {
4669
4736
  "description": "where the alias goes",
@@ -4724,8 +4791,8 @@
4724
4791
  "$ref": "#/$defs/tool_bool"
4725
4792
  },
4726
4793
  "libc": {
4727
- "description": "force strict glibc or musl asset selection on linux",
4728
4794
  "type": "string",
4795
+ "description": "force strict glibc or musl asset selection on linux",
4729
4796
  "enum": [
4730
4797
  "glibc",
4731
4798
  "gnu",
@@ -4733,18 +4800,19 @@
4733
4800
  ]
4734
4801
  },
4735
4802
  "slsa_signer_identity": {
4736
- "description": "expected fulcio certificate subject for slsa provenance; requires slsa_signer_issuer",
4737
- "type": "string"
4803
+ "type": "string",
4804
+ "description": "expected fulcio certificate subject for slsa provenance; requires slsa_signer_issuer"
4738
4805
  },
4739
4806
  "slsa_signer_issuer": {
4740
- "description": "expected oidc issuer for slsa provenance; requires slsa_signer_identity",
4741
- "type": "string"
4807
+ "type": "string",
4808
+ "description": "expected oidc issuer for slsa provenance; requires slsa_signer_identity"
4742
4809
  },
4743
4810
  "vars": {
4744
- "description": "values for aqua registry template variables",
4745
4811
  "type": "object",
4812
+ "description": "values for aqua registry template variables",
4746
4813
  "additionalProperties": {
4747
- "type": "string"
4814
+ "type": "string",
4815
+ "description": "value of this aqua registry template variable"
4748
4816
  }
4749
4817
  }
4750
4818
  }
@@ -4834,8 +4902,8 @@
4834
4902
  "$ref": "#/$defs/tool_bool"
4835
4903
  },
4836
4904
  "bin": {
4837
- "description": "binary to install when a crate has several (cargo install --bin)",
4838
- "type": "string"
4905
+ "type": "string",
4906
+ "description": "binary to install when a crate has several (cargo install --bin)"
4839
4907
  },
4840
4908
  "rename_exe": {
4841
4909
  "description": "rename the installed executable: a name, or a table of glob = new name",
@@ -4846,14 +4914,15 @@
4846
4914
  {
4847
4915
  "type": "object",
4848
4916
  "additionalProperties": {
4849
- "type": "string"
4917
+ "type": "string",
4918
+ "description": "new name for the executables matching this glob"
4850
4919
  }
4851
4920
  }
4852
4921
  ]
4853
4922
  },
4854
4923
  "crate": {
4855
- "description": "crate to install when a git repository contains several",
4856
- "type": "string"
4924
+ "type": "string",
4925
+ "description": "crate to install when a git repository contains several"
4857
4926
  },
4858
4927
  "locked": {
4859
4928
  "description": "pass --locked to cargo install (default true)",
@@ -4868,6 +4937,7 @@
4868
4937
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
4869
4938
  },
4870
4939
  "additionalProperties": {
4940
+ "description": "options for this platform, overriding the same options set for the whole tool",
4871
4941
  "type": "object",
4872
4942
  "properties": {
4873
4943
  "bin": {
@@ -4900,8 +4970,8 @@
4900
4970
  "type": "object",
4901
4971
  "properties": {
4902
4972
  "channel": {
4903
- "description": "conda channel to resolve the package from (default conda-forge)",
4904
- "type": "string"
4973
+ "type": "string",
4974
+ "description": "conda channel to resolve the package from (default conda-forge)"
4905
4975
  }
4906
4976
  }
4907
4977
  },
@@ -4941,8 +5011,8 @@
4941
5011
  "type": "object",
4942
5012
  "properties": {
4943
5013
  "runtime": {
4944
- "description": "install a shared runtime instead of the sdk; the version is the runtime version",
4945
5014
  "type": "string",
5015
+ "description": "install a shared runtime instead of the sdk; the version is the runtime version",
4946
5016
  "enum": [
4947
5017
  "dotnet",
4948
5018
  "aspnetcore",
@@ -4975,8 +5045,8 @@
4975
5045
  "type": "object",
4976
5046
  "properties": {
4977
5047
  "release_type": {
4978
- "description": "jdk metadata channel: ga (default) or ea for early access builds",
4979
5048
  "type": "string",
5049
+ "description": "jdk metadata channel: ga (default) or ea for early access builds",
4980
5050
  "enum": [
4981
5051
  "ga",
4982
5052
  "ea"
@@ -5012,8 +5082,8 @@
5012
5082
  "$ref": "#/$defs/tool_bool"
5013
5083
  },
5014
5084
  "virtualenv": {
5015
- "description": "virtualenv path to activate; use env._.python.venv instead",
5016
5085
  "type": "string",
5086
+ "description": "virtualenv path to activate; use env._.python.venv instead",
5017
5087
  "deprecated": true
5018
5088
  }
5019
5089
  }
@@ -5042,8 +5112,8 @@
5042
5112
  "type": "object",
5043
5113
  "properties": {
5044
5114
  "profile": {
5045
- "description": "rustup profile to install, such as minimal, default or complete",
5046
- "type": "string"
5115
+ "type": "string",
5116
+ "description": "rustup profile to install, such as minimal, default or complete"
5047
5117
  },
5048
5118
  "components": {
5049
5119
  "description": "rustup components to install",
@@ -5083,12 +5153,12 @@
5083
5153
  "type": "object",
5084
5154
  "properties": {
5085
5155
  "version_prefix": {
5086
- "description": "release tag prefix stripped from versions and re-added when resolving tags",
5087
- "type": "string"
5156
+ "type": "string",
5157
+ "description": "release tag prefix stripped from versions and re-added when resolving tags"
5088
5158
  },
5089
5159
  "asset_pattern": {
5090
- "description": "glob (* and ?) matched against release asset names, tera templated; replaces autodetection",
5091
- "type": "string"
5160
+ "type": "string",
5161
+ "description": "glob (* and ?) matched against release asset names, tera templated; replaces autodetection"
5092
5162
  },
5093
5163
  "additional_asset_patterns": {
5094
5164
  "description": "extra archives from the same release extracted over the primary asset, in order",
@@ -5105,12 +5175,12 @@
5105
5175
  ]
5106
5176
  },
5107
5177
  "matching": {
5108
- "description": "substring an asset name must contain, applied before platform autodetection",
5109
- "type": "string"
5178
+ "type": "string",
5179
+ "description": "substring an asset name must contain, applied before platform autodetection"
5110
5180
  },
5111
5181
  "matching_regex": {
5112
- "description": "regex an asset name must match, applied before platform autodetection",
5113
- "type": "string"
5182
+ "type": "string",
5183
+ "description": "regex an asset name must match, applied before platform autodetection"
5114
5184
  },
5115
5185
  "no_app": {
5116
5186
  "description": "penalize macos .app bundle assets during autodetection",
@@ -5131,8 +5201,8 @@
5131
5201
  ]
5132
5202
  },
5133
5203
  "format": {
5134
- "description": "force the archive format instead of detecting it from the file name",
5135
5204
  "type": "string",
5205
+ "description": "force the archive format instead of detecting it from the file name",
5136
5206
  "enum": [
5137
5207
  "tar.gz",
5138
5208
  "tgz",
@@ -5165,8 +5235,8 @@
5165
5235
  ]
5166
5236
  },
5167
5237
  "checksum": {
5168
- "description": "expected artifact digest as algo:hash (sha256, sha512, sha1, md5, blake3)",
5169
- "type": "string"
5238
+ "type": "string",
5239
+ "description": "expected artifact digest as algo:hash (sha256, sha512, sha1, md5, blake3)"
5170
5240
  },
5171
5241
  "size": {
5172
5242
  "description": "expected artifact size in bytes",
@@ -5191,8 +5261,8 @@
5191
5261
  ]
5192
5262
  },
5193
5263
  "bin": {
5194
- "description": "executable name (or safe relative path) to install the downloaded binary as",
5195
- "type": "string"
5264
+ "type": "string",
5265
+ "description": "executable name (or safe relative path) to install the downloaded binary as"
5196
5266
  },
5197
5267
  "rename_exe": {
5198
5268
  "description": "rename the extracted executable: a name, or a table of glob = new name",
@@ -5203,14 +5273,15 @@
5203
5273
  {
5204
5274
  "type": "object",
5205
5275
  "additionalProperties": {
5206
- "type": "string"
5276
+ "type": "string",
5277
+ "description": "new name for the executables matching this glob"
5207
5278
  }
5208
5279
  }
5209
5280
  ]
5210
5281
  },
5211
5282
  "bin_path": {
5212
- "description": "directory inside the install that contains binaries (tera templated)",
5213
- "type": "string"
5283
+ "type": "string",
5284
+ "description": "directory inside the install that contains binaries (tera templated)"
5214
5285
  }
5215
5286
  }
5216
5287
  },
@@ -5221,6 +5292,7 @@
5221
5292
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
5222
5293
  },
5223
5294
  "additionalProperties": {
5295
+ "description": "options for this platform, overriding the same options set for the whole tool",
5224
5296
  "type": "object",
5225
5297
  "properties": {
5226
5298
  "asset_pattern": {
@@ -5229,10 +5301,6 @@
5229
5301
  "additional_asset_patterns": {
5230
5302
  "$ref": "#/$defs/tool_forge_options/properties/additional_asset_patterns"
5231
5303
  },
5232
- "url": {
5233
- "description": "direct download url for this platform, tera templated; skips release asset selection",
5234
- "type": "string"
5235
- },
5236
5304
  "no_app": {
5237
5305
  "$ref": "#/$defs/tool_forge_options/properties/no_app"
5238
5306
  },
@@ -5259,6 +5327,10 @@
5259
5327
  },
5260
5328
  "format": {
5261
5329
  "$ref": "#/$defs/tool_forge_options/properties/format"
5330
+ },
5331
+ "url": {
5332
+ "description": "direct download url for this platform, tera templated; skips release asset selection",
5333
+ "type": "string"
5262
5334
  }
5263
5335
  }
5264
5336
  }
@@ -5302,8 +5374,8 @@
5302
5374
  "type": "object",
5303
5375
  "properties": {
5304
5376
  "api_url": {
5305
- "description": "api base url, for self-hosted forgejo or gitea instances",
5306
- "type": "string"
5377
+ "type": "string",
5378
+ "description": "api base url, for self-hosted forgejo or gitea instances"
5307
5379
  }
5308
5380
  }
5309
5381
  },
@@ -5331,8 +5403,8 @@
5331
5403
  "type": "object",
5332
5404
  "properties": {
5333
5405
  "source": {
5334
- "description": "gem registry http(s) url used to resolve and install this gem",
5335
- "type": "string"
5406
+ "type": "string",
5407
+ "description": "gem registry http(s) url used to resolve and install this gem"
5336
5408
  }
5337
5409
  }
5338
5410
  },
@@ -5375,20 +5447,20 @@
5375
5447
  "type": "object",
5376
5448
  "properties": {
5377
5449
  "api_url": {
5378
- "description": "api base url, for github enterprise or self-hosted instances",
5379
- "type": "string"
5450
+ "type": "string",
5451
+ "description": "api base url, for github enterprise or self-hosted instances"
5380
5452
  },
5381
5453
  "github_attestations": {
5382
5454
  "description": "verify github artifact attestations when available",
5383
5455
  "$ref": "#/$defs/tool_bool"
5384
5456
  },
5385
5457
  "slsa_signer_identity": {
5386
- "description": "expected fulcio certificate identity for slsa provenance, tera templated",
5387
- "type": "string"
5458
+ "type": "string",
5459
+ "description": "expected fulcio certificate identity for slsa provenance, tera templated"
5388
5460
  },
5389
5461
  "slsa_signer_issuer": {
5390
- "description": "expected oidc issuer for slsa provenance; requires slsa_signer_identity",
5391
- "type": "string"
5462
+ "type": "string",
5463
+ "description": "expected oidc issuer for slsa provenance; requires slsa_signer_identity"
5392
5464
  }
5393
5465
  }
5394
5466
  },
@@ -5431,8 +5503,8 @@
5431
5503
  "type": "object",
5432
5504
  "properties": {
5433
5505
  "api_url": {
5434
- "description": "api base url, for self-hosted gitlab instances",
5435
- "type": "string"
5506
+ "type": "string",
5507
+ "description": "api base url, for self-hosted gitlab instances"
5436
5508
  }
5437
5509
  }
5438
5510
  },
@@ -5511,32 +5583,34 @@
5511
5583
  "type": "object",
5512
5584
  "properties": {
5513
5585
  "url": {
5514
- "description": "download url, tera templated, http(s) or file://; required for each platform",
5515
- "type": "string"
5586
+ "type": "string",
5587
+ "description": "download url, tera templated, http(s) or file://; required for each platform"
5516
5588
  },
5517
5589
  "checksum": {
5518
- "description": "expected artifact digest as algo:hash",
5519
- "type": "string"
5590
+ "type": "string",
5591
+ "description": "expected artifact digest as algo:hash"
5520
5592
  },
5521
5593
  "checksum_url": {
5522
- "description": "checksum file or manifest url, used by mise lock without downloading",
5523
- "type": "string"
5594
+ "type": "string",
5595
+ "description": "checksum file or manifest url, used by mise lock without downloading"
5524
5596
  },
5525
5597
  "checksum_expr": {
5526
- "description": "expr-lang expression extracting algo:hash from the checksum_url manifest",
5527
- "type": "string"
5598
+ "type": "string",
5599
+ "description": "expr-lang expression extracting algo:hash from the checksum_url manifest"
5528
5600
  },
5529
5601
  "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
5602
  "type": "object",
5603
+ "description": "request headers sent with the download, version_list_url and checksum_url requests; values are tera templated (e.g. Bearer {{ env.TOKEN }})",
5532
5604
  "additionalProperties": {
5533
- "type": "string"
5605
+ "type": "string",
5606
+ "description": "value of this request header; tera templated"
5534
5607
  }
5535
5608
  },
5536
5609
  "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
5610
  "type": "object",
5611
+ "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
5612
  "additionalProperties": {
5613
+ "description": "hosts this header may follow a redirect to: exact hosts or *.suffix",
5540
5614
  "oneOf": [
5541
5615
  {
5542
5616
  "type": "string"
@@ -5562,8 +5636,8 @@
5562
5636
  ]
5563
5637
  },
5564
5638
  "format": {
5565
- "description": "force the archive format instead of detecting it from the url",
5566
5639
  "type": "string",
5640
+ "description": "force the archive format instead of detecting it from the url",
5567
5641
  "enum": [
5568
5642
  "tar.gz",
5569
5643
  "tgz",
@@ -5607,8 +5681,8 @@
5607
5681
  ]
5608
5682
  },
5609
5683
  "bin": {
5610
- "description": "name for a downloaded raw or compressed single binary (ignored for archives)",
5611
- "type": "string"
5684
+ "type": "string",
5685
+ "description": "name for a downloaded raw or compressed single binary (ignored for archives)"
5612
5686
  },
5613
5687
  "rename_exe": {
5614
5688
  "description": "rename the extracted executable: a name, or a table of glob = new name",
@@ -5619,38 +5693,51 @@
5619
5693
  {
5620
5694
  "type": "object",
5621
5695
  "additionalProperties": {
5622
- "type": "string"
5696
+ "type": "string",
5697
+ "description": "new name for the executables matching this glob"
5623
5698
  }
5624
5699
  }
5625
5700
  ]
5626
5701
  },
5627
5702
  "bin_path": {
5628
- "description": "directory inside the install that contains binaries (tera templated)",
5629
- "type": "string"
5703
+ "type": "string",
5704
+ "description": "directory inside the install that contains binaries (tera templated)"
5630
5705
  },
5631
5706
  "shared_extraction": {
5632
5707
  "description": "share extracted content between installs with identical artifacts",
5633
5708
  "$ref": "#/$defs/tool_bool"
5634
5709
  },
5635
5710
  "windows_script_interpreter": {
5636
- "description": "windows only: write a .cmd launcher running the raw script with this interpreter",
5637
- "type": "string"
5711
+ "type": "string",
5712
+ "description": "windows only: write a .cmd launcher running the raw script with this interpreter"
5638
5713
  },
5639
5714
  "version_list_url": {
5640
- "description": "url returning the version list (text, json or html)",
5641
- "type": "string"
5715
+ "type": "string",
5716
+ "description": "url returning the version list (text, json or html)"
5642
5717
  },
5643
5718
  "version_regex": {
5644
- "description": "regex extracting versions from the list (first capture group or whole match)",
5645
- "type": "string"
5719
+ "type": "string",
5720
+ "description": "regex extracting versions from the list (first capture group or whole match)"
5646
5721
  },
5647
5722
  "version_json_path": {
5648
- "description": "jq-like path extracting versions from json, such as .[].version",
5649
- "type": "string"
5723
+ "type": "string",
5724
+ "description": "jq-like path extracting versions from json, such as .[].version"
5650
5725
  },
5651
5726
  "version_expr": {
5652
- "description": "expr-lang expression post-processing versions (variables: body, versions)",
5653
- "type": "string"
5727
+ "type": "string",
5728
+ "description": "expr-lang expression post-processing versions (variables: body, versions)"
5729
+ },
5730
+ "version_date_url": {
5731
+ "type": "string",
5732
+ "description": "url holding release dates; defaults to the version_list_url body"
5733
+ },
5734
+ "version_date_next_expr": {
5735
+ "type": "string",
5736
+ "description": "expr-lang expression returning the url of the next page of version_date_url, or nil after the last (variables: body, url)"
5737
+ },
5738
+ "version_date_expr": {
5739
+ "type": "string",
5740
+ "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
5741
  }
5655
5742
  }
5656
5743
  },
@@ -5661,6 +5748,7 @@
5661
5748
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
5662
5749
  },
5663
5750
  "additionalProperties": {
5751
+ "description": "options for this platform, overriding the same options set for the whole tool",
5664
5752
  "type": "object",
5665
5753
  "properties": {
5666
5754
  "url": {
@@ -5778,52 +5866,53 @@
5778
5866
  ]
5779
5867
  },
5780
5868
  "aube_args": {
5781
- "description": "extra arguments for aube add --global (only with npm.package_manager = aube_cli)",
5782
- "type": "string"
5869
+ "type": "string",
5870
+ "description": "extra arguments for aube add --global (only with npm.package_manager = aube_cli)"
5783
5871
  },
5784
5872
  "pnpm_args": {
5785
- "description": "extra arguments for pnpm installs (shell-split)",
5786
- "type": "string"
5873
+ "type": "string",
5874
+ "description": "extra arguments for pnpm installs (shell-split)"
5787
5875
  },
5788
5876
  "bun_args": {
5789
- "description": "extra arguments for bun installs (shell-split)",
5790
- "type": "string"
5877
+ "type": "string",
5878
+ "description": "extra arguments for bun installs (shell-split)"
5791
5879
  },
5792
5880
  "npm_args": {
5793
- "description": "extra arguments for npm installs (shell-split)",
5794
- "type": "string"
5881
+ "type": "string",
5882
+ "description": "extra arguments for npm installs (shell-split)"
5795
5883
  }
5796
5884
  }
5797
5885
  },
5798
5886
  "tool_options": {
5887
+ "type": "object",
5799
5888
  "properties": {
5800
5889
  "version": {
5801
- "description": "version of the tool to install",
5802
- "type": "string"
5890
+ "type": "string",
5891
+ "description": "version of the tool to install"
5803
5892
  },
5804
5893
  "path": {
5805
- "description": "path to a custom compiled version",
5806
- "type": "string"
5894
+ "type": "string",
5895
+ "description": "path to a custom compiled version"
5807
5896
  },
5808
5897
  "prefix": {
5809
- "description": "version prefix to resolve",
5810
- "type": "string"
5898
+ "type": "string",
5899
+ "description": "version prefix to resolve"
5811
5900
  },
5812
5901
  "ref": {
5813
- "description": "version control reference to compile",
5814
- "type": "string"
5902
+ "type": "string",
5903
+ "description": "version control reference to compile"
5815
5904
  },
5816
5905
  "os": {
5817
5906
  "$ref": "#/$defs/os_filter"
5818
5907
  },
5819
5908
  "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"
5909
+ "type": "string",
5910
+ "description": "minimum time since a version's release before mise selects it, as a duration such as \"7d\" or an absolute date"
5822
5911
  },
5823
5912
  "install_before": {
5913
+ "type": "string",
5824
5914
  "description": "deprecated alias for minimum_release_age",
5825
- "deprecated": true,
5826
- "type": "string"
5915
+ "deprecated": true
5827
5916
  },
5828
5917
  "version_order": {
5829
5918
  "description": "ordering applied to remote versions: \"source\" keeps the backend's order, \"semver\" sorts semantic versions",
@@ -5866,8 +5955,7 @@
5866
5955
  "ref"
5867
5956
  ]
5868
5957
  }
5869
- ],
5870
- "type": "object"
5958
+ ]
5871
5959
  },
5872
5960
  "tool_packslip": {
5873
5961
  "description": "a tool installed with the packslip backend",
@@ -5893,20 +5981,20 @@
5893
5981
  "type": "object",
5894
5982
  "properties": {
5895
5983
  "variant": {
5896
- "description": "publisher-declared alternative build to select, such as fips",
5897
- "type": "string"
5984
+ "type": "string",
5985
+ "description": "publisher-declared alternative build to select, such as fips"
5898
5986
  },
5899
5987
  "pubkey": {
5900
- "description": "minisign public key line or path to a .pub file pinning the signer",
5901
- "type": "string"
5988
+ "type": "string",
5989
+ "description": "minisign public key line or path to a .pub file pinning the signer"
5902
5990
  },
5903
5991
  "identity": {
5904
- "description": "exact keyless signer certificate identity",
5905
- "type": "string"
5992
+ "type": "string",
5993
+ "description": "exact keyless signer certificate identity"
5906
5994
  },
5907
5995
  "identity_prefix": {
5908
- "description": "keyless signer certificate identity prefix",
5909
- "type": "string"
5996
+ "type": "string",
5997
+ "description": "keyless signer certificate identity prefix"
5910
5998
  },
5911
5999
  "workflow": {
5912
6000
  "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 +6012,12 @@
5924
6012
  ]
5925
6013
  },
5926
6014
  "list_identity_prefix": {
5927
- "description": "separate identity prefix for the vendor release list; needs an issuer, not valid with pubkey",
5928
- "type": "string"
6015
+ "type": "string",
6016
+ "description": "separate identity prefix for the vendor release list; needs an issuer, not valid with pubkey"
5929
6017
  },
5930
6018
  "issuer": {
5931
- "description": "oidc issuer for the keyless signer",
5932
- "type": "string"
6019
+ "type": "string",
6020
+ "description": "oidc issuer for the keyless signer"
5933
6021
  },
5934
6022
  "allow_unlogged": {
5935
6023
  "description": "accept key-signed bundles without transparency-log evidence",
@@ -5940,8 +6028,8 @@
5940
6028
  "$ref": "#/$defs/tool_bool"
5941
6029
  },
5942
6030
  "trust": {
5943
- "description": "vendor exempts this tool from configured packslip stampers",
5944
6031
  "type": "string",
6032
+ "description": "vendor exempts this tool from configured packslip stampers",
5945
6033
  "enum": [
5946
6034
  "vendor"
5947
6035
  ]
@@ -5955,6 +6043,7 @@
5955
6043
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
5956
6044
  },
5957
6045
  "additionalProperties": {
6046
+ "description": "options for this platform, overriding the same options set for the whole tool",
5958
6047
  "type": "object"
5959
6048
  }
5960
6049
  },
@@ -6024,8 +6113,8 @@
6024
6113
  ]
6025
6114
  },
6026
6115
  "dependency_prereleases": {
6027
- "description": "uv prerelease policy for dependency resolution (requires uv)",
6028
6116
  "type": "string",
6117
+ "description": "uv prerelease policy for dependency resolution (requires uv)",
6029
6118
  "enum": [
6030
6119
  "disallow",
6031
6120
  "allow",
@@ -6034,28 +6123,28 @@
6034
6123
  ]
6035
6124
  },
6036
6125
  "python": {
6037
- "description": "mise-managed CPython version for this tool (minor or exact patch)",
6038
- "type": "string"
6126
+ "type": "string",
6127
+ "description": "mise-managed CPython version for this tool (minor or exact patch)"
6039
6128
  },
6040
6129
  "package_name": {
6041
- "description": "distribution name for git sources, used to attach extras",
6042
- "type": "string"
6130
+ "type": "string",
6131
+ "description": "distribution name for git sources, used to attach extras"
6043
6132
  },
6044
6133
  "pipx_args": {
6045
- "description": "extra arguments for pipx install (shell-split)",
6046
- "type": "string"
6134
+ "type": "string",
6135
+ "description": "extra arguments for pipx install (shell-split)"
6047
6136
  },
6048
6137
  "uvx": {
6049
6138
  "description": "set to false to install with pipx instead of uv",
6050
6139
  "$ref": "#/$defs/tool_bool"
6051
6140
  },
6052
6141
  "uvx_args": {
6053
- "description": "extra arguments for uv tool install (shell-split)",
6054
- "type": "string"
6142
+ "type": "string",
6143
+ "description": "extra arguments for uv tool install (shell-split)"
6055
6144
  },
6056
6145
  "registry_url": {
6057
- "description": "version-listing url containing a {} placeholder for the package name",
6058
- "type": "string"
6146
+ "type": "string",
6147
+ "description": "version-listing url containing a {} placeholder for the package name"
6059
6148
  }
6060
6149
  }
6061
6150
  },
@@ -6095,12 +6184,12 @@
6095
6184
  "type": "object",
6096
6185
  "properties": {
6097
6186
  "url": {
6098
- "description": "s3://bucket/key object url, tera templated; required for each platform",
6099
- "type": "string"
6187
+ "type": "string",
6188
+ "description": "s3://bucket/key object url, tera templated; required for each platform"
6100
6189
  },
6101
6190
  "checksum": {
6102
- "description": "expected artifact digest as algo:hash",
6103
- "type": "string"
6191
+ "type": "string",
6192
+ "description": "expected artifact digest as algo:hash"
6104
6193
  },
6105
6194
  "size": {
6106
6195
  "description": "expected artifact size in bytes",
@@ -6114,8 +6203,8 @@
6114
6203
  ]
6115
6204
  },
6116
6205
  "format": {
6117
- "description": "force the archive format when the object key has no usable extension",
6118
6206
  "type": "string",
6207
+ "description": "force the archive format when the object key has no usable extension",
6119
6208
  "enum": [
6120
6209
  "tar.gz",
6121
6210
  "tgz",
@@ -6159,8 +6248,8 @@
6159
6248
  ]
6160
6249
  },
6161
6250
  "bin": {
6162
- "description": "executable name (or safe relative path) to install the downloaded binary as",
6163
- "type": "string"
6251
+ "type": "string",
6252
+ "description": "executable name (or safe relative path) to install the downloaded binary as"
6164
6253
  },
6165
6254
  "rename_exe": {
6166
6255
  "description": "rename the extracted executable: a name, or a table of glob = new name",
@@ -6171,42 +6260,43 @@
6171
6260
  {
6172
6261
  "type": "object",
6173
6262
  "additionalProperties": {
6174
- "type": "string"
6263
+ "type": "string",
6264
+ "description": "new name for the executables matching this glob"
6175
6265
  }
6176
6266
  }
6177
6267
  ]
6178
6268
  },
6179
6269
  "bin_path": {
6180
- "description": "directory inside the install that contains binaries (tera templated)",
6181
- "type": "string"
6270
+ "type": "string",
6271
+ "description": "directory inside the install that contains binaries (tera templated)"
6182
6272
  },
6183
6273
  "region": {
6184
- "description": "aws region used for the s3 client",
6185
- "type": "string"
6274
+ "type": "string",
6275
+ "description": "aws region used for the s3 client"
6186
6276
  },
6187
6277
  "endpoint": {
6188
- "description": "custom s3-compatible endpoint url (minio and similar); enables path-style addressing",
6189
- "type": "string"
6278
+ "type": "string",
6279
+ "description": "custom s3-compatible endpoint url (minio and similar); enables path-style addressing"
6190
6280
  },
6191
6281
  "version_list_url": {
6192
- "description": "s3:// url of a manifest file listing versions",
6193
- "type": "string"
6282
+ "type": "string",
6283
+ "description": "s3:// url of a manifest file listing versions"
6194
6284
  },
6195
6285
  "version_prefix": {
6196
- "description": "s3 key prefix to list objects under for version discovery",
6197
- "type": "string"
6286
+ "type": "string",
6287
+ "description": "s3 key prefix to list objects under for version discovery"
6198
6288
  },
6199
6289
  "version_regex": {
6200
- "description": "regex extracting versions from the manifest or object keys",
6201
- "type": "string"
6290
+ "type": "string",
6291
+ "description": "regex extracting versions from the manifest or object keys"
6202
6292
  },
6203
6293
  "version_json_path": {
6204
- "description": "jq-like path extracting versions from json, such as .[].version",
6205
- "type": "string"
6294
+ "type": "string",
6295
+ "description": "jq-like path extracting versions from json, such as .[].version"
6206
6296
  },
6207
6297
  "version_expr": {
6208
- "description": "expr-lang expression post-processing versions (variables: body, versions)",
6209
- "type": "string"
6298
+ "type": "string",
6299
+ "description": "expr-lang expression post-processing versions (variables: body, versions)"
6210
6300
  }
6211
6301
  }
6212
6302
  },
@@ -6217,6 +6307,7 @@
6217
6307
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
6218
6308
  },
6219
6309
  "additionalProperties": {
6310
+ "description": "options for this platform, overriding the same options set for the whole tool",
6220
6311
  "type": "object",
6221
6312
  "properties": {
6222
6313
  "url": {
@@ -6291,25 +6382,25 @@
6291
6382
  "type": "object",
6292
6383
  "properties": {
6293
6384
  "entrypoint": {
6294
- "description": "ruby file to compile, relative to the repository root (default main.rb)",
6295
- "type": "string"
6385
+ "type": "string",
6386
+ "description": "ruby file to compile, relative to the repository root (default main.rb)"
6296
6387
  },
6297
6388
  "bin": {
6298
- "description": "name of the executable written to bin/ (default: the repository name)",
6299
- "type": "string"
6389
+ "type": "string",
6390
+ "description": "name of the executable written to bin/ (default: the repository name)"
6300
6391
  },
6301
6392
  "tag_prefix": {
6302
- "description": "text before the version in each git tag, such as v",
6303
- "type": "string"
6393
+ "type": "string",
6394
+ "description": "text before the version in each git tag, such as v"
6304
6395
  },
6305
6396
  "source_ref": {
6306
- "description": "full 40-character commit SHA to build instead of the tag",
6307
6397
  "type": "string",
6398
+ "description": "full 40-character commit SHA to build instead of the tag",
6308
6399
  "pattern": "^[0-9a-fA-F]{40}$"
6309
6400
  },
6310
6401
  "spinel": {
6311
- "description": "spinel compiler to run (default: spinel on PATH)",
6312
- "type": "string"
6402
+ "type": "string",
6403
+ "description": "spinel compiler to run (default: spinel on PATH)"
6313
6404
  }
6314
6405
  }
6315
6406
  },
@@ -6349,24 +6440,24 @@
6349
6440
  "type": "object",
6350
6441
  "properties": {
6351
6442
  "provider": {
6352
- "description": "git host used for release info and assets",
6353
6443
  "type": "string",
6444
+ "description": "git host used for release info and assets",
6354
6445
  "enum": [
6355
6446
  "github",
6356
6447
  "gitlab"
6357
6448
  ]
6358
6449
  },
6359
6450
  "api_url": {
6360
- "description": "provider api url, for self-hosted instances",
6361
- "type": "string"
6451
+ "type": "string",
6452
+ "description": "provider api url, for self-hosted instances"
6362
6453
  },
6363
6454
  "artifactbundle": {
6364
6455
  "description": "true requires an artifactbundle, false forces a source build, unset tries the bundle first",
6365
6456
  "$ref": "#/$defs/tool_bool"
6366
6457
  },
6367
6458
  "artifactbundle_asset": {
6368
- "description": "specific *.artifactbundle.zip release asset to use",
6369
- "type": "string"
6459
+ "type": "string",
6460
+ "description": "specific *.artifactbundle.zip release asset to use"
6370
6461
  },
6371
6462
  "filter_bins": {
6372
6463
  "description": "executable products to install",
@@ -6383,8 +6474,8 @@
6383
6474
  ]
6384
6475
  },
6385
6476
  "install_command": {
6386
- "description": "command run in the checkout instead of swift build; incompatible with filter_bins",
6387
- "type": "string"
6477
+ "type": "string",
6478
+ "description": "command run in the checkout instead of swift build; incompatible with filter_bins"
6388
6479
  }
6389
6480
  }
6390
6481
  },
@@ -6395,6 +6486,7 @@
6395
6486
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
6396
6487
  },
6397
6488
  "additionalProperties": {
6489
+ "description": "options for this platform, overriding the same options set for the whole tool",
6398
6490
  "type": "object",
6399
6491
  "properties": {
6400
6492
  "provider": {
@@ -6448,44 +6540,44 @@
6448
6540
  "type": "object",
6449
6541
  "properties": {
6450
6542
  "exe": {
6451
- "description": "name of the executable inside the archive to extract",
6452
- "type": "string"
6543
+ "type": "string",
6544
+ "description": "name of the executable inside the archive to extract"
6453
6545
  },
6454
6546
  "rename_exe": {
6455
- "description": "name to give the extracted executable",
6456
- "type": "string"
6547
+ "type": "string",
6548
+ "description": "name to give the extracted executable"
6457
6549
  },
6458
6550
  "matching": {
6459
- "description": "substring to match release filenames when several match the os and arch",
6460
- "type": "string"
6551
+ "type": "string",
6552
+ "description": "substring to match release filenames when several match the os and arch"
6461
6553
  },
6462
6554
  "matching_regex": {
6463
- "description": "regex release filenames must match before os and arch matching",
6464
- "type": "string"
6555
+ "type": "string",
6556
+ "description": "regex release filenames must match before os and arch matching"
6465
6557
  },
6466
6558
  "provider": {
6467
- "description": "forge used to fetch releases and assets",
6468
6559
  "type": "string",
6560
+ "description": "forge used to fetch releases and assets",
6469
6561
  "enum": [
6470
6562
  "github",
6471
6563
  "gitlab"
6472
6564
  ]
6473
6565
  },
6474
6566
  "api_url": {
6475
- "description": "provider api base url, for self-hosted instances",
6476
- "type": "string"
6567
+ "type": "string",
6568
+ "description": "provider api base url, for self-hosted instances"
6477
6569
  },
6478
6570
  "tag_regex": {
6479
- "description": "regex release tags must match to be listed as versions",
6480
- "type": "string"
6571
+ "type": "string",
6572
+ "description": "regex release tags must match to be listed as versions"
6481
6573
  },
6482
6574
  "extract_all": {
6483
6575
  "description": "extract every file in the archive instead of only the binary",
6484
6576
  "$ref": "#/$defs/tool_bool"
6485
6577
  },
6486
6578
  "bin_path": {
6487
- "description": "directory in the install containing binaries, used with extract_all",
6488
- "type": "string"
6579
+ "type": "string",
6580
+ "description": "directory in the install containing binaries, used with extract_all"
6489
6581
  }
6490
6582
  }
6491
6583
  },
@@ -6496,6 +6588,7 @@
6496
6588
  "pattern": "^[A-Za-z]+-[A-Za-z0-9_]+$"
6497
6589
  },
6498
6590
  "additionalProperties": {
6591
+ "description": "options for this platform, overriding the same options set for the whole tool",
6499
6592
  "type": "object",
6500
6593
  "properties": {
6501
6594
  "bin_path": {
@@ -6505,79 +6598,81 @@
6505
6598
  }
6506
6599
  },
6507
6600
  "vars": {
6508
- "description": "variables to set",
6509
6601
  "type": "object",
6602
+ "description": "variables to set",
6510
6603
  "properties": {
6511
6604
  "_": {
6605
+ "type": "object",
6512
6606
  "description": "vars modules",
6513
- "additionalProperties": true,
6514
6607
  "properties": {
6515
6608
  "file": {
6609
+ "description": "files to load variables from (dotenv, json, yaml, or toml)",
6516
6610
  "oneOf": [
6517
6611
  {
6518
6612
  "$ref": "#/$defs/env_directive"
6519
6613
  },
6520
6614
  {
6521
- "description": "environment file to load (dotenv, json, yaml, or toml)",
6522
- "type": "string"
6615
+ "type": "string",
6616
+ "description": "environment file to load (dotenv, json, yaml, or toml)"
6523
6617
  },
6524
6618
  {
6619
+ "type": "array",
6525
6620
  "description": "environment files to load (dotenv, json, yaml, or toml)",
6526
6621
  "items": {
6527
6622
  "oneOf": [
6528
6623
  {
6529
- "description": "environment file to load (dotenv, json, yaml, or toml)",
6530
- "type": "string"
6624
+ "type": "string",
6625
+ "description": "environment file to load (dotenv, json, yaml, or toml)"
6531
6626
  },
6532
6627
  {
6533
6628
  "$ref": "#/$defs/env_directive"
6534
6629
  }
6535
6630
  ]
6536
- },
6537
- "type": "array"
6631
+ }
6538
6632
  }
6539
6633
  ]
6540
6634
  },
6541
6635
  "source": {
6636
+ "description": "bash scripts to run, taking the variables they export",
6542
6637
  "oneOf": [
6543
6638
  {
6544
6639
  "$ref": "#/$defs/env_directive"
6545
6640
  },
6546
6641
  {
6547
- "description": "bash script to load",
6548
- "type": "string"
6642
+ "type": "string",
6643
+ "description": "bash script to load"
6549
6644
  },
6550
6645
  {
6646
+ "type": "array",
6551
6647
  "description": "bash scripts to load",
6552
6648
  "items": {
6553
6649
  "oneOf": [
6554
6650
  {
6555
- "description": "bash script to load",
6556
- "type": "string"
6651
+ "type": "string",
6652
+ "description": "bash script to load"
6557
6653
  },
6558
6654
  {
6559
6655
  "$ref": "#/$defs/env_directive"
6560
6656
  }
6561
6657
  ]
6562
- },
6563
- "type": "array"
6658
+ }
6564
6659
  }
6565
6660
  ]
6566
6661
  }
6567
6662
  },
6568
- "type": "object"
6663
+ "additionalProperties": true
6569
6664
  }
6570
6665
  },
6571
6666
  "additionalProperties": {
6572
6667
  "description": "a variable: its value, or a table with `value`, `default`, `required` or `age`",
6573
6668
  "oneOf": [
6574
6669
  {
6575
- "description": "value of variable",
6576
- "type": "string"
6670
+ "type": "string",
6671
+ "description": "value of variable"
6577
6672
  },
6578
6673
  {
6579
- "description": "value of variable",
6580
- "type": "integer"
6674
+ "type": "integer",
6675
+ "description": "value of variable"
6581
6676
  },
6582
6677
  {
6583
6678
  "description": "value of variable",
@@ -6585,8 +6680,12 @@
6585
6680
  },
6586
6681
  {
6587
6682
  "type": "object",
6683
+ "required": [
6684
+ "value"
6685
+ ],
6588
6686
  "properties": {
6589
6687
  "value": {
6688
+ "description": "value of variable",
6590
6689
  "oneOf": [
6591
6690
  {
6592
6691
  "type": "string"
@@ -6606,20 +6705,20 @@
6606
6705
  "$ref": "#/$defs/env_redact"
6607
6706
  }
6608
6707
  },
6609
- "required": [
6610
- "value"
6611
- ],
6612
6708
  "unevaluatedProperties": false
6613
6709
  },
6614
6710
  {
6615
6711
  "type": "object",
6712
+ "required": [
6713
+ "default"
6714
+ ],
6616
6715
  "properties": {
6617
6716
  "default": {
6618
6717
  "$ref": "#/$defs/env_default"
6619
6718
  },
6620
6719
  "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"
6720
+ "type": "string",
6721
+ "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
6722
  },
6624
6723
  "tools": {
6625
6724
  "$ref": "#/$defs/env_tools"
@@ -6628,17 +6727,17 @@
6628
6727
  "$ref": "#/$defs/env_redact"
6629
6728
  }
6630
6729
  },
6631
- "required": [
6632
- "default"
6633
- ],
6634
6730
  "unevaluatedProperties": false
6635
6731
  },
6636
6732
  {
6637
6733
  "type": "object",
6734
+ "required": [
6735
+ "required"
6736
+ ],
6638
6737
  "properties": {
6639
6738
  "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"
6739
+ "type": "string",
6740
+ "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
6741
  },
6643
6742
  "tools": {
6644
6743
  "$ref": "#/$defs/env_tools"
@@ -6647,6 +6746,7 @@
6647
6746
  "$ref": "#/$defs/env_redact"
6648
6747
  },
6649
6748
  "required": {
6749
+ "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
6750
  "oneOf": [
6651
6751
  {
6652
6752
  "const": true
@@ -6657,13 +6757,14 @@
6657
6757
  ]
6658
6758
  }
6659
6759
  },
6660
- "required": [
6661
- "required"
6662
- ],
6663
6760
  "unevaluatedProperties": false
6664
6761
  },
6665
6762
  {
6666
6763
  "type": "object",
6764
+ "description": "[experimental] age-encrypted variable",
6765
+ "required": [
6766
+ "age"
6767
+ ],
6667
6768
  "properties": {
6668
6769
  "age": {
6669
6770
  "$ref": "#/$defs/env_age"
@@ -6675,17 +6776,17 @@
6675
6776
  "$ref": "#/$defs/env_redact"
6676
6777
  }
6677
6778
  },
6678
- "required": [
6679
- "age"
6680
- ],
6681
- "unevaluatedProperties": false,
6682
- "description": "[experimental] age-encrypted variable"
6779
+ "unevaluatedProperties": false
6683
6780
  },
6684
6781
  {
6685
6782
  "type": "object",
6783
+ "required": [
6784
+ "age"
6785
+ ],
6686
6786
  "properties": {
6687
6787
  "age": {
6688
6788
  "type": "object",
6789
+ "description": "[experimental] age-encrypted value (complex format)",
6689
6790
  "properties": {
6690
6791
  "value": {
6691
6792
  "$ref": "#/$defs/env_age_value"
@@ -6703,13 +6804,9 @@
6703
6804
  "required": [
6704
6805
  "value"
6705
6806
  ],
6706
- "unevaluatedProperties": false,
6707
- "description": "[experimental] age-encrypted value (complex format)"
6807
+ "unevaluatedProperties": false
6708
6808
  }
6709
6809
  },
6710
- "required": [
6711
- "age"
6712
- ],
6713
6810
  "unevaluatedProperties": false
6714
6811
  }
6715
6812
  ]
@@ -6827,7 +6924,8 @@
6827
6924
  "type": "object",
6828
6925
  "description": "environment variables set for the wrapper",
6829
6926
  "additionalProperties": {
6830
- "type": "string"
6927
+ "type": "string",
6928
+ "description": "value of this environment variable"
6831
6929
  }
6832
6930
  }
6833
6931
  },
@@ -6960,10 +7058,11 @@
6960
7058
  },
6961
7059
  "secrets": {
6962
7060
  "type": "object",
7061
+ "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
7062
  "properties": {
6964
7063
  "fnox": {
6965
- "description": "Use fnox (fnox.toml discovered from this config's directory). https://mise.jdx.dev/environments/secrets/fnox.html",
6966
7064
  "type": "object",
7065
+ "description": "Use fnox (fnox.toml discovered from this config's directory). https://mise.jdx.dev/environments/secrets/fnox.html",
6967
7066
  "additionalProperties": false,
6968
7067
  "properties": {
6969
7068
  "profile": {
@@ -6973,7 +7072,7 @@
6973
7072
  }
6974
7073
  }
6975
7074
  },
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."
7075
+ "additionalProperties": true
6977
7076
  },
6978
7077
  "redactions": {
6979
7078
  "type": "array",
@@ -6992,13 +7091,14 @@
6992
7091
  },
6993
7092
  "deps": {
6994
7093
  "type": "object",
7094
+ "description": "[experimental] configure deps providers",
6995
7095
  "properties": {
6996
7096
  "disable": {
6997
7097
  "type": "array",
7098
+ "description": "Disable specific deps providers",
6998
7099
  "items": {
6999
7100
  "type": "string"
7000
- },
7001
- "description": "Disable specific deps providers"
7101
+ }
7002
7102
  },
7003
7103
  "npm": {
7004
7104
  "$ref": "#/$defs/deps_provider"
@@ -7048,12 +7148,11 @@
7048
7148
  },
7049
7149
  "additionalProperties": {
7050
7150
  "$ref": "#/$defs/deps_provider"
7051
- },
7052
- "description": "configure deps providers"
7151
+ }
7053
7152
  },
7054
7153
  "oci": {
7055
7154
  "type": "object",
7056
- "description": "configuration for `mise oci build`",
7155
+ "description": "[experimental] configuration for `mise oci build`",
7057
7156
  "additionalProperties": false,
7058
7157
  "properties": {
7059
7158
  "from": {
@@ -7133,14 +7232,16 @@
7133
7232
  "type": "object",
7134
7233
  "description": "Extra env vars baked into the image config",
7135
7234
  "additionalProperties": {
7136
- "type": "string"
7235
+ "type": "string",
7236
+ "description": "value of this environment variable"
7137
7237
  }
7138
7238
  },
7139
7239
  "labels": {
7140
7240
  "type": "object",
7141
7241
  "description": "Labels baked into the image config",
7142
7242
  "additionalProperties": {
7143
- "type": "string"
7243
+ "type": "string",
7244
+ "description": "value of this image label"
7144
7245
  }
7145
7246
  }
7146
7247
  }
@@ -7154,6 +7255,7 @@
7154
7255
  "type": "object",
7155
7256
  "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
7257
  "additionalProperties": {
7258
+ "description": "a dotfile: the source path of a whole-file entry, or a table describing a whole-file entry or an edit",
7157
7259
  "oneOf": [
7158
7260
  {
7159
7261
  "type": "string",
@@ -7310,6 +7412,7 @@
7310
7412
  "type": "object",
7311
7413
  "properties": {
7312
7414
  "os": {
7415
+ "description": "operating system (linux, macos, windows, or unix), optionally with an architecture such as linux/arm64; a list matches any of its values",
7313
7416
  "oneOf": [
7314
7417
  {
7315
7418
  "type": "string"
@@ -7327,7 +7430,8 @@
7327
7430
  "description": "mise environment selected with -E or MISE_ENV"
7328
7431
  },
7329
7432
  "default": {
7330
- "type": "boolean"
7433
+ "type": "boolean",
7434
+ "description": "true marks the fallback for machines that match no other variant; takes no os or profile"
7331
7435
  },
7332
7436
  "machine": {
7333
7437
  "type": "boolean",
@@ -7722,6 +7826,7 @@
7722
7826
  "description": "named directory trees of dotfiles, applied with `mise dotfiles apply` or `mise bootstrap` while [bootstrap] dotfile_groups selects them (or is unset)",
7723
7827
  "additionalProperties": {
7724
7828
  "type": "object",
7829
+ "description": "a directory tree of dotfiles deployed into a target directory",
7725
7830
  "additionalProperties": false,
7726
7831
  "properties": {
7727
7832
  "root": {
@@ -7770,6 +7875,7 @@
7770
7875
  "type": "object",
7771
7876
  "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
7877
  "additionalProperties": {
7878
+ "description": "a whole-file entry for a path inside the group's target: its source path, or a table as in [dotfiles]",
7773
7879
  "oneOf": [
7774
7880
  {
7775
7881
  "type": "string",
@@ -7800,28 +7906,35 @@
7800
7906
  "description": "Managed system files keyed by absolute target path",
7801
7907
  "additionalProperties": {
7802
7908
  "type": "object",
7909
+ "description": "file whose content, owner, group, and mode mise manages, keyed by an absolute or ~/ target path",
7803
7910
  "properties": {
7804
7911
  "phase": {
7805
7912
  "$ref": "#/$defs/bootstrap_file_phase",
7806
7913
  "default": "post-packages"
7807
7914
  },
7808
7915
  "source": {
7809
- "type": "string"
7916
+ "type": "string",
7917
+ "description": "file to copy the content from; a relative path resolves from the declaring config's directory and ~/ from your home directory"
7810
7918
  },
7811
7919
  "content": {
7812
- "type": "string"
7920
+ "type": "string",
7921
+ "description": "inline file content; cannot be combined with source"
7813
7922
  },
7814
7923
  "owner": {
7815
- "type": "string"
7924
+ "type": "string",
7925
+ "description": "user that should own the file; left as it is when unset"
7816
7926
  },
7817
7927
  "group": {
7818
- "type": "string"
7928
+ "type": "string",
7929
+ "description": "group that should own the file; left as it is when unset"
7819
7930
  },
7820
7931
  "mode": {
7821
- "type": "string"
7932
+ "type": "string",
7933
+ "description": "octal permissions such as \"0640\"; defaults to \"0644\" for a file with source or content, otherwise left as it is"
7822
7934
  },
7823
7935
  "template": {
7824
7936
  "type": "boolean",
7937
+ "description": "render source or content with mise's template engine; without it, template syntax is written unchanged",
7825
7938
  "default": false
7826
7939
  },
7827
7940
  "remove_empty": {
@@ -7831,6 +7944,7 @@
7831
7944
  },
7832
7945
  "state": {
7833
7946
  "type": "string",
7947
+ "description": "present creates or updates the file; absent removes it whatever its content",
7834
7948
  "enum": [
7835
7949
  "present",
7836
7950
  "absent"
@@ -7838,10 +7952,12 @@
7838
7952
  },
7839
7953
  "replace": {
7840
7954
  "type": "boolean",
7955
+ "description": "replace a path of another type at the target, such as an empty directory; requires source or content",
7841
7956
  "default": false
7842
7957
  },
7843
7958
  "notify": {
7844
7959
  "type": "array",
7960
+ "description": "system services declared in [bootstrap.services] to reload or restart when mise changes this file",
7845
7961
  "items": {
7846
7962
  "type": "string"
7847
7963
  }
@@ -7937,22 +8053,27 @@
7937
8053
  "description": "Managed system directories keyed by absolute target path",
7938
8054
  "additionalProperties": {
7939
8055
  "type": "object",
8056
+ "description": "directory whose owner, group, and mode mise manages, keyed by an absolute or ~/ target path",
7940
8057
  "properties": {
7941
8058
  "phase": {
7942
8059
  "$ref": "#/$defs/bootstrap_file_phase",
7943
8060
  "default": "post-packages"
7944
8061
  },
7945
8062
  "owner": {
7946
- "type": "string"
8063
+ "type": "string",
8064
+ "description": "user that should own the directory; left as it is when unset, and parents mise creates get the system defaults"
7947
8065
  },
7948
8066
  "group": {
7949
- "type": "string"
8067
+ "type": "string",
8068
+ "description": "group that should own the directory; left as it is when unset, and parents mise creates get the system defaults"
7950
8069
  },
7951
8070
  "mode": {
7952
- "type": "string"
8071
+ "type": "string",
8072
+ "description": "octal permissions such as \"0755\"; defaults to \"0755\""
7953
8073
  },
7954
8074
  "state": {
7955
8075
  "type": "string",
8076
+ "description": "present creates the directory with any missing parents; absent removes it, which must then be empty unless recursive is set",
7956
8077
  "enum": [
7957
8078
  "present",
7958
8079
  "absent"
@@ -7960,14 +8081,17 @@
7960
8081
  },
7961
8082
  "recursive": {
7962
8083
  "type": "boolean",
8084
+ "description": "with state = \"absent\", delete the directory and everything in it",
7963
8085
  "default": false
7964
8086
  },
7965
8087
  "replace": {
7966
8088
  "type": "boolean",
8089
+ "description": "replace a path of another type at the target, such as a file",
7967
8090
  "default": false
7968
8091
  },
7969
8092
  "notify": {
7970
8093
  "type": "array",
8094
+ "description": "system services declared in [bootstrap.services] to reload or restart when mise changes this directory",
7971
8095
  "items": {
7972
8096
  "type": "string"
7973
8097
  }
@@ -8038,6 +8162,7 @@
8038
8162
  "description": "remote bootstrap inventory keyed by target name",
8039
8163
  "additionalProperties": {
8040
8164
  "type": "object",
8165
+ "description": "SSH target that `mise bootstrap remote` can bootstrap, selected by name or tag",
8041
8166
  "properties": {
8042
8167
  "host": {
8043
8168
  "type": "string",
@@ -8131,9 +8256,11 @@
8131
8256
  "description": "System services and portable user services managed by mise bootstrap, keyed by service name",
8132
8257
  "additionalProperties": {
8133
8258
  "type": "object",
8259
+ "description": "Linux systemd system unit that mise starts, stops, enables, or masks, or a user service mise defines from command or builtin",
8134
8260
  "properties": {
8135
8261
  "state": {
8136
8262
  "type": "string",
8263
+ "description": "running or stopped; absent removes a user service's definition (user scope only)",
8137
8264
  "enum": [
8138
8265
  "running",
8139
8266
  "stopped",
@@ -8143,6 +8270,7 @@
8143
8270
  },
8144
8271
  "enabled": {
8145
8272
  "type": "boolean",
8273
+ "description": "start the service at boot (system scope) or at login (user scope)",
8146
8274
  "default": true
8147
8275
  },
8148
8276
  "masked": {
@@ -8183,10 +8311,12 @@
8183
8311
  "minLength": 1
8184
8312
  },
8185
8313
  "description": {
8186
- "type": "string"
8314
+ "type": "string",
8315
+ "description": "text the service manager shows for the service; user scope only"
8187
8316
  },
8188
8317
  "restart": {
8189
8318
  "type": "string",
8319
+ "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
8320
  "enum": [
8191
8321
  "always",
8192
8322
  "on-failure",
@@ -8196,15 +8326,19 @@
8196
8326
  },
8197
8327
  "environment": {
8198
8328
  "type": "object",
8329
+ "description": "environment variables for the process; user scope only",
8199
8330
  "additionalProperties": {
8200
- "type": "string"
8331
+ "type": "string",
8332
+ "description": "value of the environment variable"
8201
8333
  }
8202
8334
  },
8203
8335
  "working_directory": {
8204
- "type": "string"
8336
+ "type": "string",
8337
+ "description": "directory to run the process in, with ~ expanded; user scope only"
8205
8338
  },
8206
8339
  "requires_tools": {
8207
8340
  "type": "boolean",
8341
+ "description": "start the service only after `mise bootstrap` installs [tools] and plugin packages; user scope only",
8208
8342
  "default": false
8209
8343
  }
8210
8344
  },
@@ -8222,6 +8356,7 @@
8222
8356
  "description": "Docker Compose projects managed with `mise bootstrap compose`, keyed by project name. Text fields support Tera templates.",
8223
8357
  "additionalProperties": {
8224
8358
  "type": "object",
8359
+ "description": "Docker Compose project that mise brings up, stops, or removes",
8225
8360
  "properties": {
8226
8361
  "project_dir": {
8227
8362
  "type": "string",
@@ -8248,24 +8383,28 @@
8248
8383
  },
8249
8384
  "profiles": {
8250
8385
  "type": "array",
8386
+ "description": "Compose profiles to enable, passed with --profile",
8251
8387
  "items": {
8252
8388
  "type": "string"
8253
8389
  }
8254
8390
  },
8255
8391
  "services": {
8256
8392
  "type": "array",
8393
+ "description": "services to manage; defaults to every service the files and profiles enable",
8257
8394
  "items": {
8258
8395
  "type": "string"
8259
8396
  }
8260
8397
  },
8261
8398
  "oneshot": {
8262
8399
  "type": "array",
8400
+ "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
8401
  "items": {
8264
8402
  "type": "string"
8265
8403
  }
8266
8404
  },
8267
8405
  "state": {
8268
8406
  "type": "string",
8407
+ "description": "running (compose up), stopped (compose stop, keeping containers and data), or absent (compose down)",
8269
8408
  "enum": [
8270
8409
  "running",
8271
8410
  "stopped",
@@ -8275,6 +8414,7 @@
8275
8414
  },
8276
8415
  "pull": {
8277
8416
  "type": "string",
8417
+ "description": "image pull policy passed to compose up as --pull",
8278
8418
  "enum": [
8279
8419
  "always",
8280
8420
  "missing",
@@ -8284,6 +8424,7 @@
8284
8424
  },
8285
8425
  "build": {
8286
8426
  "type": "string",
8427
+ "description": "auto lets Compose decide, always passes --build, never passes --no-build",
8287
8428
  "enum": [
8288
8429
  "auto",
8289
8430
  "always",
@@ -8293,6 +8434,7 @@
8293
8434
  },
8294
8435
  "recreate": {
8295
8436
  "type": "string",
8437
+ "description": "auto lets Compose decide, always passes --force-recreate, never passes --no-recreate",
8296
8438
  "enum": [
8297
8439
  "auto",
8298
8440
  "always",
@@ -8302,6 +8444,7 @@
8302
8444
  },
8303
8445
  "wait": {
8304
8446
  "type": "boolean",
8447
+ "description": "pass --wait to compose up, so it waits for services to be running and healthy",
8305
8448
  "default": true
8306
8449
  },
8307
8450
  "wait_timeout": {
@@ -8316,18 +8459,22 @@
8316
8459
  },
8317
8460
  "remove_orphans": {
8318
8461
  "type": "boolean",
8462
+ "description": "remove containers for services that are no longer in the Compose model",
8319
8463
  "default": true
8320
8464
  },
8321
8465
  "renew_anonymous_volumes": {
8322
8466
  "type": "boolean",
8467
+ "description": "pass --renew-anon-volumes to compose up, recreating anonymous volumes",
8323
8468
  "default": false
8324
8469
  },
8325
8470
  "down_volumes": {
8326
8471
  "type": "boolean",
8472
+ "description": "pass --volumes to compose down, removing the project's volumes",
8327
8473
  "default": false
8328
8474
  },
8329
8475
  "down_images": {
8330
8476
  "type": "string",
8477
+ "description": "images compose down removes, passed as --rmi",
8331
8478
  "enum": [
8332
8479
  "local",
8333
8480
  "all"
@@ -8335,6 +8482,7 @@
8335
8482
  },
8336
8483
  "sudo": {
8337
8484
  "type": "boolean",
8485
+ "description": "run every Compose and engine command through sudo, for a project on the system Docker daemon",
8338
8486
  "default": false
8339
8487
  },
8340
8488
  "command": {
@@ -8489,6 +8637,7 @@
8489
8637
  "description": "git repositories to clone or update with `mise bootstrap repos apply`, keyed by target path",
8490
8638
  "additionalProperties": {
8491
8639
  "type": "object",
8640
+ "description": "git repository to clone to this path, then keep on ref when one is set",
8492
8641
  "properties": {
8493
8642
  "url": {
8494
8643
  "type": "string",
@@ -8550,13 +8699,16 @@
8550
8699
  "type": "object",
8551
8700
  "properties": {
8552
8701
  "domain": {
8553
- "type": "string"
8702
+ "type": "string",
8703
+ "description": "preferences domain, such as \"com.apple.dock\" or \"NSGlobalDomain\"; -g and -globalDomain mean NSGlobalDomain"
8554
8704
  },
8555
8705
  "key": {
8556
- "type": "string"
8706
+ "type": "string",
8707
+ "description": "preference key within the domain"
8557
8708
  },
8558
8709
  "host": {
8559
8710
  "type": "string",
8711
+ "description": "any writes the preference for every host; current writes it for this machine only, like defaults -currentHost",
8560
8712
  "enum": [
8561
8713
  "any",
8562
8714
  "current"
@@ -8572,6 +8724,7 @@
8572
8724
  "minItems": 1
8573
8725
  },
8574
8726
  "value": {
8727
+ "description": "desired value, written with the matching property list type; replaces the selected value in full",
8575
8728
  "anyOf": [
8576
8729
  {
8577
8730
  "type": "boolean"
@@ -8608,6 +8761,7 @@
8608
8761
  "description": "macOS user LaunchAgents to write and load with `mise bootstrap macos launchd-agents apply`",
8609
8762
  "additionalProperties": {
8610
8763
  "type": "object",
8764
+ "description": "macOS LaunchAgent written to ~/Library/LaunchAgents/dev.mise.<name>.plist and loaded for the current user",
8611
8765
  "properties": {
8612
8766
  "program": {
8613
8767
  "type": "string",
@@ -8691,7 +8845,8 @@
8691
8845
  "type": "object",
8692
8846
  "description": "environment variables for EnvironmentVariables",
8693
8847
  "additionalProperties": {
8694
- "type": "string"
8848
+ "type": "string",
8849
+ "description": "value of the environment variable"
8695
8850
  }
8696
8851
  },
8697
8852
  "working_directory": {
@@ -8833,6 +8988,7 @@
8833
8988
  },
8834
8989
  "state": {
8835
8990
  "type": "string",
8991
+ "description": "present adds the rule; absent removes a rule mise added earlier",
8836
8992
  "enum": [
8837
8993
  "present",
8838
8994
  "absent"
@@ -8841,6 +8997,7 @@
8841
8997
  },
8842
8998
  "direction": {
8843
8999
  "type": "string",
9000
+ "description": "traffic direction the rule matches",
8844
9001
  "enum": [
8845
9002
  "incoming",
8846
9003
  "outgoing"
@@ -8849,6 +9006,7 @@
8849
9006
  },
8850
9007
  "action": {
8851
9008
  "type": "string",
9009
+ "description": "what to do with matching traffic; limit needs incoming TCP and is not available on firewalld",
8852
9010
  "enum": [
8853
9011
  "allow",
8854
9012
  "limit",
@@ -8873,6 +9031,7 @@
8873
9031
  },
8874
9032
  "protocol": {
8875
9033
  "type": "string",
9034
+ "description": "protocol to match; any when unset, and UFW supports only tcp and udp",
8876
9035
  "enum": [
8877
9036
  "tcp",
8878
9037
  "udp",
@@ -8914,6 +9073,7 @@
8914
9073
  "description": "systemd user services and timers to write and start with `mise bootstrap linux systemd-units apply`",
8915
9074
  "additionalProperties": {
8916
9075
  "type": "object",
9076
+ "description": "systemd user unit written to ~/.config/systemd/user/dev.mise.<name>.service, or .timer when it sets a timer key",
8917
9077
  "properties": {
8918
9078
  "description": {
8919
9079
  "type": "string",
@@ -9043,7 +9203,8 @@
9043
9203
  "type": "object",
9044
9204
  "description": "environment variables for Environment entries",
9045
9205
  "additionalProperties": {
9046
- "type": "string"
9206
+ "type": "string",
9207
+ "description": "value of the environment variable"
9047
9208
  }
9048
9209
  },
9049
9210
  "environment_file": {
@@ -9388,8 +9549,8 @@
9388
9549
  "properties": {
9389
9550
  "login_shell": {
9390
9551
  "type": "string",
9391
- "description": "current user's desired login shell, applied with `chsh -s`; a template that must render to an absolute path",
9392
- "pattern": "^\\s*(?:/|\\{[{%])"
9552
+ "description": "current user's desired login shell, applied with `chsh -s`; an absolute path or a bare shell name resolved after packages are installed; may be a template",
9553
+ "pattern": "^\\s*(?:/|\\{[{%]|[^/\\\\{\\s][^/\\\\]*$)"
9393
9554
  }
9394
9555
  },
9395
9556
  "additionalProperties": false
@@ -9426,7 +9587,8 @@
9426
9587
  "type": "object",
9427
9588
  "description": "Homebrew tap names mapped to custom git URLs",
9428
9589
  "additionalProperties": {
9429
- "type": "string"
9590
+ "type": "string",
9591
+ "description": "git URL of the tap's GitHub repository, used instead of https://github.com/<owner>/homebrew-<tap>.git"
9430
9592
  }
9431
9593
  }
9432
9594
  },
@@ -9483,6 +9645,7 @@
9483
9645
  "description": "[experimental] Linux groups that bootstrap creates or removes, keyed by group name",
9484
9646
  "additionalProperties": {
9485
9647
  "type": "object",
9648
+ "description": "local Linux group that bootstrap creates, updates, or removes",
9486
9649
  "properties": {
9487
9650
  "state": {
9488
9651
  "description": "whether the group should exist",
@@ -9537,6 +9700,7 @@
9537
9700
  "description": "[experimental] Linux users that bootstrap creates or removes, keyed by user name",
9538
9701
  "additionalProperties": {
9539
9702
  "type": "object",
9703
+ "description": "local Linux user that bootstrap creates, updates, or removes",
9540
9704
  "properties": {
9541
9705
  "state": {
9542
9706
  "description": "whether the user should exist",
@@ -9709,6 +9873,7 @@
9709
9873
  "properties": {
9710
9874
  "encryption": {
9711
9875
  "type": "object",
9876
+ "description": "encryption for dotfiles tracked with encrypt = true",
9712
9877
  "additionalProperties": false,
9713
9878
  "properties": {
9714
9879
  "recipients": {
@@ -9738,9 +9903,10 @@
9738
9903
  },
9739
9904
  "reload": {
9740
9905
  "type": "object",
9741
- "description": "commands run once after a rollback or undo writes a path matching the glob (trusted global or system config only)",
9906
+ "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
9907
  "additionalProperties": {
9743
- "type": "string"
9908
+ "type": "string",
9909
+ "description": "command to run once when a rollback, undo, pull, or dotfiles apply writes a path matching this glob"
9744
9910
  }
9745
9911
  },
9746
9912
  "origin": {
@@ -9790,6 +9956,7 @@
9790
9956
  "tools": {
9791
9957
  "patternProperties": {
9792
9958
  "^github:": {
9959
+ "description": "a tool installed with the github backend",
9793
9960
  "oneOf": [
9794
9961
  {
9795
9962
  "type": "array",
@@ -9803,6 +9970,7 @@
9803
9970
  ]
9804
9971
  },
9805
9972
  "^gitlab:": {
9973
+ "description": "a tool installed with the gitlab backend",
9806
9974
  "oneOf": [
9807
9975
  {
9808
9976
  "type": "array",
@@ -9816,6 +9984,7 @@
9816
9984
  ]
9817
9985
  },
9818
9986
  "^forgejo:": {
9987
+ "description": "a tool installed with the forgejo backend",
9819
9988
  "oneOf": [
9820
9989
  {
9821
9990
  "type": "array",
@@ -9829,6 +9998,7 @@
9829
9998
  ]
9830
9999
  },
9831
10000
  "^ubi:": {
10001
+ "description": "a tool installed with the ubi backend",
9832
10002
  "oneOf": [
9833
10003
  {
9834
10004
  "type": "array",
@@ -9842,6 +10012,7 @@
9842
10012
  ]
9843
10013
  },
9844
10014
  "^http:": {
10015
+ "description": "a tool installed with the http backend",
9845
10016
  "oneOf": [
9846
10017
  {
9847
10018
  "type": "array",
@@ -9855,6 +10026,7 @@
9855
10026
  ]
9856
10027
  },
9857
10028
  "^s3:": {
10029
+ "description": "a tool installed with the s3 backend",
9858
10030
  "oneOf": [
9859
10031
  {
9860
10032
  "type": "array",
@@ -9868,6 +10040,7 @@
9868
10040
  ]
9869
10041
  },
9870
10042
  "^aqua:": {
10043
+ "description": "a tool installed with the aqua backend",
9871
10044
  "oneOf": [
9872
10045
  {
9873
10046
  "type": "array",
@@ -9881,6 +10054,7 @@
9881
10054
  ]
9882
10055
  },
9883
10056
  "^cargo:": {
10057
+ "description": "a tool installed with the cargo backend",
9884
10058
  "oneOf": [
9885
10059
  {
9886
10060
  "type": "array",
@@ -9894,6 +10068,7 @@
9894
10068
  ]
9895
10069
  },
9896
10070
  "^npm:": {
10071
+ "description": "a tool installed with the npm backend",
9897
10072
  "oneOf": [
9898
10073
  {
9899
10074
  "type": "array",
@@ -9907,6 +10082,7 @@
9907
10082
  ]
9908
10083
  },
9909
10084
  "^(pypi|pipx):": {
10085
+ "description": "a tool installed with the pypi backend",
9910
10086
  "oneOf": [
9911
10087
  {
9912
10088
  "type": "array",
@@ -9920,6 +10096,7 @@
9920
10096
  ]
9921
10097
  },
9922
10098
  "^gem:": {
10099
+ "description": "a tool installed with the gem backend",
9923
10100
  "oneOf": [
9924
10101
  {
9925
10102
  "type": "array",
@@ -9933,6 +10110,7 @@
9933
10110
  ]
9934
10111
  },
9935
10112
  "^go:": {
10113
+ "description": "a tool installed with the go backend",
9936
10114
  "oneOf": [
9937
10115
  {
9938
10116
  "type": "array",
@@ -9946,6 +10124,7 @@
9946
10124
  ]
9947
10125
  },
9948
10126
  "^conda:": {
10127
+ "description": "a tool installed with the conda backend",
9949
10128
  "oneOf": [
9950
10129
  {
9951
10130
  "type": "array",
@@ -9959,6 +10138,7 @@
9959
10138
  ]
9960
10139
  },
9961
10140
  "^spm:": {
10141
+ "description": "a tool installed with the spm backend",
9962
10142
  "oneOf": [
9963
10143
  {
9964
10144
  "type": "array",
@@ -9972,6 +10152,7 @@
9972
10152
  ]
9973
10153
  },
9974
10154
  "^packslip:": {
10155
+ "description": "a tool installed with the packslip backend",
9975
10156
  "oneOf": [
9976
10157
  {
9977
10158
  "type": "array",
@@ -9985,6 +10166,7 @@
9985
10166
  ]
9986
10167
  },
9987
10168
  "^spinel:": {
10169
+ "description": "a tool installed with the spinel backend",
9988
10170
  "oneOf": [
9989
10171
  {
9990
10172
  "type": "array",
@@ -9998,6 +10180,7 @@
9998
10180
  ]
9999
10181
  },
10000
10182
  "^(core:)?python(\\[.*\\])?$": {
10183
+ "description": "the core python tool",
10001
10184
  "oneOf": [
10002
10185
  {
10003
10186
  "type": "array",
@@ -10011,6 +10194,7 @@
10011
10194
  ]
10012
10195
  },
10013
10196
  "^(core:)?java(\\[.*\\])?$": {
10197
+ "description": "the core java tool",
10014
10198
  "oneOf": [
10015
10199
  {
10016
10200
  "type": "array",
@@ -10024,6 +10208,7 @@
10024
10208
  ]
10025
10209
  },
10026
10210
  "^(core:)?rust(\\[.*\\])?$": {
10211
+ "description": "the core rust tool",
10027
10212
  "oneOf": [
10028
10213
  {
10029
10214
  "type": "array",
@@ -10037,6 +10222,7 @@
10037
10222
  ]
10038
10223
  },
10039
10224
  "^(core:dotnet|dotnet|dotnet-core)(\\[.*\\])?$": {
10225
+ "description": "the core dotnet tool",
10040
10226
  "oneOf": [
10041
10227
  {
10042
10228
  "type": "array",
@@ -10051,6 +10237,7 @@
10051
10237
  }
10052
10238
  },
10053
10239
  "additionalProperties": {
10240
+ "description": "a version of the tool, or a table with its version and options",
10054
10241
  "oneOf": [
10055
10242
  {
10056
10243
  "items": {
@@ -10080,6 +10267,7 @@
10080
10267
  },
10081
10268
  "_": {
10082
10269
  "type": "object",
10270
+ "description": "free-form data for your own use; mise never reads it",
10083
10271
  "additionalProperties": true
10084
10272
  },
10085
10273
  "doctor": {
@@ -10087,7 +10275,9 @@
10087
10275
  },
10088
10276
  "daemons": {
10089
10277
  "type": "object",
10278
+ "description": "Experimental project daemons: custom pitchfork commands or managed presets.",
10090
10279
  "additionalProperties": {
10280
+ "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
10281
  "oneOf": [
10092
10282
  {
10093
10283
  "type": "string",
@@ -10095,52 +10285,17 @@
10095
10285
  },
10096
10286
  {
10097
10287
  "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
10288
  "properties": {
10136
10289
  "run": {
10137
- "type": "string"
10290
+ "type": "string",
10291
+ "description": "Shell command for the daemon's long-running process."
10138
10292
  },
10139
10293
  "init": {
10140
10294
  "$ref": "#/$defs/daemon_init"
10141
10295
  },
10142
10296
  "mise": {
10143
- "type": "boolean"
10297
+ "type": "boolean",
10298
+ "description": "false runs the process and its setup without the project's tool environment."
10144
10299
  },
10145
10300
  "port": {
10146
10301
  "oneOf": [
@@ -10168,28 +10323,30 @@
10168
10323
  "$ref": "#/$defs/daemon_proxy_idle_timeout"
10169
10324
  }
10170
10325
  },
10171
- "additionalProperties": true
10172
- },
10173
- {
10174
- "type": "object",
10175
10326
  "required": [
10176
- "task"
10327
+ "run"
10177
10328
  ],
10329
+ "additionalProperties": true,
10178
10330
  "not": {
10179
10331
  "anyOf": [
10180
10332
  {
10181
10333
  "required": [
10182
- "run"
10334
+ "preset"
10183
10335
  ]
10184
10336
  },
10185
10337
  {
10186
10338
  "required": [
10187
- "preset"
10339
+ "project"
10188
10340
  ]
10189
10341
  },
10190
10342
  {
10191
10343
  "required": [
10192
- "project"
10344
+ "task"
10345
+ ]
10346
+ },
10347
+ {
10348
+ "required": [
10349
+ "args"
10193
10350
  ]
10194
10351
  },
10195
10352
  {
@@ -10203,15 +10360,18 @@
10203
10360
  ]
10204
10361
  }
10205
10362
  ]
10206
- },
10363
+ }
10364
+ },
10365
+ {
10366
+ "type": "object",
10207
10367
  "properties": {
10208
10368
  "task": {
10209
- "description": "mise task run as this daemon's long-running process",
10210
- "type": "string"
10369
+ "type": "string",
10370
+ "description": "mise task run as this daemon's long-running process"
10211
10371
  },
10212
10372
  "args": {
10213
- "description": "arguments passed to the task after `--`",
10214
10373
  "type": "array",
10374
+ "description": "arguments passed to the task after `--`",
10215
10375
  "items": {
10216
10376
  "type": "string"
10217
10377
  }
@@ -10229,29 +10389,25 @@
10229
10389
  "$ref": "#/$defs/daemon_proxy_idle_timeout"
10230
10390
  }
10231
10391
  },
10232
- "additionalProperties": true
10233
- },
10234
- {
10235
- "type": "object",
10236
10392
  "required": [
10237
- "preset",
10238
- "version"
10393
+ "task"
10239
10394
  ],
10395
+ "additionalProperties": true,
10240
10396
  "not": {
10241
10397
  "anyOf": [
10242
10398
  {
10243
10399
  "required": [
10244
- "project"
10400
+ "run"
10245
10401
  ]
10246
10402
  },
10247
10403
  {
10248
10404
  "required": [
10249
- "task"
10405
+ "preset"
10250
10406
  ]
10251
10407
  },
10252
10408
  {
10253
10409
  "required": [
10254
- "args"
10410
+ "project"
10255
10411
  ]
10256
10412
  },
10257
10413
  {
@@ -10265,15 +10421,19 @@
10265
10421
  ]
10266
10422
  }
10267
10423
  ]
10268
- },
10424
+ }
10425
+ },
10426
+ {
10427
+ "type": "object",
10269
10428
  "properties": {
10270
10429
  "data_dir": {
10271
10430
  "type": "string",
10272
- "minLength": 1,
10273
- "description": "Persistent preset data directory, relative to the declaring project root or absolute. Defaults to mise state storage."
10431
+ "description": "Persistent preset data directory, relative to the declaring project root or absolute. Defaults to mise state storage.",
10432
+ "minLength": 1
10274
10433
  },
10275
10434
  "preset": {
10276
10435
  "type": "string",
10436
+ "description": "Service preset that supplies the daemon's command, port and data directory.",
10277
10437
  "enum": [
10278
10438
  "cockroachdb",
10279
10439
  "nats",
@@ -10283,7 +10443,8 @@
10283
10443
  ]
10284
10444
  },
10285
10445
  "version": {
10286
- "type": "string"
10446
+ "type": "string",
10447
+ "description": "Version request for the preset's tool."
10287
10448
  },
10288
10449
  "port": {
10289
10450
  "$ref": "#/$defs/daemon_port"
@@ -10293,15 +10454,18 @@
10293
10454
  "description": "Overrides for the preset's additional named ports.",
10294
10455
  "additionalProperties": {
10295
10456
  "type": "integer",
10457
+ "description": "Port for this named port of the preset.",
10296
10458
  "minimum": 1,
10297
10459
  "maximum": 65535
10298
10460
  }
10299
10461
  },
10300
10462
  "options": {
10301
- "type": "object"
10463
+ "type": "object",
10464
+ "description": "Preset options, such as `database`."
10302
10465
  },
10303
10466
  "run": {
10304
- "type": "string"
10467
+ "type": "string",
10468
+ "description": "Shell command that replaces the preset's command."
10305
10469
  },
10306
10470
  "init": {
10307
10471
  "$ref": "#/$defs/daemon_init"
@@ -10316,14 +10480,45 @@
10316
10480
  "$ref": "#/$defs/daemon_proxy_idle_timeout"
10317
10481
  }
10318
10482
  },
10319
- "additionalProperties": true
10483
+ "required": [
10484
+ "preset",
10485
+ "version"
10486
+ ],
10487
+ "additionalProperties": true,
10488
+ "not": {
10489
+ "anyOf": [
10490
+ {
10491
+ "required": [
10492
+ "project"
10493
+ ]
10494
+ },
10495
+ {
10496
+ "required": [
10497
+ "task"
10498
+ ]
10499
+ },
10500
+ {
10501
+ "required": [
10502
+ "args"
10503
+ ]
10504
+ },
10505
+ {
10506
+ "required": [
10507
+ "provider"
10508
+ ]
10509
+ },
10510
+ {
10511
+ "required": [
10512
+ "resource"
10513
+ ]
10514
+ }
10515
+ ]
10516
+ }
10320
10517
  },
10321
10518
  {
10322
10519
  "type": "object",
10323
10520
  "description": "Daemon declared by another project, run under that project's namespace and root.",
10324
- "required": [
10325
- "project"
10326
- ],
10521
+ "additionalProperties": false,
10327
10522
  "properties": {
10328
10523
  "project": {
10329
10524
  "type": "string",
@@ -10334,13 +10529,12 @@
10334
10529
  "description": "Daemon name inside the referenced project, when it differs from this key."
10335
10530
  }
10336
10531
  },
10337
- "additionalProperties": false
10532
+ "required": [
10533
+ "project"
10534
+ ]
10338
10535
  },
10339
10536
  {
10340
10537
  "type": "object",
10341
- "required": [
10342
- "provider"
10343
- ],
10344
10538
  "additionalProperties": false,
10345
10539
  "properties": {
10346
10540
  "provider": {
@@ -10349,29 +10543,27 @@
10349
10543
  },
10350
10544
  "resource": {
10351
10545
  "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."
10546
+ "description": "Database or NATS account shared by consumers choosing this name. Omit for a checkout-specific resource.",
10547
+ "pattern": "^[a-z][a-z0-9_]{0,62}$"
10354
10548
  }
10355
- }
10549
+ },
10550
+ "required": [
10551
+ "provider"
10552
+ ]
10356
10553
  }
10357
10554
  ]
10358
- },
10359
- "description": "Experimental project daemons: custom pitchfork commands or managed presets."
10555
+ }
10360
10556
  },
10361
10557
  "daemon_providers": {
10362
10558
  "type": "object",
10363
- "propertyNames": {
10364
- "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
10365
- },
10559
+ "description": "Experimental shared servers owned by the user. Only allowed in global configuration.",
10366
10560
  "additionalProperties": {
10367
10561
  "type": "object",
10368
- "required": [
10369
- "preset",
10370
- "version"
10371
- ],
10562
+ "description": "A PostgreSQL, CockroachDB or NATS server that every checkout shares, with a separate database or NATS account for each.",
10372
10563
  "additionalProperties": false,
10373
10564
  "properties": {
10374
10565
  "preset": {
10566
+ "description": "Service preset that runs the server.",
10375
10567
  "enum": [
10376
10568
  "postgres",
10377
10569
  "cockroachdb",
@@ -10379,32 +10571,44 @@
10379
10571
  ]
10380
10572
  },
10381
10573
  "version": {
10382
- "type": "string"
10574
+ "type": "string",
10575
+ "description": "Version request for the preset's tool."
10383
10576
  },
10384
10577
  "port": {
10385
10578
  "$ref": "#/$defs/daemon_port"
10386
10579
  },
10387
10580
  "ports": {
10388
10581
  "type": "object",
10582
+ "description": "Overrides for the preset's additional named ports.",
10389
10583
  "additionalProperties": {
10390
10584
  "type": "integer",
10585
+ "description": "Port for this named port of the preset.",
10391
10586
  "minimum": 1,
10392
10587
  "maximum": 65535
10393
10588
  }
10394
10589
  },
10395
10590
  "options": {
10396
- "type": "object"
10591
+ "type": "object",
10592
+ "description": "Preset options, such as `database`."
10397
10593
  },
10398
10594
  "data_dir": {
10399
10595
  "type": "string",
10596
+ "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
10597
  "minLength": 1
10401
10598
  },
10402
10599
  "tool": {
10403
- "type": "string"
10600
+ "type": "string",
10601
+ "description": "Tool to install the server from, in place of the preset's default."
10404
10602
  }
10405
- }
10603
+ },
10604
+ "required": [
10605
+ "preset",
10606
+ "version"
10607
+ ]
10406
10608
  },
10407
- "description": "Experimental shared servers owned by the user. Only allowed in global configuration."
10609
+ "propertyNames": {
10610
+ "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
10611
+ }
10408
10612
  },
10409
10613
  "daemons_settings": {
10410
10614
  "type": "object",