🔑 SuperKey — JMeter Plugin

A blazing-fast command palette for Apache JMeter. Search components, run actions, and discover surprises — all from your keyboard.

---

✨ Features at a Glance

Feature	Description
🔍 Component Search	Instantly search and insert any JMeter component
⚡ Action Runner	Execute built-in JMeter actions (Start, Stop, Save, Zoom…)
⌨️ Custom Shortcuts	Define personal search aliases via jmeter.properties
🎨 Animated Border	Google AI-inspired spinning gradient on open
🥚 Easter Eggs	Hidden surprises for secret commands

---

📦 Installation

1. Download or build the JAR (superkey-jmeter-plugin-*.jar)
2. Copy it to your JMeter lib/ext/ directory:

   <JMETER_HOME>/lib/ext/superkey-jmeter-plugin-1.0-SNAPSHOT.jar
   

3. Restart JMeter

---

🚀 Quick Start

Open the SuperKey dialog with:

OS	Default Shortcut
Windows / Linux	Ctrl + K
macOS	Cmd + K

Or click the 🔑 SuperKey button on the JMeter toolbar (placed just before the Run button).

Also accessible via Search → Super Key in the JMeter menu bar.

---

🔍 Component Search

Type any part of a JMeter component name to instantly search across all available components:

• HTTP Request → type http
• JDBC Request → type jdbc
• Thread Group → type thread
• Response Assertion → type assert

Use the number spinner on the right to insert multiple copies at once.

Keyboard navigation:

• ↓ / ↑ — Move between results
• Enter — Insert selected component
• Escape — Close the dialog
• Double-click — Insert component

---

⚡ JMeter Action Runner

SuperKey also lists native JMeter GUI actions. Search for them just like components:

Search Term	Action
start	Start test run
stop	Stop test run
save	Save test plan
zoom in	Zoom in on the tree
zoom out	Zoom out on the tree
validate	Validate test plan
about	Show JMeter about dialog

---

⌨️ Custom Shortcuts / Aliases

Define your own search aliases in jmeter.properties (or user.properties):

# Format: jmeter.superkey.custom=shortcut,component name;shortcut2,component name2
jmeter.superkey.custom=http,http request;jdbc,jdbc request;tg,thread group

How it works:

• Typing http will show results matching both "http" and the mapped alias "http request" — so you never miss natural matches.
• Aliases are case-insensitive.

Custom keyboard shortcut:

jmeter.superkey.custom.shortcut=ctrl+shift+k

---

🪄 Dialog UI Behaviour

• Collapses to a slim search bar when the field is empty
• Expands to show results as you type
• Draggable — click and drag anywhere on the dialog to reposition it
• Once dragged, the dialog stays where you left it (no auto-recentering)

---

🥚 Easter Eggs

Type these exact phrases into the search bar for a surprise:

Command	Surprise
hello	Friendly welcome message
hi	Another greeting
coffee	Animated coffee brewing sequence ☕
matrix	Matrix rain animation (click or wait 5s to close)
42	The Answer to Life, the Universe, and Everything
flip	Animated table flip (╯°□°）╯︵ ┻━┻
jmeter rocks	Fireworks animation 🎆
superkey	Plugin info card
stress	Humorous stress relief tip
↑↑↓↓←→←→ba	Konami Code → Confetti explosion 🎉

Easter eggs are exact-match only — they never appear in normal search results.

---

🔧 Configuration Reference

All configuration goes in <JMETER_HOME>/bin/jmeter.properties or user.properties:

# Custom search aliases (shortcut,component name pairs separated by semicolons)
jmeter.superkey.custom=http,http request;jdbc,jdbc request

# Custom keyboard shortcut to open SuperKey (default: Ctrl+K / Cmd+K)
# Supports: ctrl, shift, alt, meta/cmd and key names
# Example: jmeter.superkey.custom.shortcut=ctrl+shift+s

---

🛠️ Building from Source

Prerequisites: Java 17+, Maven 3.6+

git clone https://github.com/qainsights/superkey.git
cd superkey
mvn clean package

The JAR is built to target/superkey-jmeter-plugin-*.jar.

Deploy to JMeter:

cp target/superkey-jmeter-plugin-*.jar $JMETER_HOME/lib/ext/

---

🤝 Contributing

Pull requests and issues are welcome!
Please test with JMeter 5.6+ on Windows, macOS, and Linux.

---

📄 License

Apache License 2.0 — see LICENSE for details.

---

Built with ❤️ by NaveenKumar Namachivayam for JMeter power users.