Build a JMeter CLI command: non-GUI run, JTL results, HTML dashboard, HEAP, -J properties, and GitHub Actions or Docker snippets.
JMeter CLI Command Builder
Section titled “JMeter CLI Command Builder”Assemble a non-GUI JMeter command you can paste into a terminal, GitHub Actions, or Docker. Paths stay in your browser; nothing is uploaded.
Assembles flags only. Paths stay in your shell; nothing is uploaded. See CI/CD load testing and Best Practices.
What the flags mean
Section titled “What the flags mean”| Flag | Purpose |
|---|---|
-n | Non-GUI (CLI) mode — required for real load |
-t | Test plan (.jmx) |
-l | Results file (.jtl / CSV) |
-e -o | Generate the HTML dashboard into an empty folder |
-f | Overwrite existing results and report directory |
-q | Extra properties file (prefer this over editing jmeter.properties) |
-j | JMeter log file |
-Jname=value | Set a property for this run (__P in the plan) |
-R | Remote worker hosts (start jmeter-server first) |
-X | Exit remote servers when the test ends |
HEAP is an environment variable consumed by JMeter startup scripts, not a jmeter flag. Size it with the Heap Estimator.
Typical workflow
Section titled “Typical workflow”- Size threads and think time with the Thread Calculator.
- Build the CLI command here (add
-e -ofor a dashboard artifact). - Parameterize hosts and threads with
-J/__Pso the same.jmxworks in every environment. - Gate the pipeline on dashboard error rate and percentiles, not only the process exit code.
Related reading
Section titled “Related reading”People Also Ask
How do I run JMeter from the command line?
Use non-GUI mode: jmeter -n -t plan.jmx -l results.jtl. Add -e -o report to generate the HTML dashboard after the run. The report directory should be empty unless you also pass -f to overwrite it.
What do the JMeter -n -t and -l flags mean?
-n starts JMeter in non-GUI mode, -t points at the test plan jmx file, and -l writes sample results to a jtl or CSV file. Real load tests should always use -n instead of the GUI.
How do I generate a JMeter HTML dashboard from the CLI?
Add -e -o report/ to the same jmeter -n -t ... -l results.jtl command. JMeter writes the dashboard into that folder when the test finishes. Use -f if you need to overwrite an existing report directory.
How do I set JMeter heap on the command line?
Set the HEAP environment variable for that process, for example HEAP="-Xms512m -Xmx2048m" jmeter -n -t plan.jmx -l results.jtl. HEAP is consumed by JMeter startup scripts, not as a jmeter flag.
How do I pass properties with -J in JMeter?
Use -Jname=value on the command line and read it in the plan with the __P function, for example -Jhost=staging.example.com and ${__P(host,localhost)}. Prefer -J or -q over editing jmeter.properties.
Was this page helpful?
Thanks for the feedback!Tell us what's missing on GitHub