Qmpass Test Agent

Run your Qmpass automated tests on your own laptops, servers or virtual machines — faster feedback, safer releases, and full control over your test environments.

Requirements

• Python 3.10 or newer
• Node.js 18 or newer (for Browser tests)
• An agent token from Qmpass: Project settings → Agents → Add agent

Install

pipx install qmpass-test-agent          # or: pipx install "qmpass-test-agent[postgres]" / [mysql] / [salesforce]
qmpass-agent setup                      # one time: installs the browser used by Browser tests
qmpass-agent doctor                     # checks everything below, with a fix for each problem

doctor checks Python, Robot, Node.js and Chromium, your QMPASS_TOKEN / QMPASS_URL, that Qmpass can be reached, and that the token is accepted — without starting a session, so it's safe to run while an agent is already running.

Optional add-ons, only needed if your tests use them:

No pipx yet? brew install pipx (macOS), python3 -m pip install --user pipx (Windows / Linux), then pipx ensurepath.

Run

Copy the command shown with your agent token in Qmpass, or:

export QMPASS_TOKEN=qmp_agent_…
qmpass-agent run

The agent connects to https://api.qmpass.ai (set QMPASS_URL for other deployments), waits for jobs, and logs one line when each run starts and finishes.

Useful options: --worker N (parallel jobs, up to 5), --log-file PATH, --log-format json, --log-level DEBUG. Run qmpass-agent --help for all commands.

Update

pipx upgrade qmpass-test-agent

When a newer version is available, qmpass-agent run says so in one line at startup (and doctor shows it). The agent never updates itself. Set QMPASS_AGENT_UPDATE_CHECK=0 to turn the check off.

Exit codes

License

Proprietary — for use with a Qmpass subscription. See LICENSE.