Documentation

Two ways to use Promptrix — the promptrix CLI for a whole repository, and the web app for a single prompt.

Getting Started

Install the CLI, then run it inside any repository. It finds every prompt in the project — prompt files, agent context files such as CLAUDE.md and AGENTS.md, and system prompts embedded in your source — and scores each one from 0 to 100.

npm install -g promptrix-cli
promptrix score

The npm package is promptrix-cli; the command it installs is promptrix. Bare npx promptrix resolves to an unrelated package and will not work.

Core commands

These run entirely on your machine — no API key, no network request, nothing leaves your computer.

  • promptrix bootstrapInstall Promptrix agent skills into this repo
  • promptrix scanList every prompt found, grouped by kind
  • promptrix scoreScore prompts 0–100, with a per-check breakdown
  • promptrix statusCounts, average score and trend
  • promptrix undoRestore the most recent backup

These call the Promptrix API and need an account:

  • promptrix improveRewrite the weak prompts, reviewing each diff
  • promptrix "your prompt"Optimize a single prompt. Also reads piped stdin.
No account needed to startScoring is deterministic and runs locally. You only need an account for the commands that rewrite prompts or publish results — and undo restores the previous version of anything improve changes.

Web App

The web app is the fastest way to work on one prompt at a time — no install, no configuration.

Open the optimizer, choose one of your API keys, and paste a prompt. You get the rewritten prompt, a diff against the original, and the rationale for what changed. Optimization methods can be selected explicitly, or left to Promptrix to pick.

Your projects dashboard shows repository scans published from the CLI, so you can see prompt quality across a whole repo and whether the average is going up.

Publishing a scan

Publishing sends a scan to your projects dashboard. It is opt-in — without --publish, nothing leaves your machine.

promptrix scan --publish                 # paths and scores only
promptrix scan --publish --include-text  # also send the prompt bodies
You choose what gets uploadedBy default a snapshot contains file paths, line numbers, scores and the ids of the checks that failed — not the prompts themselves. Add --include-text to also upload the prompt bodies, which unlocks the per-prompt view with its full breakdown and suggestions. Publishing requires analytics to be enabled in your privacy settings.

Need help? Contact support@promptrix.co

Documentation | Promptrix