Once your test scenarios are synced to GitHub, you can run everything locally using the Qodex CLI runner — fast, scriptable, and version-controlled.

​
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

  1. Sync Tests to GitHub

    From the Qodex UI, click “Sync to GitHub” to push your test scenarios to your repo.

  2. Clone Your Repo Locally

    Grab your GitHub repo and pull it into your machine where you’ll run the tests.

  3. Install Dependencies

    Use your package manager to install everything (usually Node and Python-based dependencies).

  4. Set Up Your .env File

    Create a local .env file to store your API base URLs, tokens, and environment-specific variables.

  5. Run the Tests

    Trigger the test suite using your CLI. You can run all tests or just a specific suite.

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