@aloud/runner 0.2.0
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 +38 -0
- package/dist/cli.js +20513 -0
- package/package.json +37 -0
- package/src/cli.ts +348 -0
- package/src/config/credentials.ts +146 -0
- package/src/config/policy.ts +49 -0
- package/src/config/running.ts +95 -0
- package/src/evidence/uploading-store.ts +166 -0
- package/src/index.ts +24 -0
- package/src/loop.ts +117 -0
- package/src/model/proxy-adapter.ts +188 -0
- package/src/preflight.ts +96 -0
- package/src/protocol/blob-spool.ts +88 -0
- package/src/protocol/client.ts +170 -0
- package/src/run/event-shipper.ts +132 -0
- package/src/run/execute.ts +344 -0
- package/src/run/guarded-workers.ts +43 -0
- package/src/run/sanitise.ts +93 -0
- package/src/ui/output.ts +185 -0
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# @aloud/runner
|
|
2
|
+
|
|
3
|
+
Runs [Aloud](https://usealoud.com) usability studies in a real browser **on your own machine**.
|
|
4
|
+
|
|
5
|
+
That is the whole point of it. The browsers run here, so a study can open `localhost`, a staging
|
|
6
|
+
site behind your VPN, or anything else Aloud's servers could never reach. The connection is
|
|
7
|
+
outbound only: nothing listens on a port, and the server holds no address for this machine.
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install -g @aloud/runner
|
|
11
|
+
|
|
12
|
+
aloud login # paste the token from usealoud.com/app/settings/runners
|
|
13
|
+
aloud start # waits for studies and runs them here
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
The first `aloud start` downloads Chromium, about 350 MB, once.
|
|
17
|
+
|
|
18
|
+
## Commands
|
|
19
|
+
|
|
20
|
+
| Command | What it does |
|
|
21
|
+
| --- | --- |
|
|
22
|
+
| `aloud login [--token <token>]` | Connect this machine to your workspace |
|
|
23
|
+
| `aloud start [--once] [--quiet]` | Wait for studies and run them here |
|
|
24
|
+
| `aloud status` | What is set up, what is not, and whether it is running |
|
|
25
|
+
| `aloud allow <host>` | Let studies open this host from this machine |
|
|
26
|
+
| `aloud logout` | Forget the token on this machine |
|
|
27
|
+
|
|
28
|
+
## What it will open
|
|
29
|
+
|
|
30
|
+
A machine starts allowed to open `localhost` only. Anything else has to be added here, with
|
|
31
|
+
`aloud allow <host>`, and that list lives on this machine in `~/.aloud/credentials.json`. Nothing
|
|
32
|
+
the server sends can add to it, so a study offered for a host you never allowed is refused rather
|
|
33
|
+
than run.
|
|
34
|
+
|
|
35
|
+
The token is stored in that same file at mode 0600, and `aloud logout` deletes it. Revoking a
|
|
36
|
+
machine from the web app takes effect immediately, including for a study already running.
|
|
37
|
+
|
|
38
|
+
Requires Node 20 or newer. Source: <https://github.com/dfala/user-testing-ai>
|