Skip to content

Draft:️ fix/swctl

OpSocket requested to merge fix/swctl into develop

This merge request re-implements the switcher-ctrl executable using switcherio as swctl

usage: swctl [-h] [--uri URI] [-s FILEPATH] [-l FILEPATH] [-c KIND [KIND ...]] [-d ID [ID ...]] [-sp ID PROP_NAME PROP_VALUE] [-gp ID PROP_NAME] [-o SRC_ID DST_ID] [-O ID] [-t [ID [BRANCH ...]]] [-u [NICKNAME [BRANCH ...]]] [-r NICKNAME BRANCH] [-y NICKNAME BRANCH]
             [-q QUIDDITY_DESCR] [-p SHMPATH] [--version] [-lk] [-lq] [-k KIND [KIND ...]] [-K] [-Q]

Control a `Switcher` instance via websockets

optional arguments:
  -h, --help            show this help message and exit
  --uri URI             The server URI to connect to
  -s FILEPATH, --save FILEPATH
                        Save history to a given filepath on disk
  -l FILEPATH, --load FILEPATH
                        Load state from a given filepath on disk
  -c KIND [KIND ...], --create-quiddity KIND [KIND ...]
                        Initialize a new quiddity for any given kind
  -d ID [ID ...], --delete-quiddity ID [ID ...]
                        Delete a quiddity instance for any given identifier
  -sp ID PROP_NAME PROP_VALUE, --set-prop ID PROP_NAME PROP_VALUE
                        Set property value for a given quiddity identifier
  -gp ID PROP_NAME, --get-prop ID PROP_NAME
                        Get property value for a given quiddity identifier
  -o SRC_ID DST_ID, --try-connect SRC_ID DST_ID
                        Try to connect two quiddities given their identifiers
  -O ID, --conn-spec ID
                        Print current shmdata connection specification for a given quiddity identifier
  -t [ID [BRANCH ...]], --print-tree [ID [BRANCH ...]]
                        Print information tree given a quiddity nickname and an optional branch path
  -u [NICKNAME [BRANCH ...]], --print-user-data [NICKNAME [BRANCH ...]]
                        Print user data tree given a quiddity nickname and an optional branch path
  -r NICKNAME BRANCH, --prune-user-data NICKNAME BRANCH
                        Prune user data tree given a quiddity nickname and a branch path
  -y NICKNAME BRANCH, --tag-as-array-user-data NICKNAME BRANCH
                        Tag branch as array in the user data tree
  -q QUIDDITY_DESCR, --quiddity-descr QUIDDITY_DESCR
                        Print description for a given quiddity
  -p SHMPATH, --shmpath SHMPATH
                        Get shmpath of a writer given its label
  --version             Print version of the connected Switcher instance
  -lk, --list-kinds     List available quiddity kinds
  -lq, --list-quiddities
                        List current quiddity instances
  -k KIND [KIND ...], --kind-doc KIND [KIND ...]
                        Print documentation for any given kind
  -K, --kinds-doc       Print available kinds documentation
  -Q, --quiddities-descr
                        Print initialized quiddity descriptions
Edited by OpSocket

Merge request reports