Skip to content

Configuration Reference

Full content coming soon. Meanwhile, see the Chinese version.

SpecLore's configuration file is located at .speclore/config.yaml, automatically generated by speclore setup.


Quick Reference

yaml
project:
  name: my-project              # Project name
  language: typescript           # Project language
  framework: nestjs              # Framework
  profile: normal                # Constraint level: strict | normal | minimal

ai:
  provider: openai-compatible      # AI provider: openai-compatible | claude | ollama
  baseUrl: https://api.openai.com/v1
  model: gpt-4
  apiKeyEnv: OPENAI_API_KEY        # API Key environment variable

spec:
  outputDir: specs                 # .feature file output directory
  defaultLanguage: zh-CN           # Default language

verify:
  command: npm test                # Test command
  timeout: 300                     # Timeout (seconds)
  mapping:
    patterns:
      - feature: "specs/{module}/{name}.feature"
        test: "tests/{module}/{name}.test.*"

Released under the MIT License.