⚡ JMeter Copilot

A Copilot-powered Apache JMeter assistant for Visual Studio Code. Run JMeter test plans, inspect live and past results, review request/response details, and let Copilot fix and verify your JMX scripts — all from the Chat view, the sidebar, or the command palette.

🎬 Demo

JMeter Copilot demo

See JMeter Copilot in action: run a plan, stream live results, and fix failures with Copilot.

📺 Full demo video: demo_original.mp4 (GitHub)

✨ What it does

Run JMeter test plans — from the sidebar (Test Plans view), the explorer context menu, the command palette, or Copilot Chat (@JMeter /run).
Auto-detect JMeter — finds jmeter/jmeter.bat via settings, JMETER_HOME, PATH, and common install locations.
Live results — a Results panel streams sample counts into the editor while JMeter runs.
Detailed inspection — for each sample: URL, method, status, elapsed/latency, request & response headers, request body, response body, and assertion results.
Recent Runs history — every execution is recorded with the plan name, timestamp, and pass/fail summary; click any entry to reopen its results.
Copilot tools — list_jmeter_tests, run_jmeter_test, get_jmeter_failures, get_jmeter_sample_detail are registered so Copilot can act on your behalf.
Stop & Clear — interrupt a running test, or clear the results and history.

📦 Installation

Option A — Install from the VS Code Marketplace (recommended)

Open the Extensions view (Ctrl+Shift+X).
Search for "JMeter Copilot".
Click Install, then reload the window (Ctrl+Shift+P → Developer: Reload Window).

Or install from the command line:

code --install-extension anshupareek.jmeter-vscode-copilot

Option B — Install from a VSIX file

Download jmeter-vscode-copilot-<version>.vsix.
In the Extensions view, click ⋮ → Install from VSIX….
Select the .vsix file, then reload the window.

Option C — Build from source

git clone https://github.com/anshuparik/jmeter-copilot.git
cd jmeter-copilot
npm install
npm run vsix            # produces jmeter-vscode-copilot-<version>.vsix
code --install-extension jmeter-vscode-copilot-<version>.vsix

After installing, reload the window (Ctrl+Shift+P → Developer: Reload Window).

🚀 Getting Started

Make sure JMeter is installed (or configure it in settings).
Open a workspace that contains your .jmx test plans (or open a .jmx file).
In the Activity Bar, click the ⚡ JMeter icon (sidebar).
Under Test Plans, click the ▶ play icon next to a plan — or right-click a .jmx file in the Explorer and choose JMeter: Run Test.
The Results panel opens in a side editor and streams results live.

If JMeter isn't found automatically, set jmeter.jmeterHome or jmeter.executablePath in Settings (see below), then reload.

💬 Using Copilot Chat

Open Copilot Chat and use the @JMeter participant:

@JMeter /run PerformanceTestPlanMemoryThread.jmx

Command	Description
`/run [plan.jmx]`	Run a JMeter test plan (optionally by name)
`/failures`	Show detailed list of failing samples from the latest run
`/fix`	Analyze the latest run's failures and suggest a fix plan

Copilot tools

Registered via vscode.lm.registerTool, so Copilot can call them automatically:

Tool	Input	Returns
`list_jmeter_tests`	—	All `.jmx` files discovered in the workspace
`run_jmeter_test`	`planPath`	Run summary (total / passed / failed) + run id
`get_jmeter_failures`	`runId?`	Detailed failures (assertions, URLs, response snippets)
`get_jmeter_sample_detail`	`label`, `runId?`	Full JSON detail for a sample

⚙️ Settings

Setting	Default	Description
`jmeter.executablePath`	`""`	Absolute path to the JMeter executable
`jmeter.jmeterHome`	`""`	JMeter home directory (auto-detected if empty)
`jmeter.javaPath`	`""`	Java executable path
`jmeter.maxResponseBytes`	`100000`	Maximum response bytes kept per sample
`jmeter.captureResponseData`	`true`	Capture response/request headers, bodies & assertions
`jmeter.resultsDirectory`	`""`	Directory for run artifacts (defaults to `<workspace>/.jmeter-runs`)
`jmeter.extraProperties`	`{}`	Extra JMeter properties passed to the run

When empty, JMeter is located via (in order): jmeter.executablePath → jmeter.jmeterHome → JMETER_HOME env var → PATH → common install directories.

📚 Examples

Test Plans
└── PerformanceTestPlanMemoryThread.jmx   ▶  (click play)

Results panel shows:

⚡ Running... 4 samples (1 failed)

then after completion:

✅ 3/4 passed · 1 failed

Inspect failures and fix

@JMeter /failures

### 🔍 JMeter Failure Details

Sample: /kitchen-sink/http-methods/put
Status: 200 OK
Assertions:
  - Assertion (Response Assertion code): Test failed: code expected to contain /211/

Then edit the JMX assertion (211 → 200), re-run, and the failures tool reports "No failing samples found." — the fix is verified.

☕ Support the project

If JMeter Copilot saves you time, a small tip would make my day! ❤️

Donate via PayPal (international, cards/PayPal): paypal.me/parik.arvind or send to parik.arvind@gmail.com
UPI (India) — scan the QR or pay to 7738543800@yescred:

Every contribution (no matter how small) motivates me to keep improving the extension. Thank you! 🙏

🔗 Links

Source & issues: github.com/anshuparik/jmeter-copilot
License: MIT — see LICENSE

Built with ❤️ for Apache JMeter users who want performance testing inside VS Code with Copilot at their side.

JMeter Copilot

anshu pareek