Home

Welcome to the HandyLLM wiki! Click on the pages panel on the right to jump to what you need!

Installation

HandyLLM comes with the Handy Prompt (hprompt) definition and supports, a CLI program and other development tools.

Install from PyPI:

pip3 install handyllm

or, install from the Github repo to get latest updates:

pip3 install git+https://github.com/atomiechen/handyllm.git

VSCode Integration

Install HandyLLM extension from the marketplace. Please check HandyLLM VSCode extension.

Getting Started with hprompt

Create a text file named try.hprompt with the following content (replace <YOUR_OPENAI_API_KEY>):

Caution

This is only a minimal working example, and we do NOT recommend storing your API key in the hprompt file. Save it to a separate credential file instead (see Credentials).

---
model: gpt-4o
temperature: 0.4
api_key: <YOUR_OPENAI_API_KEY>
---

$user$
How to speed up my prompt engineering iteration?

Now run it with the CLI:

handyllm hprompt try.hprompt

The result will be dumped to the stderr, and you will see it in the same hprompt format.

You can also run it programmatically:

from handyllm import hprompt
my_prompt = hprompt.load_from('try.hprompt')
result_prompt = my_prompt.run()
print(result_prompt.dumps())

More controls

You can specify more arguments in the frontmatter, and add variables in the content, like this:

---
# frontmatter data
model: gpt-3.5-turbo
temperature: 0.5
meta:
  credential_path: .env
  var_map_path: substitute.txt
  output_path: out/%Y-%m-%d/result.%H-%M-%S.hprompt
  output_evaled_prompt_path: out/%Y-%m-%d/evaled.%H-%M-%S.hprompt
---

$system$
You are a helpful assistant.

$user$
Your current context: 
%context%

Please follow my instructions:
%instructions%

Variables

Before running, variables like %context% will be evaluated using file content in meta.var_map_path, or the dict meta.var_map (check Variable Substitution).

To replace them in code, pass in the runtime var_map:

from handyllm import hprompt, VM
...
result_prompt = my_prompt.run(var_map=VM(
    context='It is raining outside.',
    instructions='Write a poem.'
))

What's Next

Check Handy Prompt (hprompt) for details.