docs(reference): correct artifact_get/log_get reply event and tasking syntax - #348
Draft
lc-cbot wants to merge 1 commit into
Draft
docs(reference): correct artifact_get/log_get reply event and tasking syntax#348lc-cbot wants to merge 1 commit into
lc-cbot wants to merge 1 commit into
Conversation
… syntax artifact_get and log_get are the same sensor command, but the endpoint command reference documented them as two separate commands with different reply events and different parameters. Corrected against a live org: - Both emit LOG_GET_REP, not FILE_GET_REP. The summary table listed the reply event as "N/A" for both. - log_get accepts --file / --source (exactly one is required), --type, --payload-id, --days-retention and --is-ignore-cert. The documented --predicate parameter is rejected as "unknown argument --predicate". - log_get runs on macOS, Windows and Linux, not Windows and macOS only. - LOG_GET_REP is a receipt carrying ERROR and PAYLOAD_ID rather than the collected file; retrieving the data with `limacharlie artifact download` is a separate step that was not documented. - `limacharlie sensor task` is not a valid CLI command. Replaced all 58 examples with `limacharlie task send --sid <SID> --task '...'` and noted `task request` for callers that want to block for the reply. log_get is documented as the primary entry since it matches the name of the emitted event, with artifact_get cross-referenced to it as an alias. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
lc-cbot
force-pushed
the
docs/fix-artifact-get-log-get-response-event
branch
from
August 18, 2026 18:35
2b72c79 to
6aeb2e1
Compare
lc-cbot
marked this pull request as draft
August 18, 2026 18:36
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
artifact_getandlog_getare the same sensor command, but the endpoint commandreference documented them as two separate commands, with different reply events and
different parameters. Only the
log_getentry had the reply event right.Everything below was corrected against a live organization rather than from the
existing docs.
What was wrong
artifact_getreply eventFILE_GET_REP(section),N/A(table)LOG_GET_REPlog_getreply event in tableN/ALOG_GET_REPlog_getparameterssource,predicate--file/--source(exactly one required),--type,--payload-id,--days-retention,--is-ignore-certlog_get --predicateunknown argument --predicatelog_getplatformsLOG_GET_REPcontentsERRORandPAYLOAD_ID— not the collected filelimacharlie sensor task <SID> <cmd>Changes
artifact_getnow points atlog_getas an alias.log_getholds the full entry,since it is the name that matches the emitted
LOG_GET_REPevent.file_getreturns file bytes inline inFILE_GET_REP, whereaslog_getuploads out-of-band to Artifact Collection and returns only a
PAYLOAD_IDreceipt. Retrieving the artifact via
limacharlie artifact downloadis a separatestep that was not documented anywhere.
LOG_GET_REPevent reference entry with its fields, platforms andcross-links.
limacharlie sensor taskexamples withlimacharlie task send --sid <SID> --task '...', and added a note pointing attask requestfor callers that want to block for the reply andtask reliable-sendfor offline sensors. Windows paths in those examples weredouble-escaped for a double-quoted shell string; single-quoting also stops
$ainthe
yara_scanexamples from being expanded away by the shell.This PR deliberately does not modify the
file_getorFILE_GET_REPentries beyondthe tasking-syntax change — see follow-up 1.
Follow-ups not included here
rejects. The pattern is consistent: a plausible-looking flag where the command
actually takes a positional argument, or a differently-named flag. Confirmed cases
include
file_get --file_path,file_del --file_path,file_hash --file_path,file_info --file_path,file_mov --src_path/--dst_path,dns_resolve --hostname,exfil_add,exfil_del --id,fim_add/fim_del --file_path,mem_read,mem_find_handle --needle,mem_find_string --strings,epp_scan --file_path,run --command, andyara_scan --rule. Worth a dedicated pass, since each needsverifying individually.
log_get --sourceis not verified. The flag is confirmedto exist and to be mutually exclusive with
--file, so it is documented that farand no further — the previous
--source "Security"example was left out ratherthan carried over unverified.