TextPrompts.jl

A minimal, zero-complexity prompt loader with TOML front-matter metadata for Julia.

TextPrompts.jl allows you to manage prompts as text files next to your code with optional metadata, providing safe string formatting and easy bulk loading.

Installation

using Pkg
Pkg.add("TextPrompts")

Quick Start

using TextPrompts

# Load a prompt file
prompt = load_prompt("prompts/greeting.txt")

# Access content and metadata
println(prompt.prompt)        # The prompt text
println(prompt.meta.title)    # Metadata title

# Format with placeholders - call the prompt as a function
result = prompt(; name="World", day="Monday")

File Format

Prompt files can optionally include TOML front-matter:

---
title = "Greeting Prompt"
version = "1.0.0"
description = "A friendly greeting"
author = "Your Name"
created = "2024-01-15"
---

Hello, {name}!

Today is {day} and the weather is {weather}.

Or just plain text:

Hello, {name}!

This is a simple prompt without metadata.

Metadata Modes

TextPrompts supports three metadata handling modes:

# Set global mode
set_metadata(:strict)

# Or per-file
prompt = load_prompt("simple.txt"; meta=:ignore)

Key Features

• Zero complexity: Simple text files with optional TOML metadata
• Safe formatting: Catches missing placeholder values
• Flexible modes: Strict validation or relaxed parsing
• Bulk loading: Load entire directories of prompts
• Git-friendly: Text files work well with version control

Using with PromptingTools.jl

TextPrompts integrates seamlessly with PromptingTools.jl for building LLM applications:

using TextPrompts
using PromptingTools

# Load prompt templates
system_template = load_prompt("prompts/system.txt")
user_template = load_prompt("prompts/task.txt")

# Format and create messages
system_msg = system_template(; role="Julia expert") |> SystemMessage
user_msg = user_template(; task="explain macros") |> UserMessage

# Call the LLM with a vector of messages
response = aigenerate([system_msg, user_msg])

Or as a shorter alternative:

response = aigenerate([
    load_prompt("prompts/system.txt")(; role="Julia expert") |> SystemMessage,
    load_prompt("prompts/task.txt")(; task="explain macros") |> UserMessage])

Example prompt files:

prompts/system.txt:

---
title = "System Prompt"
version = "1.0"
---
You are a {role}. Be concise and helpful.

prompts/task.txt:

---
title = "Task Prompt"
version = "1.0"
---
Please help me with the following task: {task}