Skip to content

CLI Arguments

Command line arguments are used to configure the behavior of the reporter. You can also use them to provide additional information to the reporter.

sh
# Portal
--api-key <testbeats-api-key>
--project <project-name> #optional
--run <run-name> #optional

# Targets
--slack <slack-incoming-webhook-url>
--teams <teams-incoming-webhook-url>
--chat <chat-incoming-webhook-url>

# Extensions
-ci-info <show_ci_info>
-chart-test-summary <show_chart_test_summary_format>

# Results
--junit <path-to-junit-report>
--cucumber <path-to-cucumber-report>
--mocha <path-to-mocha-report>
--testng <path-to-testng-report>
--xunit <path-to-xunit-report>
--nunit <path-to-nunit-report>
--msteams <path-to-msteams-report>

Examples

Basic

sh
npx testbeats@latest publish --slack '<slack-incoming-webhook-url>' -junit '<path-to-junit-report>'

Basic with Portal

sh
npx testbeats@latest publish --api-key '<testbeats-api-key>' --slack '<slack-incoming-webhook-url>' -junit '<path-to-junit-report>'

Multiple Targets

sh
npx testbeats@latest publish --slack '<slack-incoming-webhook-url>' -teams '<teams-incoming-webhook-url>' -junit '<path-to-junit-report>'

Extensions

sh
npx testbeats@latest publish --slack '<slack-incoming-webhook-url>' -ci-info --junit '<path-to-junit-report>'

Released under the MIT License.