![\"Mocha](\"https://github.com/kraenhansen/mocha-remote/raw/main/docs/logo.svg?sanitize=true\"){kind=logo}
\n\n \n
\n ☕️🕹 Run Mocha tests anywhere - get reporting in your terminal 🕹☕️\n
\n\n## Why?\n\nI wanted to run a single Mocha test suite across multiple environments (Node.js, Electron and React-Native) with ideally no changes to the test suite.\nI found running the tests inside an Electron or a React-Native app, was difficult - it was hard to control it, start / stop external services and get reporting on which tests pass or fail.\n\nI would appreciate a shout-out on Bluesky [@kraenhansen.dk](https://bsky.app/profile/kraenhansen.dk) or Twitter [@kraenhansen](https://twitter.com/kraenhansen) if you're actually using this or have suggestions on how to improve the library and its interface.\n\n## Installing the client\n\nInstall the client in the package that will be running tests.\nThis will probably be an example app in a particular environment (React Native, Electron, Web app etc.) from which you want to run your tests.\n\n```shell\nnpm install mocha-remote-client --save\n```\n\nCreate an instance of the client and add tests.\n\n```javascript\nimport { Client } from \"mocha-remote-client\";\n\n// Create a client, which will automatically connect to the server on the default port (8090)\nconst client = new Client({\n // Called when the server asks the client to run\n tests: () => {\n // write your tests here or require a package that calls the mocha globals\n describe(\"my thing\", () => {\n it(\"works\", () => {\n // yay!\n });\n });\n },\n});\n```\n\nBy default, the client automatically (re)connects to the server and disconnects once its testing has ended.\n\n## Installing & running the server (via the CLI)\n\nInstall the Mocha Remote CLI into your project.\n\n```shell\nnpm install mocha-remote-cli --save-dev\n```\n\nTo start the server, simply run the Mocha Remote CLI from your terminal\n\n```shell\nnpx mocha-remote\n```\n\nThe CLI takes a couple of runtime parameters, run the CLI with `--help` to get an overview.\n\n```\n> npx mocha-remote --help\n\n __ __ \n ____ ___ ____ _____/ /_ ____ _ ________ ____ ___ ____ / /____ \n / __ `__ \\/ __ \\/ ___/ __ \\/ __ `/ / ___/ _ \\/ __ `__ \\/ __ \\/ __/ _ \\\n / / / / / / /_/ / /__/ / / / /_/ / / / / __/ / / / / / /_/ / /_/ __/\n/_/ /_/ /_/\\____/\\___/_/ /_/\\__,_/ /_/ \\___/_/ /_/ /_/\\____/\\__/\\___/ \n \nOptions:\n -H, --hostname Network hostname to use when\n listening for clients\n [default: \"0.0.0.0\"]\n -P, --port Network port to use when listening\n for clients [default: 8090]\n -I, --id Connections not matching this will\n be closed [default: \"default\"]\n -g, --grep Only run tests matching this string\n or regexp [string]\n -i, --invert Inverts --grep matches\n [boolean] [default: false]\n -w, --watch Keep the server running after a test\n has ended [boolean] [default: false]\n -c, --context Runtime context sent to client when\n starting a run (