@tuongaz/seeflow 0.1.21 → 0.1.23

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
@@ -18,23 +18,24 @@ The SeeFlow plugin reads your codebase, understands your architecture, and gener
18
18
 
19
19
  ### 1. Start the studio
20
20
 
21
- The fastest path is Docker — no Bun or Node install, and the image boots with a working **Order Pipeline** demo pre-registered so you can hit Play immediately:
22
-
23
21
  ```bash
24
- docker run --rm -it -p 4321:4321 -v $(pwd):/workspace tuongaz/seeflow
22
+ npx tuongaz/seeflow start
25
23
  # then open http://localhost:4321
26
24
  ```
27
25
 
28
- The studio scans `/workspace/.seeflow/seeflow.json` on start and auto-registers that flow if present. Flows you create from the UI, plus the studio's registry, persist under `$(pwd)/.seeflow/` across restarts.
26
+ Requires Bun ≥ 1.3 (or Node with npx). The studio scans `$(pwd)/.seeflow/seeflow.json` on start and auto-registers that flow if present. Flows you create from the UI, plus the studio's registry, persist under `$(pwd)/.seeflow/` across restarts.
29
27
 
30
28
  <details>
31
- <summary>Prefer to run natively?</summary>
29
+ <summary>Prefer Docker? (not recommended)</summary>
30
+
31
+ > ⚠️ **Heads up:** Play and Status scripts run **inside** the container, so generated scripts that talk to services on your host — HTTP calls to `localhost`, host binaries like `psql` / `redis-cli`, your project's CLI — will not work. Interactive nodes are likely to fail. Use the native path above for full functionality.
32
32
 
33
33
  ```bash
34
- npx tuongaz/seeflow start
34
+ docker run --rm -it -p 4321:4321 -v $(pwd):/workspace tuongaz/seeflow
35
35
  ```
36
36
 
37
- Requires Bun 1.3 (or Node with npx).
37
+ The image ships with a pre-registered **Order Pipeline** demo so you can see the canvas immediately, and the studio scans `/workspace/.seeflow/seeflow.json` on start.
38
+
38
39
  </details>
39
40
 
40
41
  ### 2. Install the plugin
@@ -68,6 +69,8 @@ The plugin scans your routes and database connections, generates `seeflow.json`,
68
69
 
69
70
  ## Docker reference
70
71
 
72
+ > ⚠️ Docker is the non-preferred path. Play/Status scripts execute inside the container and cannot reach host services or host binaries, so interactive nodes generated against your local app will not work. Prefer `npx tuongaz/seeflow start` for the full experience.
73
+
71
74
  The image is published on [Docker Hub](https://hub.docker.com/r/tuongaz/seeflow). See Quick Start above for the basic `docker run`.
72
75
 
73
76
  ### Configuration