@gherkle/runner 0.1.0 → 0.1.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.
Files changed (2) hide show
  1. package/README.md +10 -22
  2. package/package.json +2 -10
package/README.md CHANGED
@@ -4,8 +4,6 @@ Test runner agent for Gherkle. Connects to the Gherkle platform over WebSocket,
4
4
 
5
5
  ## Installation
6
6
 
7
- ### Option 1 — npm (recommended)
8
-
9
7
  Global install gives you the `gherkle-runner` CLI:
10
8
 
11
9
  ```bash
@@ -27,32 +25,22 @@ them alongside the runner. AI-generated step definitions import `expect`
27
25
  from `@playwright/test`, and the bundled Cucumber executor drives
28
26
  `playwright-core` for browser automation.
29
27
 
30
- ### Option 2 — Docker
28
+ ### Docker
29
+
30
+ To run the agent in a container, drop the CLI into any Node 22 image:
31
31
 
32
- A prebuilt image with browsers preinstalled is available at the
33
- monorepo's `packages/runner/Dockerfile.browsers`. Build locally:
32
+ ```dockerfile
33
+ FROM mcr.microsoft.com/playwright:v1.58.2-jammy
34
+ RUN npm install -g @gherkle/runner
35
+ ENTRYPOINT ["gherkle-runner", "start"]
36
+ ```
34
37
 
35
38
  ```bash
36
- git clone https://github.com/rvasqz86/gherkle-monorepo.git
37
- cd gherkle-monorepo
38
- docker build -t gherkle-runner -f packages/runner/Dockerfile.browsers .
39
+ docker build -t my-gherkle-runner .
39
40
  docker run --rm \
40
41
  -e GHERKLE_API_URL=https://gherkle-runner.osita.ai \
41
42
  -e GHERKLE_TOKEN=ghr_xxxxx \
42
- gherkle-runner
43
- ```
44
-
45
- ### Option 3 — From source (for development)
46
-
47
- ```bash
48
- git clone https://github.com/rvasqz86/gherkle-monorepo.git
49
- cd gherkle-monorepo
50
- npm install
51
- npm run build --workspace=@gherkle/runner
52
- npx playwright install chromium
53
- node packages/runner/bin/gherkle-runner.js start \
54
- --token ghr_xxxxx \
55
- --url https://gherkle-runner.osita.ai
43
+ my-gherkle-runner
56
44
  ```
57
45
 
58
46
  ## How runs work
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gherkle/runner",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Test runner agent for Gherkle - execute Gherkin feature files",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -62,13 +62,5 @@
62
62
  "dist",
63
63
  "bin"
64
64
  ],
65
- "repository": {
66
- "type": "git",
67
- "url": "git+https://github.com/rvasqz86/gherkle-monorepo.git",
68
- "directory": "packages/runner"
69
- },
70
- "bugs": {
71
- "url": "https://github.com/rvasqz86/gherkle-monorepo/issues"
72
- },
73
- "homepage": "https://github.com/rvasqz86/gherkle-monorepo/tree/main/packages/runner#readme"
65
+ "homepage": "https://gherkle.com"
74
66
  }