obsidian-promptfire/docs/settings.md
Luca G. Oelfke e7243e3cc1
docs: slim down README and extract detailed docs to docs/
Move comprehensive documentation (settings, templates, output targets,
frontmatter presets, etc.) from the 510-line README into 9 focused files
under docs/. README is now a scannable overview with links to each doc.
Replace GitHub links with Codeberg equivalents.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-06 12:46:15 +01:00

61 lines
2 KiB
Markdown

# Settings Reference
Complete reference of all Promptfire settings.
## General
| Setting | Description | Default |
|---------|-------------|---------|
| **Context folder** | Folder with context files | `_context` |
| **Separator** | Text between files | `---` |
| **Include filenames** | Add `# === file.md ===` headers | On |
| **Show preview** | Preview before copying | Off |
| **Include active note** | Always append current note | Off |
| **Excluded files** | Files to skip | - |
## Context Sources
| Setting | Description |
|---------|-------------|
| **Freetext** | Static text snippets |
| **External File** | Absolute path to file outside vault |
| **Shell Command** | Command + args with timeout |
| **Position** | Prefix (before) or Suffix (after) vault content |
| **Show labels** | Add source name headers to output |
See [Context Sources](context-sources.md) for detailed usage.
## Prompt Templates
| Setting | Description |
|---------|-------------|
| **Name** | Display name |
| **Content** | Template with placeholders |
| **Default** | Use automatically when copying |
See [Templates](templates.md) for placeholders and conditionals.
## History
| Setting | Description | Default |
|---------|-------------|---------|
| **Enabled** | Save generated contexts | On |
| **Storage folder** | Where to store history | `.context-history` |
| **Max entries** | Limit stored entries | 50 |
| **Auto-cleanup** | Delete after X days | 30 |
See [History](history.md) for more details.
## Output Targets
| Setting | Description |
|---------|-------------|
| **Name** | Display name (e.g., "Claude", "GPT-4") |
| **Max tokens** | Token limit for truncation |
| **Format** | markdown, xml, or plain |
| **Strategy** | summarize-headers, drop-sections, truncate |
| **Wrapper** | Prefix/suffix text around content |
| **Primary** | Which target goes to clipboard |
| **Output folder** | Where to save secondary targets |
See [Output Targets](output-targets.md) for format details and strategies.