From e86944543015d28c41fb64f99cf95190fabfe4fe Mon Sep 17 00:00:00 2001 From: mason5052 Date: Thu, 7 May 2026 12:19:30 -0400 Subject: [PATCH] docs(flows): document flow-scoped Files tab, sources, and current limits Add a How-to subsection that describes the Files tab on a flow page without restating implementation details. The new section covers: - The three file sources surfaced in the UI (uploads, resources, container snapshots) with their exact action labels. - The on-host layout under {dataDir}/flow-{id}-data/ and the corresponding container paths /work/uploads and /work/resources. - Per-file actions (Download, Copy path, Save as resource, Delete) and the Pull action's disabled state when the container is not running. - Automatic injection of uploaded files and attached resources into agent system prompts via the block, so users understand how the assistant sees their files. - Current limits (300 MB / 1000 files / 2 GB / 255-char names) and current limitations, including that flow deletion does not yet archive or remove the flow data directory on disk. This is a documentation-only change and does not introduce or change runtime behavior. Refs #193 Signed-off-by: mason5052 --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index b31b4039..46305ce3 100644 --- a/README.md +++ b/README.md @@ -1037,6 +1037,27 @@ Each flow also includes an **Assistant** view for interactive guidance. This is - Treat this as an explicit control path for the current flow, not as an invisible background queue. If you want to change direction, say so clearly and keep the new instruction tied to the current engagement scope. - This works best for clarifying scope, redirecting priorities after intermediate findings, or answering an automation checkpoint without losing the rest of the flow context. +### 5. Manage flow-scoped files + +Each flow has its own **Files** tab in the flow page. Files are scoped to the parent flow: they live in `{dataDir}/flow-{id}-data/` on the host and never leak into other flows. + +The tab exposes three sources of files: + +- **Uploads** (`uploads/`): files you provide from the web UI. Use the **Upload files** action, or drag and drop directly onto the Files tab. While the agent container is running, uploaded files are also pushed into it at `/work/uploads/` so the agent can read them with normal shell tools. +- **Resources** (`resources/`): files attached from your saved user resources library via **Attach resources from library**. Attached resources are copied into the flow and pushed into the running container at `/work/resources/`. +- **Container** (`container/`): snapshots pulled from the running agent container via **Pull file or directory from container**. These are read-only on the flow side and are never sent back to the container. + +Per-file actions in the Files tab include **Download**, **Copy path**, **Save as resource** (promote a flow file into your reusable resources library), and **Delete**. The Pull action is disabled when the container is not running, with the tooltip "Container is not running". + +Uploaded files and attached resources are listed automatically in the agent's system prompts under a `` block, so the assistant and automation agents can reference them by path without you pasting the contents into chat. Container snapshots are visible in the UI only and are not auto-injected back into the prompt. + +Current limits and limitations to be aware of: + +- Maximum upload file size is 300 MB; per upload request up to 1000 files and 2 GB total. File names are capped at 255 characters. +- The container path is fixed at `/work/uploads/` and `/work/resources/`. Files outside of those paths are not part of the flow file model. +- Container snapshots are point-in-time pulls. Editing a snapshot in the UI does not write back into the running container. +- Deleting a flow today removes the flow record and its long-term memory entries, but does not yet archive or remove the flow's `flow-{id}-data/` directory on disk. Operators are still expected to clean up the data directory manually if they want to reclaim the space. + For early testing, start with a narrow target and a single clear objective. This makes the output easier to review and helps you refine your prompts before running larger assessments. ## API Access