---
title: "JMeter CLI Command Builder"
description: "Build a JMeter CLI command: non-GUI run, JTL results, HTML dashboard, HEAP, -J properties, and GitHub Actions or Docker snippets."
url: https://docs.jmeter.ai/tools/cli-builder/
lastUpdated: 2026-10-01
source: docs.jmeter.ai
---

# 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.

## 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](/tools/heap-estimator/).

## Typical workflow

1. Size threads and think time with the [Thread Calculator](/tools/thread-calculator/).
2. Build the CLI command here (add `-e -o` for a dashboard artifact).
3. Parameterize hosts and threads with `-J` / `__P` so the same `.jmx` works in every environment.
4. Gate the pipeline on dashboard error rate and percentiles, not only the process exit code.

## Related reading

- [CI/CD Load Testing](/topics/ci-cd-load-testing/)
- [Best Practices](/user-manual/best-practices/)
- [Generating Dashboard](/user-manual/generating-dashboard/)
- [Remote Testing](/user-manual/remote-test/)

## Continue Learning

→

### Next Practical Step

Paste the command into a small CLI run, then attach the HTML report as a CI artifact.

📖

### Related Reference

[Heap estimator](/tools/heap-estimator/) · [Properties cheat sheet](/tools/properties-cheatsheet/)

⚠

### Common Mistakes

Running load in GUI mode, or pointing -o at a non-empty report folder without -f.

🔧

### Troubleshooting

Command not found? Add JMeter bin to PATH, or use the full path to jmeter.bat / jmeter.