PromptDesk Quickstart Guide

PromptDesk OS

PromptDesk is a 100% free and open-source tool that facilitates the creation, organization, integration, and evaluation of prompts, prompt-based applications, agents, and Large Language Models (LLMs).

PromptDesk OS

Requirements

Local Installation

Docker Compose v2 or later
OpenSSL
OpenAI API Key (can siwtch to other models later)

(OPTIONAL) Domain/SSL Installation

A DNS "A record" pointing to your server IP address (optional - if you choose to use a domain name)

Installation

Run the following commands to install PromptDesk OS in your CLI.

To download the interactive setup script:

To run the interactive setup:

Important to note!

Please ensure that port 80 and 443 (optional) is available on your system. If you have a web server running, you may need to stop it before running the setup script.

Open your web browser and navigate to http://localhost, the IP address, or the domain name provided to access PromptDesk OS. Initial setup will require a valid OpenAI API key for installation testing purposes.

More installation options are available in the PromptDesk OS GitHub Repository.

Walkthrough (4 min)

PromptDesk SDK

Python (pip)

To install PromptDesk, use pip:

pip install promptdesk

You can call the prompt you build in the application by using the generate method. You can find the API key and service URL in your PromptDesk settings.

from promptdesk import PromptDesk

# Replace "YOUR_PROMPTDESK_API_KEY" with the actual API key found in your PromptDesk settings.
pd = PromptDesk(
    api_key="YOUR_PROMPTDESK_API_KEY",
    service_url="http://localhost"
)

# ping PromptDesk to check if it's up - should return "pong"
print(pd.ping())

# Generate a story using the "short-story" prompt.
story = pd.generate("short-story", {
    "setting": "dark and stormy night",
    "character": "lonely farmer",
    "plot": "visited by a stranger"
})

print(story)

Javascript (npm)

To install PromptDesk, use npm:

npm install promptdesk

You can call the prompt you build in the application by using the generate method. You can find the API key and service URL in your PromptDesk settings.

import { PromptDesk } from 'promptdesk'; //ES6
//const { PromptDesk } = require('promptdesk'); //CommonJS

// Replace "YOUR_PROMPTDESK_API_KEY" with the actual API key found in your PromptDesk settings.
var pd = new PromptDesk({
    apiKey: "YOUR_PROMPTDESK_API_KEY",
    serviceUrl: "http://localhost"
})

// ping PromptDesk to check if it's up - should return "pong"
console.log(await pd.ping())

// Generate a story using the "short-story" prompt.
const story = await pd.generate("short-story", {
    "setting": "dark and stormy night",
    "character": "lonely farmer",
    "plot": "visited by a stranger"
})

console.log(story)

Important Links

For more information about PromptDesk, please refer to the following resources: