Skip to main content
The Promptster CLI is a single binary that configures your editor hooks, routes the AI through the assessment proxy, manages your session, and submits your work when you’re done.

​
System requirements

  • macOS (Intel or Apple Silicon), Linux (x64 or arm64), or Windows via WSL
  • git and a working install of at least one supported AI tool — Claude Code, Codex, or Cursor
  • curl or wget for the install script (Node.js is not required for the script install)
You only need the tool(s) your assessment uses. If it runs on Codex, a missing claude binary won’t block you — the CLI checks only the tool(s) you actually pick.

​
Install

Downloads a pre-built binary to ~/.promptster/bin/promptster:
The script detects your OS and architecture, fetches the matching binary, and adds ~/.promptster/bin to your shell profile (.zshrc or .bashrc).
After install, restart your shell — or run the export PATH=... line the installer prints — so promptster is available in your current session.

​
Verify the install

You should see a version string like 1.5.0. If the command isn’t found, add the bin directory to your PATH:
Add that line to your ~/.zshrc or ~/.bashrc to make it permanent. To confirm everything is wired up correctly — git, your AI tool’s binary, the bin path, and (once you’ve started) your hooks — run:

​
Keeping the CLI up to date

Every time you run promptster start, the CLI checks the server for the minimum and latest supported versions:
  • If a newer version is available, it prints a one-line notice and continues.
  • If your version is too old to be supported, it stops and asks you to update before starting.
The CLI does not upgrade itself silently. When prompted, update by re-running the installer:
Update before you begin a timed assessment, not in the middle of one — a forced update on start is rare but you don’t want to discover it on the clock.

​
Uninstall

promptster done automatically tears down your session hooks, the shell hook, and the AI proxy config when you submit. If you want to remove Promptster’s local state manually:
reset is also the recovery command if a setup ever gets into a bad state — see Troubleshooting.