This shows you the differences between two versions of the page.
— |
arc:cmd:gadget [2018-07-16 12:13] (current) jk created |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | # Gadget-Commands | ||
+ | |||
+ | ## Command "gadget.stage.list" | ||
+ | Gets a list of all gadget plugins. Each element of the list contains a dict | ||
+ | |||
+ | #### JSON elements | ||
+ | |||
+ | | Key | Value | Comment | | ||
+ | |-|-|-| | ||
+ | | CMD | "gadget.stage.list" | Command | ||
+ | |||
+ | #### CLI | ||
+ | `gadget.stage.list` or `pdl` | ||
+ | |||
+ | #### Return | ||
+ | List of dicts: | ||
+ | |||
+ | | Key | Type | Comment | | ||
+ | |-|-|-| | ||
+ | | EZPID | str | Unique ID of the plugin module | | ||
+ | | PNAME | str | Name of the plugin module | | ||
+ | | PINFO | str | Info about the plugin | | ||
+ | | PFILE | str | Path and file name of the plugin module | | ||
+ | |||
+ | --- | ||
+ | |||
+ | ## Command "gadget.list" | ||
+ | Gets a list of all gadget instances. Each element of the list contains a dict | ||
+ | |||
+ | #### JSON elements | ||
+ | |||
+ | | Key | Value | Comment | | ||
+ | |-|-|-| | ||
+ | | CMD | "gadget.list" | Command | ||
+ | |||
+ | #### CLI | ||
+ | `gadget.list` or `dl` | ||
+ | |||
+ | #### Return | ||
+ | List of dicts: | ||
+ | |||
+ | | Key | Type | Comment | | ||
+ | |-|-|-| | ||
+ | | idx | int | Index of the instance | | ||
+ | | EZPID | str | Unique ID of the plugin module | | ||
+ | | PNAME | str | Name of the plugin module | | ||
+ | | name | str | Name of the instance (can be changed by user) | | ||
+ | | enable | bool | Is instance enabled | | ||
+ | | info | str | Info about the instance (plugin dependent) | | ||
+ | |||