tapflow 0.8.0-next.4 → 0.8.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 +18 -7
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -93,7 +93,17 @@ npm install -g tapflow
|
|
|
93
93
|
# or: yarn global add tapflow | pnpm add -g tapflow
|
|
94
94
|
```
|
|
95
95
|
|
|
96
|
-
### 2.
|
|
96
|
+
### 2. Set up the environment
|
|
97
|
+
|
|
98
|
+
On the Mac that will run an agent, install the simulator/emulator prerequisites in one step:
|
|
99
|
+
|
|
100
|
+
```sh
|
|
101
|
+
tapflow setup
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Skip this on a relay-only server (Linux). See [Environment Setup](https://www.tapflow.dev/guide/environment-setup) for details.
|
|
105
|
+
|
|
106
|
+
### 3. Start relay + agent
|
|
97
107
|
|
|
98
108
|
```sh
|
|
99
109
|
tapflow start
|
|
@@ -103,25 +113,25 @@ tapflow start
|
|
|
103
113
|
|
|
104
114
|
This starts both the relay and the agent on the same Mac (local mode).
|
|
105
115
|
|
|
106
|
-
###
|
|
116
|
+
### 4. Create the first admin account
|
|
107
117
|
|
|
108
118
|
Open `http://localhost:4000` in your browser. tapflow redirects you to `/setup` to create the admin account.
|
|
109
119
|
|
|
110
120
|
> **Headless server?** Use `tapflow admin init` to create the admin account via CLI instead.
|
|
111
121
|
|
|
112
|
-
###
|
|
122
|
+
### 5. Open the dashboard
|
|
113
123
|
|
|
114
124
|
Navigate to `http://localhost:4000` and sign in with the account you just created.
|
|
115
125
|
|
|
116
|
-
> **Having issues?** Run `tapflow doctor` to
|
|
126
|
+
> **Having issues?** Run `tapflow doctor` to re-check prerequisites at any time.
|
|
117
127
|
|
|
118
128
|
## Requirements
|
|
119
129
|
|
|
120
130
|
| Component | Requirements |
|
|
121
131
|
|-----------|-------------|
|
|
122
132
|
| **Relay server** | Node.js ≥ 20, any OS (Linux/macOS), ~512 MB RAM |
|
|
123
|
-
| **iOS Agent** | macOS, Xcode
|
|
124
|
-
| **Android Agent** | macOS, Android SDK
|
|
133
|
+
| **iOS Agent** | macOS, Xcode + iOS Simulator runtime (or run `tapflow setup ios`), Node.js ≥ 20 |
|
|
134
|
+
| **Android Agent** | macOS, Java + Android SDK with an AVD (or run `tapflow setup android`), Node.js ≥ 20 |
|
|
125
135
|
| **Browser (QA)** | Any modern browser — Chrome, Firefox, Safari, Edge |
|
|
126
136
|
|
|
127
137
|
> Agents run on **macOS only** (they drive the iOS Simulator and Android emulator on a Mac). The relay runs anywhere.
|
|
@@ -207,7 +217,8 @@ tapflow agent start --relay wss://your-relay-url
|
|
|
207
217
|
| `tapflow agent start --relay <url>` | Start agent and connect to a relay |
|
|
208
218
|
| `tapflow init` | Scaffold `tapflow.config.json` |
|
|
209
219
|
| `tapflow admin init` | Create the first admin account (CLI fallback) |
|
|
210
|
-
| `tapflow doctor` | Diagnose
|
|
220
|
+
| `tapflow doctor [platform]` | Diagnose prerequisites (Node, iOS, Android) |
|
|
221
|
+
| `tapflow setup [platform]` | Install & configure the local environment |
|
|
211
222
|
| `tapflow devices` | List available simulators and emulators |
|
|
212
223
|
| `tapflow boot <name\|udid>` | Boot a simulator or emulator |
|
|
213
224
|
| `tapflow status` | Show connected agents, devices, active sessions |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tapflow",
|
|
3
|
-
"version": "0.8.0
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"description": "Self-hosted iOS/Android simulator streaming for the whole team",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ios",
|
|
@@ -47,10 +47,10 @@
|
|
|
47
47
|
"cac": "^6.7.14",
|
|
48
48
|
"ws": "^8.0.0",
|
|
49
49
|
"zod": "^4.4.3",
|
|
50
|
-
"@tapflowio/agent-core": "0.8.0
|
|
51
|
-
"@tapflowio/android-agent": "0.8.0
|
|
52
|
-
"@tapflowio/ios-agent": "0.8.0
|
|
53
|
-
"@tapflowio/relay": "0.8.0
|
|
50
|
+
"@tapflowio/agent-core": "0.8.0",
|
|
51
|
+
"@tapflowio/android-agent": "0.8.0",
|
|
52
|
+
"@tapflowio/ios-agent": "0.8.0",
|
|
53
|
+
"@tapflowio/relay": "0.8.0"
|
|
54
54
|
},
|
|
55
55
|
"devDependencies": {
|
|
56
56
|
"@types/node": "^20.0.0",
|