chargelink step

Track operator steps and their pass, warn, or fail outcomes.

Reference syntax

usage: chargelink step [-h] {add,pass,warn,fail} ...

positional arguments:
  {add,pass,warn,fail}

options:
  -h, --help            show this help message and exit

Subcommands

Subcommand	Purpose
`add`	Add an operator step to a run log.
`pass`	Mark a step as passed.
`warn`	Mark a step as warning.
`fail`	Mark a step as failed.

add

Add an operator step to a run log.

CLI help

usage: chargelink step add [-h] [--runtime-root RUNTIME_ROOT]
                           run_id step_id title

positional arguments:
  run_id
  step_id
  title

options:
  -h, --help            show this help message and exit
  --runtime-root RUNTIME_ROOT

Production examples

Add a boot step.

chargelink step add 'run_1' 'boot' 'Boot sequence' --runtime-root '.tmp/runtime'

Add a hardware-proof step.

chargelink step add 'run_1' 'bench-proof' 'Attach bench evidence' --runtime-root '.tmp/runtime'

pass

Mark a step as passed.

CLI help

usage: chargelink step pass [-h] [--runtime-root RUNTIME_ROOT]
                            [--comment COMMENT]
                            run_id step_id

positional arguments:
  run_id
  step_id

options:
  -h, --help            show this help message and exit
  --runtime-root RUNTIME_ROOT
  --comment COMMENT

Production examples

Mark a step as pass.

chargelink step pass 'run_1' 'boot' --runtime-root '.tmp/runtime' --comment 'ok'

Mark a second step.

chargelink step pass 'run_1' 'network' --runtime-root '.tmp/runtime' --comment 'ok'

warn

Mark a step as warning.

CLI help

usage: chargelink step warn [-h] [--runtime-root RUNTIME_ROOT]
                            [--comment COMMENT]
                            run_id step_id

positional arguments:
  run_id
  step_id

options:
  -h, --help            show this help message and exit
  --runtime-root RUNTIME_ROOT
  --comment COMMENT

Production examples

Mark a step as warn.

chargelink step warn 'run_1' 'boot' --runtime-root '.tmp/runtime' --comment 'minor issue'

Mark a second step.

chargelink step warn 'run_1' 'network' --runtime-root '.tmp/runtime' --comment 'minor issue'

fail

Mark a step as failed.

CLI help

usage: chargelink step fail [-h] [--runtime-root RUNTIME_ROOT]
                            [--comment COMMENT]
                            run_id step_id

positional arguments:
  run_id
  step_id

options:
  -h, --help            show this help message and exit
  --runtime-root RUNTIME_ROOT
  --comment COMMENT

Production examples

Mark a step as fail.

chargelink step fail 'run_1' 'boot' --runtime-root '.tmp/runtime' --comment 'forced fail'

Mark a second step.

chargelink step fail 'run_1' 'network' --runtime-root '.tmp/runtime' --comment 'forced fail'