Skip to main content

Dynamic Panel 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 panel pseudo CLI module currently exposes 5 commands.

Commands At A Glance

ActionDescriptionRequired flags
openOpen a dynamic panel with HTML content--id, --title, --html
updateUpdate dynamic panel HTML content--id, --html
closeClose a dynamic panel--id
sendSend data to a dynamic panel--id, --data
listList active dynamic panelsNone

open

Open a dynamic panel with HTML content

codebolt panel open --id <string> --title <string> --html <string> [--wait | --no-wait] [--timeout <number>]
NameFlagTypeRequiredDescription
id--idstringYesIdentifier of the target resource.
title--titlestringYesTitle of the resource being created or updated.
html--htmlstringYesValue for the html parameter.
wait--waitbooleanNoValue for the wait parameter.
timeout--timeoutnumberNoValue for the timeout parameter.

update

Update dynamic panel HTML content

codebolt panel update --id <string> --html <string>
NameFlagTypeRequiredDescription
id--idstringYesIdentifier of the target resource.
html--htmlstringYesValue for the html parameter.

close

Close a dynamic panel

codebolt panel close --id <string>
NameFlagTypeRequiredDescription
id--idstringYesIdentifier of the target resource.

send

Send data to a dynamic panel

codebolt panel send --id <string> --data <json>
NameFlagTypeRequiredDescription
id--idstringYesIdentifier of the target resource.
data--datajsonYesStructured JSON payload passed through to the underlying SDK method.

list

List active dynamic panels

codebolt panel list

This command takes no parameters.