From 54fe7d06dee2d633e7dc75e93055252e67b45874 Mon Sep 17 00:00:00 2001 From: Kim Carter Date: Tue, 9 Feb 2021 01:38:34 +1300 Subject: [PATCH] Add follow up tweaks for PR #39 This is cumualitve to issue #38. --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6faca08..75d3c06 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,8 @@ You may notice that this example exports the `local` `NODE_ENV` environment vari Using the above mentioned example build project files, assuming your NodeJS build project has the same following files: +
+ [**package.json**](https://github.com/purpleteam-labs/purpleteam-build-test-cli/blob/main/package.json) ```json @@ -187,10 +189,12 @@ The precedence order of where values will be read from is defined by [convict](h # Run -There are several ways you can run the purpleteam CLI. The following list some. Make sure you have configured purpleteam correctly before running: +There are several ways you can run the purpleteam CLI. The following list some. Make sure you have [installed](#install) and [configured](#configure) purpleteam correctly before running: ## Clone the git repository option +For those that chose to [clone](#clone-the-git-repository) the purpleteam CLI: + ### Run the bin/purpleteam file via npm script 1. From the root directory of the purpleteam repository @@ -255,7 +259,9 @@ There are several ways you can run the purpleteam CLI. The following list some. ## NPM install locally option -Providing your package.json and the JavaScript file (index.js in the above example) that is going to run the purpleteam CLI is similar to those configured in the above file examples, you should be able to successfully run the following commands from the root directory of your NodeJS CI/nightly build/build pipeline project. +For those that chose to [install locally via npm](#npm-install-locally): + +Providing your package.json and the JavaScript file (index.js in the [above example](#purpleteam-build-test-cli)) that is going to run the purpleteam CLI is similar to those configured in the above file examples, you should be able to successfully run the following commands from the root directory of your NodeJS CI/nightly build/build pipeline project. ### Run the purpleteam CLI directly @@ -295,7 +301,7 @@ npm run purpleteam test -- --help ### Run your app -Run your NodeJS CI/nightly build/build pipeline project. This will start the NodeJS application we defined above which will `spawn` the `purpleteam test` command. +Run your NodeJS CI/nightly build/build pipeline project. This will start the NodeJS application we [defined above](#purpleteam-build-test-cli) which will [`spawn`](https://github.com/purpleteam-labs/purpleteam-build-test-cli/blob/189d2f42de46b1484d6195a048505da61cfcd201/index.js#L12-L18) the [`purpleteam test`](https://github.com/purpleteam-labs/purpleteam-build-test-cli/blob/189d2f42de46b1484d6195a048505da61cfcd201/index.js#L8) command. You could change the `const purpleteamArgs = ['purpleteam', 'test'];` to use any other purpleteam CLI commands, options, or neither.