spec-kit/presets/scaffold/preset.yml at 7f64380842a3e829c2e9418018ab7a0e73979ee6 · github/spec-kit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
schema_version: "1.0"

preset:
  # CUSTOMIZE: Change 'my-preset' to your preset ID (lowercase, hyphen-separated)
  id: "my-preset"

  # CUSTOMIZE: Human-readable name for your preset
  name: "My Preset"

  # CUSTOMIZE: Update version when releasing (semantic versioning: X.Y.Z)
  version: "1.0.0"

  # CUSTOMIZE: Brief description (under 200 characters)
  description: "Brief description of what your preset provides"

  # CUSTOMIZE: Your name or organization name
  author: "Your Name"

  # CUSTOMIZE: GitHub repository URL (create before publishing)
  repository: "https://github.com/your-org/spec-kit-preset-my-preset"

  # REVIEW: License (MIT is recommended for open source)
  license: "MIT"

# Requirements for this preset
requires:
  # CUSTOMIZE: Minimum spec-kit version required
  speckit_version: ">=0.1.0"

# Templates provided by this preset
provides:
  templates:
    # CUSTOMIZE: Define your template overrides
    # Templates are document scaffolds (spec-template.md, plan-template.md, etc.)
    #
    # Strategy options (optional, defaults to "replace"):
    #   replace  - Fully replaces the lower-priority template (default)
    #   prepend  - Places this content BEFORE the lower-priority template
    #   append   - Places this content AFTER the lower-priority template
    #   wrap     - Uses {CORE_TEMPLATE} placeholder, replaced with lower-priority content
    #
    # Note: Scripts only support "replace" and "wrap" strategies.
    - type: "template"
      name: "spec-template"
      file: "templates/spec-template.md"
      description: "Custom feature specification template"
      replaces: "spec-template"  # Which core template this overrides (optional)

    # ADD MORE TEMPLATES: Copy this block for each template
    # - type: "template"
    #   name: "plan-template"
    #   file: "templates/plan-template.md"
    #   description: "Custom plan template"
    #   replaces: "plan-template"

    # COMPOSITION EXAMPLES:
    # Append additional sections to an existing template:
    # - type: "template"
    #   name: "spec-template"
    #   file: "templates/spec-addendum.md"
    #   description: "Add compliance section to spec template"
    #   strategy: "append"
    #
    # Wrap a command with preamble/sign-off:
    # - type: "command"
    #   name: "speckit.specify"
    #   file: "commands/specify-wrapper.md"
    #   description: "Wrap specify command with compliance checks"
    #   strategy: "wrap"
    #   # In the wrapper file, use {CORE_TEMPLATE} where the original content goes

    # OVERRIDE EXTENSION TEMPLATES:
    # Presets sit above extensions in the resolution stack, so you can
    # override templates provided by any installed extension.
    # For example, if the "myext" extension provides a spec-template,
    # the preset's version above will take priority automatically.

    # Override a template provided by the "myext" extension:
    - type: "template"
      name: "myext-template"
      file: "templates/myext-template.md"
      description: "Override myext's report template"
      replaces: "myext-template"

    # Command overrides (AI agent workflow prompts)
    # Presets can override both core and extension commands.
    # Commands are automatically registered into all detected agent
    # directories (.claude/commands/, .gemini/commands/, etc.)

    # Override a core command:
    - type: "command"
      name: "speckit.specify"
      file: "commands/speckit.specify.md"
      description: "Custom specification command"
      replaces: "speckit.specify"

    # Override an extension command (e.g. from the "myext" extension):
    - type: "command"
      name: "speckit.myext.myextcmd"
      file: "commands/speckit.myext.myextcmd.md"
      description: "Override myext's myextcmd command with custom workflow"
      replaces: "speckit.myext.myextcmd"

    # Script templates (reserved for future use)
    # - type: "script"
    #   name: "create-new-feature"
    #   file: "scripts/bash/create-new-feature.sh"
    #   description: "Custom feature creation script"
    #   replaces: "create-new-feature"

# CUSTOMIZE: Add relevant tags (2-5 recommended)
# Used for discovery in catalog
tags:
  - "example"
  - "preset"