@tuongaz/seeflow 0.1.14 → 0.1.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -51,6 +51,33 @@ curl -fsSL https://raw.githubusercontent.com/tuongaz/seeflow/main/install.sh | b
51
51
 
52
52
  The plugin scans your routes and database connections, generates `seeflow.json`, wires up demo scripts, and opens the canvas at localhost:4321.
53
53
 
54
+ ## Run with Docker
55
+
56
+ Try SeeFlow without installing Bun or Node:
57
+
58
+ ```bash
59
+ docker run --rm -it -p 4321:4321 -v $(pwd):/workspace tuongaz/seeflow
60
+ # then open http://localhost:4321
61
+ ```
62
+
63
+ The studio scans `/workspace/.seeflow/seeflow.json` on start and auto-registers that flow if present.
64
+
65
+ Runtime env vars:
66
+
67
+ - `SEEFLOW_PORT` — port the studio listens on (default `4321`)
68
+ - `SEEFLOW_FLOW` — flow file path relative to the workspace (default `.seeflow/seeflow.json`)
69
+ - `SEEFLOW_WORKSPACE` — workspace mount point inside the container (default `/workspace`)
70
+
71
+ Bake demos into a derived image so the container ships with your flow:
72
+
73
+ ```dockerfile
74
+ FROM tuongaz/seeflow
75
+ COPY ./my-demos /workspace
76
+ # docker build -t my-flow . && docker run --rm -it -p 4321:4321 my-flow
77
+ ```
78
+
79
+ Published image tags: `:latest`, `:<version>` (e.g. `:0.1.16`), and `:<major>.<minor>` (e.g. `:0.1`).
80
+
54
81
  ## MCP server
55
82
 
56
83
  SeeFlow ships an MCP server so any MCP-aware editor can list, register, and edit demos directly. The studio must be running first.