@flowriki/agent 0.1.0-beta.8 → 0.1.0-beta.9

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
@@ -25,11 +25,20 @@ npx @flowriki/agent@latest doctor # diagnose setup problems
25
25
  npx @flowriki/agent@latest disconnect # forget this computer's credential
26
26
  ```
27
27
 
28
- ## Preparing a project
28
+ ## What you do not need
29
29
 
30
- A project runs from a **local checkout** of its repository. A Flowriki
31
- invitation does not give you access to the git repository — clone it the way
32
- you normally would, then:
30
+ No checkout of Flowriki, and nothing to build. `connect` and `start` are the
31
+ whole installation.
32
+
33
+ For recording, running and debugging from the dashboard you do not need a
34
+ checkout of the project under test either: the service reads the flow from your
35
+ connected repository and sends it with the command, so this machine can be one
36
+ that has never cloned anything.
37
+
38
+ ## Serving a local checkout
39
+
40
+ Optional, and for one case: working against files on this machine rather than
41
+ what is committed.
33
42
 
34
43
  ```
35
44
  npx @flowriki/agent@latest start --project /path/to/checkout
@@ -39,6 +48,10 @@ Repeat `--project` for several. They are remembered, so later runs need no
39
48
  arguments. Each folder identifies itself from the `.flowriki/project.json`
40
49
  committed when its repository was connected — you never pass a project id.
41
50
 
51
+ One dashboard action still needs one: **verifying unsaved steps** from the
52
+ flow editor, which reads the flow from a checkout rather than being sent it. It
53
+ says so plainly when there is none. Recording, running and debugging do not.
54
+
42
55
  ## Where things are kept
43
56
 
44
57
  Credentials and project mappings live outside the npm cache, so upgrading or
@@ -52,7 +65,17 @@ clearing the cache does not lose them:
52
65
 
53
66
  `FLOWRIKI_HOME` overrides it.
54
67
 
55
- ## Self-hosting
68
+ ## Which Flowriki this talks to
69
+
70
+ Production, unless you say otherwise. `--service <url>` (or
71
+ `FLOWRIKI_SERVICE_URL`) points at another one — our own dev and staging
72
+ environments, or a self-hosted install.
73
+
74
+ Credentials are kept **per service**, so a production credential is never sent
75
+ to a development one, and connecting to a second does not disturb the first.
76
+ `doctor` prints which environment answered.
77
+
78
+ This is not the site your tests run against. That is a project setting in the
79
+ dashboard, and changing it never requires connecting this machine again.
56
80
 
57
- `--service <url>` points at another Flowriki. Credentials are kept per service,
58
- so a production credential is never sent to a development one.
81
+ For a terminal where Flowriki should not open the default browser, use `npx @flowriki/agent connect --no-open` and open the printed approval link yourself. Approval is still required.