Skip to content

docs(endpoint-commands): fix reg_list event name and parameter syntax #216

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
ecapuano wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(endpoint-commands): fix reg_list event name and parameter syntax #216

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
13 changes: 8 additions & 5 deletions docs/8-reference/endpoint-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ For commands which emit a report/reply event type from the agent, the correspond
| os\_users | [OS\_USERS\_REP](edr-events.md#os_users_rep) | | ☑️ | | | |
| [os\_version](#os_version) | [OS\_VERSION\_REP](edr-events.md#os_version_rep) | ☑️ | ☑️ | ☑️ | | |
| put | [RECEIPT](edr-events.md#receipt) | ☑️ | ☑️ | ☑️ | | |
| [reg\_list](#reg_list) | [REGISTRY\_LIST\_REP](edr-events.md#registry_list_rep) | | ☑️ | | | |
| [rejoin\_network](#rejoin_network) | [REJOIN\_NETWORK](edr-events.md#rejoin_network) | ☑️ | ☑️ | ☑️ | ☑️ | ☑️ |
| restart | N/A | ☑️ | ☑️ | ☑️ | | |
| [run](#run) | N/A | ☑️ | ☑️ | ☑️ | | |
Expand Down Expand Up @@ -1031,20 +1032,22 @@ limacharlie sensor task <SID> pcap_stop

### reg_list

List Windows registry keys and values.
List Windows registry keys and values at the specified path.

**Platforms:** Windows

**Parameters:**

- `reg_path` (required): Registry path to list (e.g., "HKEY_LOCAL_MACHINE\\SOFTWARE")
- `<path>` (required, positional): Registry path to list. Use short hive prefixes such as `hklm`, `hku`, `hkcu`, `hkcr`, `hkcc`.

**Response Event:** REG_LIST_REP
**Response Event:** REGISTRY_LIST_REP

**Usage Example:**
**Usage Examples:**

```bash
limacharlie sensor task <SID> reg_list --reg_path "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Run"
limacharlie sensor task <SID> reg_list hklm\Software\Policies\Microsoft\Windows\PowerShell\ScriptBlockLogging
limacharlie sensor task <SID> reg_list hklm\Software\Policies\Microsoft\Windows\PowerShell\ModuleLogging
limacharlie sensor task <SID> reg_list hklm\Software\Policies\Microsoft\Windows\PowerShell\Transcription
```

---
Expand Down