{"id":15014280,"url":"https://github.com/schwabyio/xrun","last_synced_at":"2026-05-04T02:32:12.418Z","repository":{"id":65444462,"uuid":"584538113","full_name":"schwabyio/xrun","owner":"schwabyio","description":"Test your APIs with speed, simplicity, and at scale.","archived":false,"fork":false,"pushed_at":"2024-04-23T22:03:21.000Z","size":793,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T06:14:55.146Z","etag":null,"topics":["api","api-automated-testing","api-testing","cli","continuous-integration","functional-testing","postman","rest","restful-testing","test-automation","testing"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/schwabyio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-02T21:19:11.000Z","updated_at":"2024-04-23T22:02:46.000Z","dependencies_parsed_at":"2024-04-23T20:58:41.269Z","dependency_job_id":"e8e10bda-ea50-4b7a-83c9-6cb81ca15833","html_url":"https://github.com/schwabyio/xrun","commit_stats":{"total_commits":30,"total_committers":2,"mean_commits":15.0,"dds":0.09999999999999998,"last_synced_commit":"5150adc35ce2104c06c0a32f18bb3a7391a6d537"},"previous_names":["schwabyio/xrunner"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schwabyio%2Fxrun","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schwabyio%2Fxrun/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schwabyio%2Fxrun/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schwabyio%2Fxrun/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/schwabyio","download_url":"https://codeload.github.com/schwabyio/xrun/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248095997,"owners_count":21046960,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-automated-testing","api-testing","cli","continuous-integration","functional-testing","postman","rest","restful-testing","test-automation","testing"],"created_at":"2024-09-24T19:45:24.788Z","updated_at":"2026-05-04T02:32:12.371Z","avatar_url":"https://github.com/schwabyio.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![xRun Image](./resources/images/xrun-logo-500.png)\n\u003c!-- ![Postman Image](https://assets.getpostman.com/common-share/postman-logo-horizontal-320x132.png) --\u003e\n[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/schwabyio/xrun/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/@schwabyio%252Fxrun)](https://www.npmjs.com/package/@schwabyio/xrun) [![code coverage](https://img.shields.io/badge/Code%20Coverage-71.42%25-green)](https://img.shields.io)\n\n## Table of Contents\n\n- [xRun - CLI Runner For Postman](#xrun---cli-runner-for-postman)\n  - [Overview](#overview)\n  - [Features](#features)\n  - [Installation Steps](#installation-steps)\n  - [Uninstall Steps](#uninstall-steps)\n  - [xRun Project Repo Structure](#xrun-project-repo-structure)\n  - [Example xRun Project Repo](#example-xrun-project-repo)\n  - [Usage](#usage)\n  - [Settings](#settings)\n\n\n\u003cbr\u003e\n\n# xRun - CLI Runner For Postman\n\n## Overview\nxRun is a command line interface (CLI) app that extends [Newman](https://github.com/postmanlabs/newman) to enable your organization to run Postman tests with speed and at scale.\n\n## Features\n* Direct support for [xtest](https://github.com/schwabyio/xtest).\n* Run Postman tests in parallel by setting the `limitConcurrency` configuration.\n* Run tests locally or as part of Continuous Integration (CI) with your automated build server of choice.\n* Generates clean html reports that allow you to quickly filter and zero in on test failures.\n* Generate junit reports (provided by Postman's Newman).\n* Configurable settings.json file with command line override capability.\n* By default, all folders (and tests within) are run. You can exclude folders using an exclusion list.\n* Single out one or more tests to run by specifying a CSV list of test cases and/or directories from the command line.\n\n\u003cbr\u003e\n\n## Installation Steps\n1. Install Node.js (version \u003e= 20) ([recommended to install Node.js using node version manager](https://github.com/nvm-sh/nvm))\n2. Install (and also to update) xRun:\n```shell\nnpm install -g @schwabyio/xrun\n```\n\u003cbr\u003e\n\n## Uninstall Steps\n1. Uninstall xRun\n```shell\nnpm uninstall -g @schwabyio/xrun\n```\n\u003cbr\u003e\n\n## xRun Project Repo Structure\nThe xRun tool requires a Postman project repo to be in the following structure:\n```\n└── \u003cyour-project-repo\u003e/\n    ├── \u003cdirectory1-with-postman-json-files\u003e/\n    ├── \u003cdirectory2-with-postman-json-files\u003e/\n    ...\n    ├── \u003cdirectoryN-with-postman-json-files\u003e/\n    └── xrun/\n        ├── exclude-list.json\n        └── settings.json\n```\nNote: You can only run the `xrun` CLI command from the root directory of `\u003cyour-project-repo\u003e`.\n\n\u003cbr\u003e\n\n## Example xRun Project Repo\nExample repo in structure required by xRun (also runnable - try it out):\n[xrun-example-repo](https://github.com/schwabyio/xrun-example-repo)\n\n\u003cbr\u003e\n\n## Usage\n```shell\n% xrun\n__________________________________________________________________________________________________________________________________\n                                                                                                                                  \n                                                         xRun Ver. 3.3.0\n__________________________________________________________________________________________________________________________________\n\n\n   USAGE: xrun \u003cprogram-command\u003e [--settingsKey settingsValue]\n\n\n              \u003cprogram-command\u003e - Required. Valid program-command values are:\n\n                                          g[et]  - GET a list of all Postman collections from the project.\n\n                                                   NOTE: collections from xrun/exclude-list.json ARE NOT included.\n\n                                          a[ll]  - Run ALL Postman collections from the project.\n\n                                                   NOTE: collections from xrun/exclude-list.json ARE NOT included.\n\n                 \u003ccollectionAndOrDirectoryList\u003e  - Run one or more specific Postman collections from the project by\n                                                   providing a comma seperated list of COLLECTION NAMEs and/or DIRECTORY NAMEs.\n\n                                                   NOTE: collections from xrun/exclude-list.json ARE included.\n\n    --settingsKey settingsValue - Optional. Any number of settings overrides.\n\n__________________________________________________________________________________________________________________________________\n```\n\n\u003cbr\u003e\n\n\n## Settings\nAll available settings (settings.json) are [documented here](./lib/json/settings-schema.json).\n\nSettings Order of Precedence (lowest to highest):\n1. Default value\n2. Local settings.json override\n3. Environment variables override\n4. Command line argument override\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschwabyio%2Fxrun","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fschwabyio%2Fxrun","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschwabyio%2Fxrun/lists"}