From 1357af9a740860e74dd1aeabd5bb9dddc2115ce1 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 5 Nov 2018 14:02:47 -0600 Subject: [PATCH 01/26] Update README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 180934b1..dd34e6dd 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,32 @@ Code Climate accepts test coverage data from virtually any location, including l For installation instructions, check out our docs on [Configuring Test Coverage](https://docs.codeclimate.com/docs/configuring-test-coverage) and [Test Coverage Troubleshooting Tips](https://docs.codeclimate.com/docs/test-coverage-troubleshooting-tips). +Some installations may require the use of [additional subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): + +`before-build` - notifies the test reporter of a pending test report + +`after-build`- combines `format-coverage` and `upload-coverage` + +`sum-coverage`- combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate + +`format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate + +`upload-coverage` - uploads formatted, singular test report to Code Climate API + +`-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE + +`-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. + +`-p PATH` or `--prefix PATH` - The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory. + +`-p NUMBER` or `--parts NUMBER` - Expect NUMBER payloads to sum. If this many arguments are not present, command will error. This ensures you don't accidentally sum incomplete results. + +`-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json. + +`-r ID` or `--id ID` - The reporter identifier to use when reporting coverage information. The appropriate value can be found in your Repository Settings page on codeclimate.com. Defaults to the value in the `CC_TEST_REPORTER_ID` environment variable. The uploader will error if a value is not found. + +`$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. + To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing/). From ae3b434e9c4c012935ccac0addcd59c8e6c953f8 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 5 Nov 2018 14:06:35 -0600 Subject: [PATCH 02/26] Update README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index dd34e6dd..a9deb4e6 100644 --- a/README.md +++ b/README.md @@ -13,29 +13,29 @@ For installation instructions, check out our docs on [Configuring Test Coverage] Some installations may require the use of [additional subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): -`before-build` - notifies the test reporter of a pending test report +- `before-build` - notifies the test reporter of a pending test report -`after-build`- combines `format-coverage` and `upload-coverage` +- `after-build`- combines `format-coverage` and `upload-coverage` -`sum-coverage`- combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate +- `sum-coverage`- combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate -`format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate +- `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate -`upload-coverage` - uploads formatted, singular test report to Code Climate API +- `upload-coverage` - uploads formatted, singular test report to Code Climate API -`-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE +- `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE -`-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. +- `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. -`-p PATH` or `--prefix PATH` - The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory. +- `-p PATH` or `--prefix PATH` - The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory. -`-p NUMBER` or `--parts NUMBER` - Expect NUMBER payloads to sum. If this many arguments are not present, command will error. This ensures you don't accidentally sum incomplete results. +- `-p NUMBER` or `--parts NUMBER` - Expect NUMBER payloads to sum. If this many arguments are not present, command will error. This ensures you don't accidentally sum incomplete results. -`-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json. +- `-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json. -`-r ID` or `--id ID` - The reporter identifier to use when reporting coverage information. The appropriate value can be found in your Repository Settings page on codeclimate.com. Defaults to the value in the `CC_TEST_REPORTER_ID` environment variable. The uploader will error if a value is not found. +- `-r ID` or `--id ID` - The reporter identifier to use when reporting coverage information. The appropriate value can be found in your Repository Settings page on codeclimate.com. Defaults to the value in the `CC_TEST_REPORTER_ID` environment variable. The uploader will error if a value is not found. -`$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. +- `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing/). From 0a6c8a266588dfd3fb3402c218185177b15ab283 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Wed, 7 Nov 2018 13:06:56 -0600 Subject: [PATCH 03/26] Update README.md --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a9deb4e6..9c54bf5a 100644 --- a/README.md +++ b/README.md @@ -13,15 +13,9 @@ For installation instructions, check out our docs on [Configuring Test Coverage] Some installations may require the use of [additional subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): -- `before-build` - notifies the test reporter of a pending test report - -- `after-build`- combines `format-coverage` and `upload-coverage` - -- `sum-coverage`- combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate - -- `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate +- `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. -- `upload-coverage` - uploads formatted, singular test report to Code Climate API +Subcommands for `format-coverage`: - `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE @@ -29,13 +23,22 @@ Some installations may require the use of [additional subcommands](https://docs. - `-p PATH` or `--prefix PATH` - The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory. +- `COVERAGE_FILE` - Path to the coverage file to process. Defaults to searching known paths where coverage files could exist and selecting the first one found. + +Subcommands for `sum-coverage`: + +- `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. + - `-p NUMBER` or `--parts NUMBER` - Expect NUMBER payloads to sum. If this many arguments are not present, command will error. This ensures you don't accidentally sum incomplete results. +Subcommands for `upload-coverage`: + - `-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json. - `-r ID` or `--id ID` - The reporter identifier to use when reporting coverage information. The appropriate value can be found in your Repository Settings page on codeclimate.com. Defaults to the value in the `CC_TEST_REPORTER_ID` environment variable. The uploader will error if a value is not found. -- `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. +- `-e URL` or `--endpoint URL` - The endpoint to upload coverage information to. Defaults to the value in the CC_TEST_REPORTER_COVERAGE_ENDPOINT environment variable, or a hard-coded default (currently "https://codeclimate.com/test_reports"). + To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing/). From bc054f57b19ace9477d4dae824ef747b295b3cb5 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Wed, 7 Nov 2018 13:12:10 -0600 Subject: [PATCH 04/26] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9c54bf5a..f241394f 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,11 @@ Code Climate accepts test coverage data from virtually any location, including l For installation instructions, check out our docs on [Configuring Test Coverage](https://docs.codeclimate.com/docs/configuring-test-coverage) and [Test Coverage Troubleshooting Tips](https://docs.codeclimate.com/docs/test-coverage-troubleshooting-tips). -Some installations may require the use of [additional subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): +Some installations may require the use of [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): - `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. -Subcommands for `format-coverage`: +Flags for `format-coverage`: - `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE @@ -25,13 +25,13 @@ Subcommands for `format-coverage`: - `COVERAGE_FILE` - Path to the coverage file to process. Defaults to searching known paths where coverage files could exist and selecting the first one found. -Subcommands for `sum-coverage`: +Flags for `sum-coverage`: - `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. - `-p NUMBER` or `--parts NUMBER` - Expect NUMBER payloads to sum. If this many arguments are not present, command will error. This ensures you don't accidentally sum incomplete results. -Subcommands for `upload-coverage`: +Flags for `upload-coverage`: - `-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json. From 53bbb1559065e8f5fb93f2642886d02394410b94 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Wed, 7 Nov 2018 14:28:21 -0600 Subject: [PATCH 05/26] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f241394f..0928f6a7 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,8 @@ Code Climate accepts test coverage data from virtually any location, including l For installation instructions, check out our docs on [Configuring Test Coverage](https://docs.codeclimate.com/docs/configuring-test-coverage) and [Test Coverage Troubleshooting Tips](https://docs.codeclimate.com/docs/test-coverage-troubleshooting-tips). -Some installations may require the use of [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): +Some installations may require the use of [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands). The subcommands accept the following flags: -- `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. Flags for `format-coverage`: @@ -39,6 +38,8 @@ Flags for `upload-coverage`: - `-e URL` or `--endpoint URL` - The endpoint to upload coverage information to. Defaults to the value in the CC_TEST_REPORTER_COVERAGE_ENDPOINT environment variable, or a hard-coded default (currently "https://codeclimate.com/test_reports"). +- `--exit-code $EXIT_CODE` - `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. + To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing/). From da60497d8611e7b2424b2cd4e01a2fccd7edb057 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Wed, 7 Nov 2018 14:30:46 -0600 Subject: [PATCH 06/26] Update README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0928f6a7..4244b3e2 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,20 @@ Code Climate accepts test coverage data from virtually any location, including l For installation instructions, check out our docs on [Configuring Test Coverage](https://docs.codeclimate.com/docs/configuring-test-coverage) and [Test Coverage Troubleshooting Tips](https://docs.codeclimate.com/docs/test-coverage-troubleshooting-tips). -Some installations may require the use of [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands). The subcommands accept the following flags: +Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): + +- `before-build` - notifies the test reporter of a pending test report + +- `after-build` - combines format-coverage and upload-coverage + +- `sum-coverage` - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate + +- `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate + +- `upload-coverage` - uploads formatted, singular test report to Code Climate API + + +The subcommands accept the following flags: Flags for `format-coverage`: From c20ae32b7c10ade122c2133547221929a0af039e Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Wed, 7 Nov 2018 14:50:57 -0600 Subject: [PATCH 07/26] Update README.md --- README.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 4244b3e2..d007ecde 100644 --- a/README.md +++ b/README.md @@ -11,39 +11,35 @@ Code Climate accepts test coverage data from virtually any location, including l For installation instructions, check out our docs on [Configuring Test Coverage](https://docs.codeclimate.com/docs/configuring-test-coverage) and [Test Coverage Troubleshooting Tips](https://docs.codeclimate.com/docs/test-coverage-troubleshooting-tips). -Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): +Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): -- `before-build` - notifies the test reporter of a pending test report -- `after-build` - combines format-coverage and upload-coverage -- `sum-coverage` - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate +## `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate -- `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate +- `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE -- `upload-coverage` - uploads formatted, singular test report to Code Climate API +- `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. +- `-p PATH` or `--prefix PATH` - The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory. -The subcommands accept the following flags: +- `COVERAGE_FILE` - Path to the coverage file to process. Defaults to searching known paths where coverage files could exist and selecting the first one found. -Flags for `format-coverage`: -- `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE +## `sum-coverage` - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate - `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. -- `-p PATH` or `--prefix PATH` - The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory. +- `-p NUMBER` or `--parts NUMBER` - Expect NUMBER payloads to sum. If this many arguments are not present, command will error. This ensures you don't accidentally sum incomplete results. + + -- `COVERAGE_FILE` - Path to the coverage file to process. Defaults to searching known paths where coverage files could exist and selecting the first one found. -Flags for `sum-coverage`: -- `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. -- `-p NUMBER` or `--parts NUMBER` - Expect NUMBER payloads to sum. If this many arguments are not present, command will error. This ensures you don't accidentally sum incomplete results. -Flags for `upload-coverage`: +## `upload-coverage` - uploads formatted, singular test report to Code Climate API - `-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json. @@ -54,6 +50,11 @@ Flags for `upload-coverage`: - `--exit-code $EXIT_CODE` - `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. + +## `after-build` - combines `format-coverage` and `upload-coverage` + + + To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing/). From 358d69ec433f3bb644786b70d3d82059f833c5a6 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Wed, 7 Nov 2018 14:51:17 -0600 Subject: [PATCH 08/26] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d007ecde..9bf24ab2 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Some installations may require the use of the following [subcommands](https://do -## `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate +### `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate - `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE From 7476e639785e916782f84ca8edc8324f174548a0 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Wed, 7 Nov 2018 14:52:02 -0600 Subject: [PATCH 09/26] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9bf24ab2..b1c5f61c 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Some installations may require the use of the following [subcommands](https://do -### `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate +#### `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate - `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE @@ -39,7 +39,7 @@ Some installations may require the use of the following [subcommands](https://do -## `upload-coverage` - uploads formatted, singular test report to Code Climate API +#### `upload-coverage` - uploads formatted, singular test report to Code Climate API - `-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json. @@ -51,7 +51,7 @@ Some installations may require the use of the following [subcommands](https://do -## `after-build` - combines `format-coverage` and `upload-coverage` +#### `after-build` - combines `format-coverage` and `upload-coverage` From 1f31e024e023402f326d743174fff065ab351cc7 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Wed, 7 Nov 2018 14:52:23 -0600 Subject: [PATCH 10/26] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b1c5f61c..4ee716e6 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Some installations may require the use of the following [subcommands](https://do -## `sum-coverage` - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate +#### `sum-coverage` - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate - `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. From cd7b1df404a4638cc79a52706d4f31e4a174da0a Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Wed, 7 Nov 2018 15:31:42 -0600 Subject: [PATCH 11/26] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 4ee716e6..33299ee7 100644 --- a/README.md +++ b/README.md @@ -47,12 +47,11 @@ Some installations may require the use of the following [subcommands](https://do - `-e URL` or `--endpoint URL` - The endpoint to upload coverage information to. Defaults to the value in the CC_TEST_REPORTER_COVERAGE_ENDPOINT environment variable, or a hard-coded default (currently "https://codeclimate.com/test_reports"). -- `--exit-code $EXIT_CODE` - `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. - #### `after-build` - combines `format-coverage` and `upload-coverage` +- `--exit-code $EXIT_CODE` - `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing/). From 8fff54a46509b9cfa3001df8a2923946a043fe34 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:18:28 -0600 Subject: [PATCH 12/26] Update README.md --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 33299ee7..2687de41 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ # Code Climate Test Reporter +## Overview + Code Climate's test reporter is a binary that works in coordination with codeclimate.com to report test coverage data. Once you've set up test coverage reporting you can: * view test coverage reports for each file alongside quality metrics like complexity, duplication, and churn, * toggle between viewing code issues and test coverage line-by-line in the same source listings, @@ -11,11 +13,13 @@ Code Climate accepts test coverage data from virtually any location, including l For installation instructions, check out our docs on [Configuring Test Coverage](https://docs.codeclimate.com/docs/configuring-test-coverage) and [Test Coverage Troubleshooting Tips](https://docs.codeclimate.com/docs/test-coverage-troubleshooting-tips). + +## Subcommands Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): -#### `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate +* `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate - `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE @@ -27,7 +31,7 @@ Some installations may require the use of the following [subcommands](https://do -#### `sum-coverage` - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate +* `sum-coverage` - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate - `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. @@ -38,8 +42,7 @@ Some installations may require the use of the following [subcommands](https://do - -#### `upload-coverage` - uploads formatted, singular test report to Code Climate API +* `upload-coverage` - uploads formatted, singular test report to Code Climate API - `-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json. @@ -49,7 +52,7 @@ Some installations may require the use of the following [subcommands](https://do -#### `after-build` - combines `format-coverage` and `upload-coverage` +* `after-build` - combines `format-coverage` and `upload-coverage` - `--exit-code $EXIT_CODE` - `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. From 2d7dcfa19f2b1698d78a6e42b19fb836bed0aaa1 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:19:53 -0600 Subject: [PATCH 13/26] Update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2687de41..8adcc1b7 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,7 @@ For installation instructions, check out our docs on [Configuring Test Coverage] Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): - -* `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate +##### `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate - `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE @@ -31,7 +30,7 @@ Some installations may require the use of the following [subcommands](https://do -* `sum-coverage` - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate +##### `sum-coverage` - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate - `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. @@ -42,7 +41,7 @@ Some installations may require the use of the following [subcommands](https://do -* `upload-coverage` - uploads formatted, singular test report to Code Climate API +##### `upload-coverage` - uploads formatted, singular test report to Code Climate API - `-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json. @@ -52,7 +51,7 @@ Some installations may require the use of the following [subcommands](https://do -* `after-build` - combines `format-coverage` and `upload-coverage` +##### `after-build` - combines `format-coverage` and `upload-coverage` - `--exit-code $EXIT_CODE` - `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. From 06ddc7c34084dc58a967cb12ac28bc6a8ab105cc Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:21:35 -0600 Subject: [PATCH 14/26] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8adcc1b7..e202fb8b 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ For installation instructions, check out our docs on [Configuring Test Coverage] Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): -##### `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate +**`format-coverage`** - formats test report from local test suite into generalized format, readable by Code Climate - `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE @@ -30,7 +30,7 @@ Some installations may require the use of the following [subcommands](https://do -##### `sum-coverage` - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate +**`sum-coverage`** - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate - `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. @@ -41,7 +41,7 @@ Some installations may require the use of the following [subcommands](https://do -##### `upload-coverage` - uploads formatted, singular test report to Code Climate API +**`upload-coverage`** - uploads formatted, singular test report to Code Climate API - `-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json. @@ -51,7 +51,7 @@ Some installations may require the use of the following [subcommands](https://do -##### `after-build` - combines `format-coverage` and `upload-coverage` +**`after-build`** - combines `format-coverage` and `upload-coverage` - `--exit-code $EXIT_CODE` - `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. From a6861050b88d585f3644ddff726d5acc8ad85688 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:25:09 -0600 Subject: [PATCH 15/26] Update README.md --- README.md | 54 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 32 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index e202fb8b..fa1da7ce 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ # Code Climate Test Reporter -## Overview - Code Climate's test reporter is a binary that works in coordination with codeclimate.com to report test coverage data. Once you've set up test coverage reporting you can: * view test coverage reports for each file alongside quality metrics like complexity, duplication, and churn, * toggle between viewing code issues and test coverage line-by-line in the same source listings, @@ -13,47 +11,59 @@ Code Climate accepts test coverage data from virtually any location, including l For installation instructions, check out our docs on [Configuring Test Coverage](https://docs.codeclimate.com/docs/configuring-test-coverage) and [Test Coverage Troubleshooting Tips](https://docs.codeclimate.com/docs/test-coverage-troubleshooting-tips). - -## Subcommands Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): +--- -**`format-coverage`** - formats test report from local test suite into generalized format, readable by Code Climate - -- `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE - -- `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. - -- `-p PATH` or `--prefix PATH` - The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory. - -- `COVERAGE_FILE` - Path to the coverage file to process. Defaults to searching known paths where coverage files could exist and selecting the first one found. +#### `format-coverage` +Formats test report from local test suite into generalized format, readable by Code Climate +- `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* + - Identifies the input type (format) of the COVERAGE_FILE +- `-o PATH` or `--output PATH` - Output to PATH. + - If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. -**`sum-coverage`** - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate +- `-p PATH` or `--prefix PATH` + - The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory. -- `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json. +- `COVERAGE_FILE` + - Path to the coverage file to process. Defaults to searching known paths where coverage files could exist and selecting the first one found. -- `-p NUMBER` or `--parts NUMBER` - Expect NUMBER payloads to sum. If this many arguments are not present, command will error. This ensures you don't accidentally sum incomplete results. +--- +#### `sum-coverage` +Combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate +- `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. + - Defaults to coverage/codeclimate.json. +- `-p NUMBER` or `--parts NUMBER` + - Expect NUMBER payloads to sum. If this many arguments are not present, command will error. This ensures you don't accidentally sum incomplete results. +--- -**`upload-coverage`** - uploads formatted, singular test report to Code Climate API -- `-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json. +#### `upload-coverage` +Uploads formatted, singular test report to Code Climate API -- `-r ID` or `--id ID` - The reporter identifier to use when reporting coverage information. The appropriate value can be found in your Repository Settings page on codeclimate.com. Defaults to the value in the `CC_TEST_REPORTER_ID` environment variable. The uploader will error if a value is not found. +- `-i PATH` or `--input PATH` + - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json. -- `-e URL` or `--endpoint URL` - The endpoint to upload coverage information to. Defaults to the value in the CC_TEST_REPORTER_COVERAGE_ENDPOINT environment variable, or a hard-coded default (currently "https://codeclimate.com/test_reports"). +- `-r ID` or `--id ID` + - The reporter identifier to use when reporting coverage information. The appropriate value can be found in your Repository Settings page on codeclimate.com. Defaults to the value in the `CC_TEST_REPORTER_ID` environment variable. The uploader will error if a value is not found. +- `-e URL` or `--endpoint URL` + - The endpoint to upload coverage information to. Defaults to the value in the CC_TEST_REPORTER_COVERAGE_ENDPOINT environment variable, or a hard-coded default (currently "https://codeclimate.com/test_reports"). +--- -**`after-build`** - combines `format-coverage` and `upload-coverage` +#### `after-build` +Combines `format-coverage` and `upload-coverage` -- `--exit-code $EXIT_CODE` - `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. +- `--exit-code $EXIT_CODE` - `$EXIT_CODE` should be the exit code of your test suite process. + - Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing/). From 9cc05c6c2da51a22c19bbc66f06d79d62eadbb8c Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:25:50 -0600 Subject: [PATCH 16/26] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fa1da7ce..080664d1 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,10 @@ Code Climate accepts test coverage data from virtually any location, including l For installation instructions, check out our docs on [Configuring Test Coverage](https://docs.codeclimate.com/docs/configuring-test-coverage) and [Test Coverage Troubleshooting Tips](https://docs.codeclimate.com/docs/test-coverage-troubleshooting-tips). -Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): - --- +Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): + #### `format-coverage` Formats test report from local test suite into generalized format, readable by Code Climate From 1116aafc2823dc082160033c15c87206d3da1706 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:30:01 -0600 Subject: [PATCH 17/26] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 080664d1..c17c9121 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ Uploads formatted, singular test report to Code Climate API - The reporter identifier to use when reporting coverage information. The appropriate value can be found in your Repository Settings page on codeclimate.com. Defaults to the value in the `CC_TEST_REPORTER_ID` environment variable. The uploader will error if a value is not found. - `-e URL` or `--endpoint URL` - - The endpoint to upload coverage information to. Defaults to the value in the CC_TEST_REPORTER_COVERAGE_ENDPOINT environment variable, or a hard-coded default (currently "https://codeclimate.com/test_reports"). + - The endpoint to upload coverage information to. Defaults to the value in the `CC_TEST_REPORTER_COVERAGE_ENDPOINT` environment variable, or a hard-coded default (currently `https://codeclimate.com/test_reports`). --- From 7f746e22061986af02e08897de03a3f8343c4137 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:31:50 -0600 Subject: [PATCH 18/26] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c17c9121..14827eb9 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ For installation instructions, check out our docs on [Configuring Test Coverage] --- +### Subcommands + Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): #### `format-coverage` From cb5dff0768143223f8c65c5fbe58e8041d72454c Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:32:27 -0600 Subject: [PATCH 19/26] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 14827eb9..528f7f2e 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ Code Climate accepts test coverage data from virtually any location, including l For installation instructions, check out our docs on [Configuring Test Coverage](https://docs.codeclimate.com/docs/configuring-test-coverage) and [Test Coverage Troubleshooting Tips](https://docs.codeclimate.com/docs/test-coverage-troubleshooting-tips). +To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing/). + --- ### Subcommands @@ -68,8 +70,6 @@ Combines `format-coverage` and `upload-coverage` - Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. -To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing/). - ## Copyright From 7540607f2931d885c11ab68e9ec68a34eafbbc26 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:46:34 -0600 Subject: [PATCH 20/26] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 528f7f2e..7ef7184e 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing ### Subcommands -Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands): +Some installations may require the use of the below subcommands (and their supported flags). For example, here's an example of using the `--prefix` flag under the `after-build` subcommand: `cc-test-reporter after-build --prefix /home/rof/src/github.com/user_or_org_name/repo_name` #### `format-coverage` Formats test report from local test suite into generalized format, readable by Code Climate @@ -68,6 +68,9 @@ Combines `format-coverage` and `upload-coverage` - `--exit-code $EXIT_CODE` - `$EXIT_CODE` should be the exit code of your test suite process. - Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests. + +- `-p PATH` or `--prefix PATH` + - The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory. From bf9fa473fe2de4e1169116020a81d3b5e1b2cb88 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:46:57 -0600 Subject: [PATCH 21/26] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7ef7184e..742318f4 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing ### Subcommands -Some installations may require the use of the below subcommands (and their supported flags). For example, here's an example of using the `--prefix` flag under the `after-build` subcommand: `cc-test-reporter after-build --prefix /home/rof/src/github.com/user_or_org_name/repo_name` +Some installations may require the use of the below subcommands (and their supported flags). For example, here's an example of using the `--prefix` flag under the `after-build` subcommand: ```cc-test-reporter after-build --prefix /home/rof/src/github.com/user_or_org_name/repo_name``` #### `format-coverage` Formats test report from local test suite into generalized format, readable by Code Climate From ffe4cf9ed86ebe2fbf0964cebf93a4a4f8a10e8e Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:47:59 -0600 Subject: [PATCH 22/26] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 742318f4..0f82e388 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,11 @@ To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing ### Subcommands -Some installations may require the use of the below subcommands (and their supported flags). For example, here's an example of using the `--prefix` flag under the `after-build` subcommand: ```cc-test-reporter after-build --prefix /home/rof/src/github.com/user_or_org_name/repo_name``` +Some installations may require the use of the below subcommands (and their supported flags). + +For example, here's an example of using the `--prefix` flag under the `after-build` subcommand: + +```cc-test-reporter after-build --prefix /home/rof/src/github.com/user_or_org_name/repo_name``` #### `format-coverage` Formats test report from local test suite into generalized format, readable by Code Climate From 2ad1b4e13e8a4937fec13b5b32252f6f1bc948d5 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:48:30 -0600 Subject: [PATCH 23/26] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 0f82e388..f2081e46 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,8 @@ For example, here's an example of using the `--prefix` flag under the `after-bui ```cc-test-reporter after-build --prefix /home/rof/src/github.com/user_or_org_name/repo_name``` +--- + #### `format-coverage` Formats test report from local test suite into generalized format, readable by Code Climate From e56e670e93223e8ba63333f2f0af64d57a3da6a1 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:54:02 -0600 Subject: [PATCH 24/26] Update README.md --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f2081e46..80e1b840 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,10 @@ Formats test report from local test suite into generalized format, readable by C - `COVERAGE_FILE` - Path to the coverage file to process. Defaults to searching known paths where coverage files could exist and selecting the first one found. - + +- `-d` or `--debug` + - Outputs debug messages during operation. + --- #### `sum-coverage` @@ -66,6 +69,9 @@ Uploads formatted, singular test report to Code Climate API - `-e URL` or `--endpoint URL` - The endpoint to upload coverage information to. Defaults to the value in the `CC_TEST_REPORTER_COVERAGE_ENDPOINT` environment variable, or a hard-coded default (currently `https://codeclimate.com/test_reports`). + +- `-d` or `--debug` + - Outputs debug messages during operation. --- @@ -77,6 +83,9 @@ Combines `format-coverage` and `upload-coverage` - `-p PATH` or `--prefix PATH` - The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory. + +- `-d` or `--debug` + - Outputs debug messages during operation. From dd4eebe07fe5e940f14c7710a2018592bb148f19 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:54:51 -0600 Subject: [PATCH 25/26] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 80e1b840..c9639212 100644 --- a/README.md +++ b/README.md @@ -87,8 +87,7 @@ Combines `format-coverage` and `upload-coverage` - `-d` or `--debug` - Outputs debug messages during operation. - - +--- ## Copyright See the [LICENSE](https://github.com/codeclimate/test-reporter/blob/master/LICENSE). From cc3b79d5e1e79c9ffa79d66f0b224ee73512749a Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 12 Nov 2018 13:55:12 -0600 Subject: [PATCH 26/26] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c9639212..3aea2062 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing --- -### Subcommands +## Subcommands Some installations may require the use of the below subcommands (and their supported flags).