PhloemDocs
Markdown
CLI reference

#phloem source

The active project's inputs, one at a time (`apply` sets them all from a document)

phloem source [OPTIONS] <COMMAND>

#phloem source list

The active project's inputs and their state

phloem source list [OPTIONS]

#phloem source set

Create or update the input called NAME (matched by name, like `apply`)

phloem source set [OPTIONS] --driver <DRIVER> <NAME>
Arguments
<NAME>—
Options
--driver <DRIVER>The connector that reads it
--params <JSON>The connector's parameters, a JSON object [default: {}]
--disabledStore it switched off
--no-shipKeep its data on this device (not sent to the cloud)

#phloem source remove

Remove an input (refused while something depends on it, unless --force)

phloem source remove [OPTIONS] <NAME>
Arguments
<NAME>—
Options
--force—

#phloem source verify

Open an input and say what the device found

phloem source verify [OPTIONS] <NAME>
Arguments
<NAME>—

#phloem source rename-prefix

Set the prefix every channel of an input is named under, as a RENAME that carries its calibration, names, tiles, pipelines and setups (empty clears it; history stays under the old name)

phloem source rename-prefix [OPTIONS] <NAME> <PREFIX>
Arguments
<NAME>—
<PREFIX>—
Options
--dry-runSay what would move, change nothing
--waitWait until Phloem is back after the restart (up to --timeout)
--timeout <TIMEOUT>[default: 60s]

Updated