@flowriki/agent 0.1.0-beta.1
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/LICENSE +6 -0
- package/README.md +58 -0
- package/dist/chunk-ATOHKUGQ.js +7146 -0
- package/dist/cli.js +225 -0
- package/dist/engine.js +19 -0
- package/package.json +52 -0
package/LICENSE
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# @flowriki/agent
|
|
2
|
+
|
|
3
|
+
Runs your [Flowriki](https://flowriki-cloud.onrender.com) UI tests on your own
|
|
4
|
+
computer. The browser under test and your project files stay on this machine.
|
|
5
|
+
|
|
6
|
+
## Requires
|
|
7
|
+
|
|
8
|
+
- **Node.js 22.13 or newer.** Flowriki uses `node:sqlite`, which older versions
|
|
9
|
+
do not have. `node --version` tells you.
|
|
10
|
+
- npm (ships with Node).
|
|
11
|
+
|
|
12
|
+
## Use
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
npx @flowriki/agent@latest connect # approve this computer in your browser
|
|
16
|
+
npx @flowriki/agent@latest start # run it — stays in the foreground
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
`start` keeps running until you stop it. Closing the terminal stops the agent;
|
|
20
|
+
nothing is installed as a background service.
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
npx @flowriki/agent@latest status # connected? what is prepared?
|
|
24
|
+
npx @flowriki/agent@latest doctor # diagnose setup problems
|
|
25
|
+
npx @flowriki/agent@latest disconnect # forget this computer's credential
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Preparing a project
|
|
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:
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
npx @flowriki/agent@latest start --project /path/to/checkout
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Repeat `--project` for several. They are remembered, so later runs need no
|
|
39
|
+
arguments. Each folder identifies itself from the `.flowriki/project.json`
|
|
40
|
+
committed when its repository was connected — you never pass a project id.
|
|
41
|
+
|
|
42
|
+
## Where things are kept
|
|
43
|
+
|
|
44
|
+
Credentials and project mappings live outside the npm cache, so upgrading or
|
|
45
|
+
clearing the cache does not lose them:
|
|
46
|
+
|
|
47
|
+
| | |
|
|
48
|
+
|---|---|
|
|
49
|
+
| Windows | `%APPDATA%\Flowriki` |
|
|
50
|
+
| macOS | `~/Library/Application Support/Flowriki` |
|
|
51
|
+
| Linux | `$XDG_STATE_HOME/flowriki` or `~/.local/state/flowriki` |
|
|
52
|
+
|
|
53
|
+
`FLOWRIKI_HOME` overrides it.
|
|
54
|
+
|
|
55
|
+
## Self-hosting
|
|
56
|
+
|
|
57
|
+
`--service <url>` points at another Flowriki. Credentials are kept per service,
|
|
58
|
+
so a production credential is never sent to a development one.
|