Prerequisites:
- Your test scenarios must be synced to GitHub (from the Qodex UI)
- Node.js and Python must be installed locally
- .env file configured for your environment (e.g., .env.local, .env.staging)
Steps
- Sync Tests to GitHub From the Qodex UI, click “Sync to GitHub” to push your test scenarios to your repo.
- Clone Your Repo Locally Grab your GitHub repo and pull it into your machine where you’ll run the tests.
- Install Dependencies Use your package manager to install everything (usually Node and Python-based dependencies).
- Set Up Your .env File Create a local .env file to store your API base URLs, tokens, and environment-specific variables.
- Run the Tests Trigger the test suite using your CLI. You can run all tests or just a specific suite.
- Check Results Results will be shown in the terminal. For more detail, open the logs or result files from the output directory.
Why Use Local CLI Runs:
- Useful for pre-commit validation
- CI/CD debugging or step-by-step test execution
- Full control over logs, variables, and test config
Tip: You can modify test logic in YAML/JS directly before running, and push updated scenarios back to Qodex via GitHub sync.