CLI reference
#phloem trellis
phloem trellis [OPTIONS] <COMMAND>#phloem trellis deploy
Arm the stand with a document file (`-` for stdin), or a library document with --document
phloem trellis deploy [OPTIONS] [FILE]Arguments
[FILE] | — |
Options
--document <NAME> | A library document by name, deployed as that document |
--allow-unclaimed | — |
--expected-hash <EXPECTED_HASH> | — |
#phloem trellis run
Start a recipe by library name, or from a file with --file
phloem trellis run [OPTIONS] [DOCUMENT]Arguments
[DOCUMENT] | — |
Options
--file <FILE> | — |
--field <KEY=VALUE> | Run field values, `key=value`, repeatable |
--unit <VALUE> | The unit under test (a serial), as the run card's unit box takes it: a fieldless recipe's one unit, else its `unit=` field's value |
--user <NAME> | Who the run is recorded as started by (default: the device) |
#phloem trellis estop
Emergency stop
phloem trellis estop [OPTIONS]#phloem trellis reset
Reset a stopped stand
phloem trellis reset [OPTIONS]#phloem trellis clear
Unload the armed setup
phloem trellis clear [OPTIONS]#phloem trellis compile
Compile a document (`-` for stdin) against this device, arming nothing
phloem trellis compile [OPTIONS] <FILE>Arguments
<FILE> | — |
#phloem trellis status
What is armed, whether a run is going, and the stand's safety state
phloem trellis status [OPTIONS]#phloem trellis document
The device's document library
phloem trellis document [OPTIONS] <COMMAND>#phloem trellis document list
The documents in this device's library
phloem trellis document list [OPTIONS]#phloem trellis document save
Save a file (`-` for stdin) as the library document NAME: a new version, or a new document
phloem trellis document save [OPTIONS] <NAME> <FILE>Arguments
<NAME> | — |
<FILE> | — |
Options
--origin <LABEL> | Label it as a provisioner's (a demo kit, an installer) — what `document clear` removes |
#phloem trellis document remove
Remove the library document NAME
phloem trellis document remove [OPTIONS] <NAME>Arguments
<NAME> | — |
Options
--or-archive | Archive it instead when runs were recorded against it (a run keeps its procedure) |
#phloem trellis document clear
Remove every document, notebook and function a provisioner labelled LABEL created
phloem trellis document clear [OPTIONS] --origin <LABEL>Options
--origin <LABEL> | — |
#phloem trellis notebook
Notebooks on the device
phloem trellis notebook [OPTIONS] <COMMAND>#phloem trellis notebook save
Install (or replace) the notebook NAME from a file (`-` for stdin)
phloem trellis notebook save [OPTIONS] <NAME> <FILE>Arguments
<NAME> | — |
<FILE> | — |
Options
--origin <LABEL> | — |
Updated