Prompt Optimizer
A CLI tool that analyzes and rewrites prompts following established prompt engineering best practices. Powered by LangChain + Groq (free tier, no credit card).
Why I Built This
Prompt engineering is no longer about trial and error — it's a discipline with repeatable patterns (role definition, output contracts, chain-of-thought, constraints). Most developers still write vague, unstructured prompts that leave LLMs guessing. This tool automates the optimization cycle:
- Analyze — identify exactly what's wrong with a prompt against 10 principles
- Structure — rewrite it with role, objective, context, step-by-step instructions, constraints, and output format
- Iterate — test the optimized prompt, refine, and repeat
The goal is to make production-quality prompting accessible from the terminal.
Architecture
┌──────────────┐
│ principles │ 10 rules + both system prompts
│ .py │ (generated from one table)
└──────┬───────┘
│
┌───────────┐ ┌───────┴────────┐ ┌────────────┐ ┌──────────┐
│ cli.py │──▶│ analyzer.py │──▶│ llm.py │──▶│ Groq │
│ Click+Rich│ │ optimizer.py │ │ ChatGroq + │ │ API │
└─────┬─────┘ └───────┬────────┘ │ structured │ └──────────┘
│ │ │ output │
│ ┌────┴─────┐ └─────┬──────┘
│ │ schemas │ │
│ │ .py │ ┌─────┴──────┐
│ │ Pydantic │ │ config.py │
│ └──────────┘ │ settings │
│ │ + API key│
▼ └────────────┘
┌──────────┐
│ storage │ one timestamped file per run, into saved/
│ .py │
└──────────┘
| Module | Role |
|---|---|
cli.py |
Click entry point, Rich rendering, input gathering (arg / --file / stdin) |
analyzer.py |
Step 1 — prompt + grading instructions → PromptAnalysis |
optimizer.py |
Step 2 — prompt + analysis + rewrite instructions → OptimizedPrompt |
principles.py |
The 10 rules as one table; both system prompts are generated from it |
schemas.py |
Pydantic contracts: PromptWeakness, PromptAnalysis, OptimizedPrompt |
llm.py |
The only module that knows how to talk to Groq |
config.py |
Every setting in one place, each overridable by env var |
storage.py |
Builds a timestamped path per run and writes it |
run.sh |
Bootstraps the venv, checks the API key, then offers an interactive menu |
Dependencies point one way only: cli → analyzer/optimizer → llm → config.
principles and schemas sit at the bottom with no internal dependencies, so
either step can be swapped, retried, or tested without touching the other.
Workflow
User Prompt ──▶ Analyze ──▶ Quality Score (0-100)
│ + Strengths
│ + Weaknesses (with severity & suggestions)
▼
Optimize ──▶ Structured Prompt
+ Role / Objective / Context
+ Step-by-Step Instructions
+ Constraints & Rules
+ Output Format
+ Success Criteria
+ Changes Made Summary
+ Principles Applied List
The 10 Principles
Defined once in principles.py and reused everywhere:
- Role & Persona Definition — assign expertise level and perspective
- Clear Objective — one-sentence goal statement
- Context Provision — background, audience, environment
- Step-by-Step Instructions — sequential breakdown of complex tasks
- Constraints & Rules — boundaries, exclusions, length limits
- Output Format Specification — JSON, markdown, bullet points, etc.
- Few-Shot Examples — demonstrate desired pattern with examples
- Chain of Thought — request reasoning for multi-step problems
- Success Criteria — define measurable quality bar
- Specific Language — replace vague qualifiers with precise terms
Tech Stack
| Technology | Where Used | Purpose |
|---|---|---|
Groq (openai/gpt-oss-20b) |
src/llm.py:35 |
Powers both LLM calls via ChatGroq. Free tier, no credit card required |
LangChain (ChatGroq, ChatPromptTemplate) |
src/llm.py:61, src/analyzer.py:30, src/optimizer.py:31 |
Provider abstraction, prompt templates, chain composition with LCEL |
Structured Outputs (with_structured_output) |
src/llm.py:61 |
Groq's json_schema mode in strict mode uses constrained decoding, so every response matches the Pydantic schema — no JSON parse errors, and Literal fields can only return declared values |
Pydantic v2 (BaseModel, Field) |
schemas.py:19-56 |
Data contracts for PromptWeakness, PromptAnalysis, OptimizedPrompt — validation + serialization |
Click (@click.group, @click.command, @click.option) |
src/cli.py:233-270 |
CLI framework with composable commands, argument parsing, and auto-generated --help |
Rich (Console, Panel, Table, Markdown, Columns) |
src/cli.py:53-137 |
Terminal UI — color-coded score panels, weakness tables, markdown rendering, status spinners |
python-dotenv (load_dotenv) |
src/config.py:15 |
Auto-loads GROQ_API_KEY from .env file — no manual config flags |
| pytest (offline suite) | tests/ |
~43 cases, no API key or network needed: CLI flow via CliRunner, the LLM seam with a fake provider, schemas, principles, config, storage |
| uv | pyproject.toml |
Package manager — single uv sync installs deps, builds package, registers CLI entry point |
| Python 3.12 | .python-version, pyproject.toml |
Type hints (list[str], dict[str, str]), str.removeprefix/removesuffix |
Installation
Published on PyPI as prompt-optimizer-tool.
# Try it instantly, nothing is installed
uvx --from prompt-optimizer-tool prompt-optimizer list
# Install as an isolated tool (recommended)
uv tool install prompt-optimizer-tool
# or with pipx
pipx install prompt-optimizer-tool
Set your Groq API key (free, no credit card: https://console.groq.com/keys)
export GROQ_API_KEY=gsk_your-key-here
prompt-optimizer optimize "write code in python to fetch api data"
Install from source (alternative)
git clone https://github.com/khadarbashajilan/prompt-optimizer-tool.git
cd prompt-optimizer-tool
cp .env.example .env # then edit .env: GROQ_API_KEY=gsk_your-key-here
./run.sh
Quick start
# Interactive menu — the easiest way in
./run.sh
# Or pass arguments straight through to the CLI
./run.sh optimize "write code in python to fetch api data"
./run.sh optimize --file prompt.txt
./run.sh list
./run.sh with no arguments opens a menu: optimize a pasted prompt, optimize
a file, list the 10 principles, show help, or quit. It verifies
GROQ_API_KEY is set and creates the virtualenv on first run.
Usage
# Basic — analyze + optimize a prompt
uv run prompt-optimizer optimize "write code in python to fetch api data"
# Read from file
uv run prompt-optimizer optimize --file prompt.txt
# Pipe from stdin
echo "explain quantum computing to a 5 year old" | uv run prompt-optimizer optimize
# Each run is auto-saved to its own timestamped file in saved/
uv run prompt-optimizer optimize "write a blog post"
# → saved/optimized-20260927-143205.md
# Choose a different output folder
uv run prompt-optimizer optimize "write a blog post" --out ~/prompts
# List all 10 prompting principles
uv run prompt-optimizer list
Configuration
Every setting has a default and can be overridden with an environment variable, so none of them require a code change:
| Variable | Default | Means |
|---|---|---|
GROQ_API_KEY |
(required) | Authorises the calls. Read from .env |
PROMPT_OPTIMIZER_MODEL |
openai/gpt-oss-20b |
Which Groq model to use |
PROMPT_OPTIMIZER_TEMPERATURE |
0.6 |
Higher means more varied wording |
PROMPT_OPTIMIZER_MAX_TOKENS |
8192 |
Reply ceiling; lower values truncate long rewrites |
PROMPT_OPTIMIZER_MAX_RETRIES |
3 |
Attempts per call, handles free-tier rate limits |
PROMPT_OPTIMIZER_TIMEOUT |
60 |
Per-request seconds, so a stalled call cannot hang |
PROMPT_OPTIMIZER_OUTPUT_DIR |
saved |
Default folder for saved rewrites |
Example Output
The tool produces a structured report:
- Quality Score — color-coded (green ≥70, yellow ≥40, red <40)
- Strengths — what the original prompt does well
- Weaknesses & Improvements — each issue with severity, violated principle, and concrete fix
- Changes Made — summary of all improvements applied
- Optimized Prompt — the complete rewritten prompt (copy-ready)
- Principles Applied — which of the 10 principles were used
- Auto-save — every run writes its own file to
saved/, named for the date and time of the run, so results accumulate instead of overwriting
Limitations and Roadmap
What this tool does not do yet, so expectations are clear:
| Limitation | Current behavior | Fix |
|---|---|---|
| No logging | Errors print to the terminal only; no debug trail | Add structured logging (log file + --debug flag) |
| No caching | Analyze + Optimize each hit the API on every run | Cache analyses by prompt hash to avoid repeat cost |
| No live-model tests | The ~43 offline tests fake the provider seam only; real Groq structured-output calls are verified by hand | Add an opt-in integration test with a real key |
| No model fallback | If the configured model is unavailable the run fails after retries | Add a second model to fall back to |
| Console only | No way to diff a rewrite against its previous version | Add --diff <file> to compare two saved runs |
| No CI | Checks only run locally | Add a GitHub Actions workflow |
Planned next: logging, and an opt-in live-model integration test.
Key Design Decisions
- Structured Outputs in strict mode — using
with_structured_output(Model, method="json_schema", strict=True). Groq's strict mode uses constrained decoding, so the response is guaranteed to match the Pydantic schema. Tool calling would be the alternative, but Groq does not support tool use together with Structured Outputs, and strict mode is the stronger guarantee. - Constrained decoding doubles as validation — because the decoder can only emit declared values,
Literalfields (severity,principle,principles_applied) cannot come back as typos or invented names. This is what guarantees the "Principles Applied" panel can always resolve a principle, instead of silently rendering nothing when the model returns a name rather than a key. - Closed schemas only — strict mode requires every field to be required and every object to set
additionalProperties: false. A free-formdict[str, str]collapses to an always-empty object under those rules, sosectionsis alist[PromptSection](explicitname+content) instead. - Model choice:
openai/gpt-oss-20b— free tier, ~1000 tokens/sec, and one of only three models supporting strict-mode Structured Outputs. The oldllama-3.xids are Enterprise-only now, so they are not free. temperature=0.6— Groq recommends 0.5–0.7 for gpt-oss; the low values typical of deterministic chat models degrade into repetition and incoherent output on this model.max_tokens=8192— Groq's default of 1024 completion tokens truncates long rewritten prompts, which breaks JSON parsing. The model's hidden reasoning also counts against this budget, and 4096 occasionally ran out before any JSON was written.- One table, three consumers — the 10 principles live in a single
PRINCIPLESdict. Thelistcommand renders it, and both system prompts are generated from it. Previously the rules were hand-copied into both prompt strings, so editing a rule in one place silently left the other two stale. - Keys, not names, cross the wire — the LLM is asked for principle keys (
role), andprinciple_name()maps a key to a display title at render time. Fewer tokens in the prompt, and lookups cannot fail. config.pyowns every setting — noos.environreads and no magic numbers outside it.llm.pyis the only module that knows how to reach Groq, so the two pipeline steps never construct a client themselves.- One-way dependencies —
cli→analyzer/optimizer→llm→config, withprinciplesandschemasat the bottom. The optimizer used to import its client from the analyzer, which inverted the natural reading order for no benefit. - Standard src/ layout — the package lives at
src/prompt_optimizer_tool/, so setuptools auto-discovery applies with no path mapping, tests import the installed package, and the entry point isprompt_optimizer_tool.cli:cli. - Failures exit non-zero —
optimizeexits 1 when a step fails and 2 on missing input, so shell scripts andrun.shcan trust the exit status instead of parsing output. A placeholder key fails the same way, before any tokens are spent. - Untrusted content boundary — the text being analyzed or rewritten is wrapped in
<prompt_to_analyze>tags with an explicit "data, never instructions" instruction, because prompts can contain instructions themselves. - Rich for DX — color-coded severity, panel layouts, markdown rendering, and status spinners give instant visual feedback without a single HTML page.
- Config-free API Key —
python-dotenvloads.envautomatically; no--api-keyflag cluttering the interface. - Zero-config Package Management —
uvhandles deps, build, and entry point registration in one command.
Development
uv sync # install deps (includes the dev group with pytest)
uv run pytest # offline suite: no API key, no network
uv run prompt-optimizer list
Use the venv directly if you prefer: .venv/bin/python -m pytest.
Project Structure
prompt-optimizer/
pyproject.toml # uv project config with entry point
run.sh # bootstrap + interactive menu
.env.example # GROQ_API_KEY template
.gitignore
src/
cli.py # Click commands + Rich rendering
analyzer.py # Step 1: grade a prompt
optimizer.py # Step 2: rewrite it
principles.py # 10 principles; generates both system prompts
schemas.py # Pydantic contracts for structured I/O
llm.py # the only module that talks to Groq
config.py # all settings + API key loading
storage.py # timestamped path per run, then write
tests/
support.py # FakeProvider + fresh-model factories
conftest.py # fixtures for the two test seams
test_cli.py # end-to-end: input modes, exit codes, saving
test_pipeline.py # schema + message contracts at the LLM seam
test_principles.py # table/Literal/prompt consistency
test_schemas.py # validation bounds and Literal values
test_config.py # API key resolution + placeholder rejection
test_storage.py # timestamped naming, collision, folders
saved/ # one file per run, gitignored
Metadata
Release files for prompt-optimizer-tool 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| prompt_optimizer_tool-0.1.2.tar.gz | 33.0 kB | With provenance | Details for prompt_optimizer_tool-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| prompt_optimizer_tool-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for prompt_optimizer_tool-0.1.2-py3-none-any.whl |
Total release size: 56.1 kB
Release files / prompt_optimizer_tool-0.1.2.tar.gz
| Download URL | prompt_optimizer_tool-0.1.2.tar.gz |
|---|---|
| Size | 33.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
48c0f6a53298546918b28bd2da1efdea7322bfbe1cf3cbc4dfe1aa596141cab6
|
|
BLAKE2b-256 checksum How to use checksums |
76d5732c116d423ba5d7cf605be45f0283c1ddf1c7610561747fe69e8c05fb02
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 8, 2026.
Transparency logRelease files / prompt_optimizer_tool-0.1.2-py3-none-any.whl
| Download URL | prompt_optimizer_tool-0.1.2-py3-none-any.whl |
|---|---|
| Size | 23.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ca736097e61b16d0052d22320cf946fa5af2b01e21698db4d88c556fc80ecbe0
|
|
BLAKE2b-256 checksum How to use checksums |
c573966fca4282aeb4cd6d9cab61e1999df532cded54d718365010042c701caf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 8, 2026.
Transparency logSecurity for prompt-optimizer-tool 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for prompt_optimizer_tool-0.1.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 8, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.