`list_directory`

List files and directories within a given path.

Parameters

pathstringrequired: Directory to list. Supports ${ctx.key} interpolation.
recursivebooldefault false: When true, descend into subdirectories and include their entries as well.
output_keystringdefault "files": Context key where the resulting array is stored.
max_entriesnumberdefault IRONFLOW_MAX_DIRECTORY_ENTRIES / 10000: Maximum entries returned before failing.
max_depthnumberdefault IRONFLOW_MAX_DIRECTORY_DEPTH / 32: Maximum recursive traversal depth.

Context Output

{output_key} — A JSON array of entry objects. Each object contains:
- name — File or directory name (string).
- type — Either "file" or "directory".
- path — Absolute path to the entry (string).

Example

local flow = Flow.new("list_demo")

flow:step("list", nodes.list_directory({
    path = "/tmp",
    recursive = false,
    output_key = "tmp_files"
}))

flow:step("show", nodes.log({
    message = "Found entries: ${ctx.tmp_files}",
    level = "info"
})):depends_on("list")

return flow

Limits

list_directory accumulates entries into workflow context, so recursive listings are capped by default. Raise max_entries / max_depth for a trusted workflow, or set IRONFLOW_MAX_DIRECTORY_ENTRIES / IRONFLOW_MAX_DIRECTORY_DEPTH for the process.