Skip to main content

Auto Testing Pseudo CLI

Generated from packages/codeboltjs/src/tools/pseudo-cli/commands.ts. Edit the registry or rerun node scripts/generate-pseudo-cli-docs.js instead of updating this file by hand.

The testing pseudo CLI module currently exposes 18 commands.

Related SDK docs: Auto Testing

Commands At A Glance​

ActionDescriptionRequired flags
create-suiteCreate test suite--params
get-suiteGet test suite--params
list-suitesList test suitesNone
update-suiteUpdate test suite--params
delete-suiteDelete test suite--params
add-caseAdd case to suite--params
remove-caseRemove case from suite--params
create-caseCreate test case--params
get-caseGet test case--params
list-casesList test casesNone
update-caseUpdate test case--params
delete-caseDelete test case--params
create-runCreate test run--params
get-runGet test run--params
list-runsList test runsNone
update-run-statusUpdate test run status--params
update-run-caseUpdate run case status--params
update-run-stepUpdate run step status--params

create-suite​

Create test suite

codebolt testing create-suite --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

get-suite​

Get test suite

codebolt testing get-suite --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

list-suites​

List test suites

codebolt testing list-suites [--params <json>]
NameFlagTypeRequiredDescription
params--paramsjsonNoStructured JSON payload passed through to the underlying SDK method.

update-suite​

Update test suite

codebolt testing update-suite --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

delete-suite​

Delete test suite

codebolt testing delete-suite --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

add-case​

Add case to suite

codebolt testing add-case --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

remove-case​

Remove case from suite

codebolt testing remove-case --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

create-case​

Create test case

codebolt testing create-case --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

get-case​

Get test case

codebolt testing get-case --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

list-cases​

List test cases

codebolt testing list-cases [--params <json>]
NameFlagTypeRequiredDescription
params--paramsjsonNoStructured JSON payload passed through to the underlying SDK method.

update-case​

Update test case

codebolt testing update-case --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

delete-case​

Delete test case

codebolt testing delete-case --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

create-run​

Create test run

codebolt testing create-run --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

get-run​

Get test run

codebolt testing get-run --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

list-runs​

List test runs

codebolt testing list-runs [--params <json>]
NameFlagTypeRequiredDescription
params--paramsjsonNoStructured JSON payload passed through to the underlying SDK method.

update-run-status​

Update test run status

codebolt testing update-run-status --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

update-run-case​

Update run case status

codebolt testing update-run-case --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

update-run-step​

Update run step status

codebolt testing update-run-step --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.