.promptdeploy.yml

The .promptdeploy.yml file lives in your repository root and defines which files PromptDeploy should manage as editable prompts.

This file is optional. You can also configure prompts manually through the PromptDeploy UI — just connect a repository and add prompts by browsing the file tree. The config file is useful for teams who prefer to manage prompt definitions in version control.

Full example

prompts:
  - path: app/prompts/system.txt
    name: System Prompt
    description: Main system instructions for the AI assistant
    deploy_mode: pr
    provider: anthropic
    model: claude-sonnet-4-20250514
    temperature: 0.7
    variables:
      - name: tone
        description: Voice tone for responses
        default: professional
      - name: language
        description: Output language
        default: en

  - path: app/prompts/greeting.md
    name: Greeting Template
    description: Welcome message shown to new users
    deploy_mode: direct

Schema

Top level

Key Type Required Description
prompts Array Yes List of prompt definitions

Prompt definition

Key Type Required Default Description
path String Yes — File path relative to repo root
name String Yes — Display name in the PromptDeploy UI
description String No — Brief description of the prompt's purpose
deploy_mode String No direct direct or pr
provider String No — AI provider (e.g. anthropic, openai)
model String No — Model identifier
temperature Number No — Temperature setting (0.00–2.00)
variables Array No — Template variable definitions

Variable definition

Key Type Required Description
name String Yes Variable name
description String No What this variable controls
default String No Default value

Behaviour

  • When you connect a repository, PromptDeploy reads this file from the default branch
  • Prompt configs are created for each entry in the prompts array
  • The path must point to an existing file in the repository
  • Each path must be unique within the config
  • If the file is later deleted from the repo, the prompt config remains but editing will show an error

Syncing changes

After editing .promptdeploy.yml in your repo, click Sync config on the repository page in PromptDeploy to re-import. This will:

  • Add new prompt entries that don't exist yet
  • Update existing entries with changed metadata
  • Existing prompts not in the config are not removed (to avoid accidental deletion)

File path rules

  • Paths are relative to the repository root
  • Use forward slashes (/) regardless of OS
  • The file must exist in the repository at the time of import
  • Any file extension is supported — PromptDeploy treats the file as text regardless of extension
← Previous Overview Next → Deploy Modes