Skip to content

Added alt_command and labels to ability documentation #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
matthewRekos wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added alt_command and labels to ability documentation #112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions sphinx-docs/Basic-Usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ Here is a sample ability:
sh:
command: |
./wifi.sh scan
alt_command:
'./wifi.sh modify'
Comment on lines +72 to +73
Copy link

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example shows alt_command as a single quoted string but the main command is using multi-line syntax with '|'. For consistency, consider using the same YAML syntax format for both commands or explain why they differ.

Suggested change
alt_command:
'./wifi.sh modify'
alt_command: |
./wifi.sh modify

Copilot uses AI. Check for mistakes.
labels:
- scan
- modify
payload: wifi.sh
windows:
psh:
Expand Down Expand Up @@ -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}`.

Expand Down Expand Up @@ -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.
Copy link

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description is unclear about what the labels represent. Consider clarifying that these labels correspond to the command and alt_command options, and explain their order (e.g., first label for command, second for alt_command).

Suggested change
**Labels**: A list of 2 strings that are the labels for the toggle added by the Alt Command field.
**Labels**: A list of 2 strings that are the labels for the toggle added by the Alt Command field. The first label corresponds to the `command` option, and the second label corresponds to the `alt_command` option.

Copilot uses AI. Check for mistakes.

### 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).
Expand Down