diff --git a/sphinx-docs/Basic-Usage.md b/sphinx-docs/Basic-Usage.md index 761d058..f1017d0 100644 --- a/sphinx-docs/Basic-Usage.md +++ b/sphinx-docs/Basic-Usage.md @@ -69,6 +69,11 @@ Here is a sample ability: sh: command: | ./wifi.sh scan + alt_command: + './wifi.sh modify' + labels: + - scan + - modify payload: wifi.sh windows: psh: @@ -98,6 +103,8 @@ Each platform block consists of a: * parsers (optional) * requirements (optional) * timeout (optional) +* alt_command (optional) +* labels (optional) **Command**: A command can be 1-line or many and should contain the code you would like the ability to execute. Newlines in the command will be deleted before execution. The command can (optionally) contain variables, which are identified as `#{variable}`. @@ -166,6 +173,10 @@ Abilities can also make use of two CALDERA REST API endpoints, file upload and d **Timeout**: How many seconds to allow the command to run. +**Alt Command**: A second command listed in the same ability. This generates a "toggle" UI element which lets a user switch between 'command' and 'alt_command' within the same ability choice. This is recommended for abilities which accomplish similar goals but have different commands that may be confusing or require a great deal of documentation to explain. + +**Labels**: A list of 2 strings that are the labels for the toggle added by the Alt Command field. + ### Bootstrap and Deadman Abilities Bootstrap Abilities are abilities that run immediately after sending their first beacon in. A bootstrap ability can be added through the GUI by entering the ability id into the 'Bootstrap Abilities' field in the 'Agents' tab. Alternatively, you can edit the `conf/agents.yml` file and include the ability id in the bootstrap ability section of the file (ensure the server is turned off before editing any configuration files).