chore: import upstream snapshot with attribution
CI / Shell Format Check (push) Has been cancelled
CI / Check Ruby (3.4) (push) Has been cancelled
CI / CI Config (push) Has been cancelled
CI / Test on Node ${{ matrix.node }} and ${{ matrix.os }}${{ matrix.shard && format(' (shard {0}/3)', matrix.shard) || '' }} (push) Has been cancelled
CI / Build on Node ${{ matrix.node }} (push) Has been cancelled
CI / Style Check (push) Has been cancelled
CI / Generate Assets (push) Has been cancelled
CI / Check Python (3.14) (push) Has been cancelled
CI / Check Python (3.9) (push) Has been cancelled
CI / Build Docs (push) Has been cancelled
CI / Code Scan Action (push) Has been cancelled
CI / Site tests (push) Has been cancelled
CI / webui tests (push) Has been cancelled
CI / Run Integration Tests (push) Has been cancelled
CI / Run Smoke Tests (push) Has been cancelled
CI / Go Tests (push) Has been cancelled
CI / Share Test (push) Has been cancelled
CI / Redteam (Production API) (push) Has been cancelled
CI / Redteam (Staging API) (push) Has been cancelled
CI / GitHub Actions Lint (push) Has been cancelled
CI / Check Ruby (3.0) (push) Has been cancelled
release-please / release-please (push) Has been cancelled
release-please / build (push) Has been cancelled
release-please / publish-npm (push) Has been cancelled
release-please / publish-npm-backfill (push) Has been cancelled
release-please / docker (push) Has been cancelled
release-please / publish-code-scan-action (push) Has been cancelled
release-please / attest-code-scan-action (push) Has been cancelled
Deploy local.promptfoo.app / Deploy to Cloudflare Pages (push) Has been cancelled
Test and Publish Multi-arch Docker Image / test (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-amd64 platform:linux/amd64 runner:ubuntu-latest]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-arm64 platform:linux/arm64 runner:ubuntu-24.04-arm]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / merge-docker-digests (push) Has been cancelled
Test and Publish Multi-arch Docker Image / Attest Multi-arch Image (push) Has been cancelled
Validate Renovate Config / Validate Renovate Configuration (push) Has been cancelled
CI / Shell Format Check (push) Has been cancelled
CI / Check Ruby (3.4) (push) Has been cancelled
CI / CI Config (push) Has been cancelled
CI / Test on Node ${{ matrix.node }} and ${{ matrix.os }}${{ matrix.shard && format(' (shard {0}/3)', matrix.shard) || '' }} (push) Has been cancelled
CI / Build on Node ${{ matrix.node }} (push) Has been cancelled
CI / Style Check (push) Has been cancelled
CI / Generate Assets (push) Has been cancelled
CI / Check Python (3.14) (push) Has been cancelled
CI / Check Python (3.9) (push) Has been cancelled
CI / Build Docs (push) Has been cancelled
CI / Code Scan Action (push) Has been cancelled
CI / Site tests (push) Has been cancelled
CI / webui tests (push) Has been cancelled
CI / Run Integration Tests (push) Has been cancelled
CI / Run Smoke Tests (push) Has been cancelled
CI / Go Tests (push) Has been cancelled
CI / Share Test (push) Has been cancelled
CI / Redteam (Production API) (push) Has been cancelled
CI / Redteam (Staging API) (push) Has been cancelled
CI / GitHub Actions Lint (push) Has been cancelled
CI / Check Ruby (3.0) (push) Has been cancelled
release-please / release-please (push) Has been cancelled
release-please / build (push) Has been cancelled
release-please / publish-npm (push) Has been cancelled
release-please / publish-npm-backfill (push) Has been cancelled
release-please / docker (push) Has been cancelled
release-please / publish-code-scan-action (push) Has been cancelled
release-please / attest-code-scan-action (push) Has been cancelled
Deploy local.promptfoo.app / Deploy to Cloudflare Pages (push) Has been cancelled
Test and Publish Multi-arch Docker Image / test (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-amd64 platform:linux/amd64 runner:ubuntu-latest]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-arm64 platform:linux/arm64 runner:ubuntu-24.04-arm]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / merge-docker-digests (push) Has been cancelled
Test and Publish Multi-arch Docker Image / Attest Multi-arch Image (push) Has been cancelled
Validate Renovate Config / Validate Renovate Configuration (push) Has been cancelled
This commit is contained in:
@@ -0,0 +1,72 @@
|
||||
# config-executable-prompts (Executable Prompts)
|
||||
|
||||
This example demonstrates how to use executable scripts and binaries as prompt generators in promptfoo.
|
||||
|
||||
To initialize and run it:
|
||||
|
||||
```bash
|
||||
npx promptfoo@latest init --example config-executable-prompts
|
||||
cd config-executable-prompts
|
||||
promptfoo eval
|
||||
```
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- bash/zsh (macOS/Linux) or PowerShell (Windows)
|
||||
- jq (for the shell example): https://stedolan.github.io/jq/
|
||||
- Ruby 3.x (for the Ruby example)
|
||||
- Make scripts executable: `chmod +x prompt-generator.sh template-prompt.rb`
|
||||
|
||||
## Overview
|
||||
|
||||
Promptfoo supports using any executable (shell scripts, Python scripts, binaries, etc.) to dynamically generate prompts. This is useful when you need to:
|
||||
|
||||
- Generate prompts based on external data sources
|
||||
- Create context-aware prompts dynamically
|
||||
- Integrate with existing tools and scripts
|
||||
- Generate prompts in languages other than JavaScript or Python
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **Script Input**: Your executable receives a JSON context as its first command-line argument containing:
|
||||
- `vars`: Test variables from your configuration
|
||||
- `provider`: Information about the current provider
|
||||
- `config`: Any additional configuration passed to the prompt
|
||||
|
||||
2. **Script Output**: Your script should output the generated prompt to stdout
|
||||
|
||||
3. **Error Handling**:
|
||||
- Errors should be written to stderr
|
||||
- Non-zero exit codes will cause the prompt generation to fail
|
||||
|
||||
## Usage Methods
|
||||
|
||||
### Method 1: Using `exec:` prefix
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- exec:./my-script.sh
|
||||
- exec:/usr/bin/custom-prompt-generator
|
||||
```
|
||||
|
||||
### Method 2: Direct file reference (auto-detected)
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- ./my-script.sh # Detected by .sh extension
|
||||
# Note: Python files (.py) are processed as Python prompt templates by default.
|
||||
# To run a Python script as an executable prompt, use the exec: prefix:
|
||||
# - exec:./generator.py
|
||||
```
|
||||
|
||||
### Method 3: With configuration
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- label: 'Custom Prompt'
|
||||
raw: exec:./generator.sh
|
||||
config:
|
||||
temperature: 0.7
|
||||
style: technical
|
||||
timeout: 30000 # 30 second timeout (default: 60s)
|
||||
```
|
||||
Reference in New Issue
Block a user