Skip to main content

Requirement Plan 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 reqplan pseudo CLI module currently exposes 5 commands.

Related SDK docs: Requirement Plan

Commands At A Glance

ActionDescriptionRequired flags
createCreate requirement plan--file
getGet requirement plan--file
listList requirement plansNone
updateUpdate requirement plan--file, --content
reviewReview requirement plan--file

create

Create requirement plan

codebolt reqplan create --file <string>
NameFlagTypeRequiredDescription
file--filestringYesValue for the file parameter.

get

Get requirement plan

codebolt reqplan get --file <string>
NameFlagTypeRequiredDescription
file--filestringYesValue for the file parameter.

list

List requirement plans

codebolt reqplan list

This command takes no parameters.

update

Update requirement plan

codebolt reqplan update --file <string> --content <string>
NameFlagTypeRequiredDescription
file--filestringYesValue for the file parameter.
content--contentstringYesRaw content string passed to the SDK method.

review

Review requirement plan

codebolt reqplan review --file <string>
NameFlagTypeRequiredDescription
file--filestringYesValue for the file parameter.