Skip to content

docs(reference): fix dir_list command syntax in endpoint commands#306

Merged
pllesperance-lc merged 1 commit into
masterfrom
docs/fix-dir-list-syntax
Jul 15, 2026
Merged

docs(reference): fix dir_list command syntax in endpoint commands#306
pllesperance-lc merged 1 commit into
masterfrom
docs/fix-dir-list-syntax

Conversation

@pllesperance-lc

Copy link
Copy Markdown
Contributor

Summary

The dir_list section in docs/8-reference/endpoint-commands.md documented named flags (--dir_path, --file_pattern) that the command parser does not accept — copying the usage example results in a parse error.

The actual syntax is:

dir_list ROOTDIR FILEEXP [-d|--depth DEPTH]
  • rootdir (positional): root directory where to begin the listing from
  • fileexp (positional): file name expression supporting basic wildcards like * and ?
  • -d, --depth (optional): maximum depth of the listing, defaults to a single level

Changes

  • Replaced the invented flags with the actual positional parameters and --depth flag
  • Updated the usage example to the current CLI form, verified against the stable limacharlie 5.5.1 release on PyPI: limacharlie task send --sid <SID> --task 'dir_list "C:\\Windows\\System32" "*.exe" --depth 1'

Note: several other command sections in this file have the same invented-flag issue (e.g. file_get, file_hash, dns_resolve, file_mov). This PR only fixes dir_list; a broader sweep can follow separately.

🤖 Generated with Claude Code

The dir_list section documented named flags (--dir_path, --file_pattern)
that the command parser does not accept. The command takes two positional
arguments (root directory, then a file name expression) plus an optional
-d/--depth flag. Update the parameters and usage example accordingly, and
switch the example to the current CLI form (limacharlie task send).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@pllesperance-lc pllesperance-lc merged commit dae3933 into master Jul 15, 2026
7 checks passed
@pllesperance-lc pllesperance-lc deleted the docs/fix-dir-list-syntax branch July 15, 2026 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant