farm-runner 1.1.9 → 1.1.11
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 +77 -2
- package/dist/src/bundle.js +1 -1
- package/dist/src/cli.js +128 -0
- package/dist/src/config/node.config.d.ts +88 -0
- package/dist/src/config/node.config.d.ts.map +1 -0
- package/dist/src/config/node.config.js +180 -0
- package/dist/src/config/node.config.js.map +1 -0
- package/dist/src/scripts/prepare-wda-cli.d.ts +3 -0
- package/dist/src/scripts/prepare-wda-cli.d.ts.map +1 -1
- package/dist/src/scripts/prepare-wda-cli.js +11 -5
- package/dist/src/scripts/prepare-wda-cli.js.map +1 -1
- package/package.json +18 -5
package/README.md
CHANGED
|
@@ -17,7 +17,35 @@ Please refer to the main README for:
|
|
|
17
17
|
|
|
18
18
|
## 🚀 Quick Start
|
|
19
19
|
|
|
20
|
-
###
|
|
20
|
+
### Using the Published Package (farm-runner)
|
|
21
|
+
|
|
22
|
+
After installing `farm-runner` globally or locally:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# Install globally
|
|
26
|
+
npm install -g farm-runner
|
|
27
|
+
|
|
28
|
+
# Start the node server
|
|
29
|
+
farm-runner
|
|
30
|
+
# or explicitly
|
|
31
|
+
farm-runner start
|
|
32
|
+
|
|
33
|
+
# With custom config
|
|
34
|
+
farm-runner start --config ./node.config.json
|
|
35
|
+
|
|
36
|
+
# Prepare WebDriverAgent for iOS devices
|
|
37
|
+
farm-runner run prepare-wda
|
|
38
|
+
|
|
39
|
+
# Prepare WDA with options
|
|
40
|
+
farm-runner run prepare-wda -m ~/path/to/profile.mobileprovision
|
|
41
|
+
farm-runner run prepare-wda --platform ios
|
|
42
|
+
|
|
43
|
+
# Show help
|
|
44
|
+
farm-runner --help
|
|
45
|
+
farm-runner run prepare-wda -h
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### From Root Directory (Development)
|
|
21
49
|
|
|
22
50
|
```bash
|
|
23
51
|
# Copy and edit the configuration file
|
|
@@ -28,7 +56,7 @@ cp packages/node/node.config.example.json packages/node/node.config.json
|
|
|
28
56
|
npm run start:node
|
|
29
57
|
```
|
|
30
58
|
|
|
31
|
-
### From Node Package Directory
|
|
59
|
+
### From Node Package Directory (Development)
|
|
32
60
|
|
|
33
61
|
```bash
|
|
34
62
|
# Copy and edit the configuration file
|
|
@@ -37,6 +65,9 @@ cp node.config.example.json node.config.json
|
|
|
37
65
|
# Edit node.config.json with your hub credentials
|
|
38
66
|
# Then start the server
|
|
39
67
|
npm run start
|
|
68
|
+
|
|
69
|
+
# Or use the CLI in development
|
|
70
|
+
npm run cli -- run prepare-wda
|
|
40
71
|
```
|
|
41
72
|
|
|
42
73
|
## 🔧 Minimal Configuration
|
|
@@ -59,6 +90,50 @@ The node will automatically:
|
|
|
59
90
|
- Send heartbeats to the hub
|
|
60
91
|
- Process automation requests
|
|
61
92
|
|
|
93
|
+
## 🖥️ CLI Commands
|
|
94
|
+
|
|
95
|
+
When installed as `farm-runner`, the following commands are available:
|
|
96
|
+
|
|
97
|
+
### Start the Node Server
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
# Default command - starts the node server
|
|
101
|
+
farm-runner
|
|
102
|
+
farm-runner start
|
|
103
|
+
|
|
104
|
+
# With custom configuration file
|
|
105
|
+
farm-runner start --config /path/to/node.config.json
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Prepare WebDriverAgent (iOS)
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
# Interactive mode - prompts for options
|
|
112
|
+
farm-runner run prepare-wda
|
|
113
|
+
|
|
114
|
+
# With mobile provisioning profile
|
|
115
|
+
farm-runner run prepare-wda -m ~/Library/MobileDevice/Provisioning\ Profiles/profile.mobileprovision
|
|
116
|
+
|
|
117
|
+
# With custom WDA project path
|
|
118
|
+
farm-runner run prepare-wda -p ~/WebDriverAgent
|
|
119
|
+
|
|
120
|
+
# Specify platform (ios, tvos, or both)
|
|
121
|
+
farm-runner run prepare-wda --platform ios
|
|
122
|
+
|
|
123
|
+
# Complete example with all options
|
|
124
|
+
farm-runner run prepare-wda -m ./profile.mobileprovision -p ./WebDriverAgent --platform both
|
|
125
|
+
|
|
126
|
+
# Show help
|
|
127
|
+
farm-runner run prepare-wda --help
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
The `prepare-wda` command will:
|
|
131
|
+
|
|
132
|
+
1. Build and sign WebDriverAgent with your provisioning profile
|
|
133
|
+
2. Create a `.ipa` file
|
|
134
|
+
3. Upload it to the hub (if running)
|
|
135
|
+
4. Cache it locally for use by the node
|
|
136
|
+
|
|
62
137
|
## 📦 What This Package Does
|
|
63
138
|
|
|
64
139
|
- **Device Detection**: Automatically discovers connected Android and iOS devices
|