workshopctl (CLI)¶

SDKs use the workshopctl tool when reporting to the workshop; to invoke a subcommand, add it to your SDK hook.

workshopctl set-health¶

Report the health of the SDK.

Usage

$ workshopctl set-health [--code=<ERROR CODE>] <STATUS> [<MESSAGE>]

Description

This command is essential for the check-health hook that runs after launch or refresh operations in a workshop. The arguments are as follows:

Placeholder	Required	Value
`<STATUS>`	Required	Can be `okay`, `waiting` or `error`.
`<MESSAGE>`	Required with `--code`	Arbitrary string explaining the context of the error code; 7–70 characters.

Examples

Report an error with a code and a message; note only the message is quoted:

$ workshopctl set-health --code=missing-cuda error "CUDA libraries not found"

Flags

--code: Optional, can’t go with okay. Short code of lowercase letters, hyphens and digits; 3–30 characters, starts with a letter.