Skip to content

Commit 0f4e1d6

Browse files
committed
docs: add pre-built binary install instructions and CI/CD workflow example
1 parent ef435b1 commit 0f4e1d6

1 file changed

Lines changed: 59 additions & 14 deletions

File tree

README.md

Lines changed: 59 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,25 @@ The **ProbeAgent** is a Dart package you add to your Flutter app as a dev depend
3838

3939
## Installation
4040

41-
### 1. Build the CLI
41+
### Option A — Download pre-built binary (recommended for CI/CD)
42+
43+
Pre-built binaries for Linux, macOS (Intel + Apple Silicon), and Windows are attached to every [GitHub Release](https://github.com/AlphaWaveSystems/flutter-probe/releases).
44+
45+
```bash
46+
# Linux (amd64)
47+
curl -Lo probe https://github.com/AlphaWaveSystems/flutter-probe/releases/latest/download/probe-linux-amd64
48+
chmod +x probe && sudo mv probe /usr/local/bin/
49+
50+
# macOS Apple Silicon
51+
curl -Lo probe https://github.com/AlphaWaveSystems/flutter-probe/releases/latest/download/probe-darwin-arm64
52+
chmod +x probe && sudo mv probe /usr/local/bin/
53+
54+
# macOS Intel
55+
curl -Lo probe https://github.com/AlphaWaveSystems/flutter-probe/releases/latest/download/probe-darwin-amd64
56+
chmod +x probe && sudo mv probe /usr/local/bin/
57+
```
58+
59+
### Option B — Build from source
4260

4361
```bash
4462
git clone https://github.com/AlphaWaveSystems/flutter-probe.git
@@ -252,21 +270,48 @@ Tap, swipe, and type in your app — FlutterProbe writes the `.probe` file as yo
252270

253271
## CI/CD Integration
254272

273+
No need to clone this repo in your own CI pipelines. Download the pre-built binary directly from GitHub Releases:
274+
275+
```yaml
276+
# .github/workflows/e2e.yml
277+
jobs:
278+
e2e:
279+
runs-on: ubuntu-latest
280+
steps:
281+
- uses: actions/checkout@v4
282+
283+
- name: Install FlutterProbe
284+
run: |
285+
curl -Lo probe https://github.com/AlphaWaveSystems/flutter-probe/releases/latest/download/probe-linux-amd64
286+
chmod +x probe
287+
sudo mv probe /usr/local/bin/
288+
289+
- name: Start Android emulator
290+
uses: reactivecircus/android-emulator-runner@v2
291+
with:
292+
api-level: 33
293+
script: |
294+
probe test tests/ \
295+
--device emulator-5554 \
296+
--format junit \
297+
-o results.xml \
298+
--timeout 60s -v -y
299+
300+
- name: Upload test results
301+
uses: actions/upload-artifact@v4
302+
if: always()
303+
with:
304+
name: test-results
305+
path: results.xml
306+
```
307+
308+
Pin to a specific version for reproducible builds:
309+
255310
```yaml
256-
# .github/workflows/test.yml
257-
- name: Run FlutterProbe tests
311+
- name: Install FlutterProbe v0.1.0
258312
run: |
259-
bin/probe test tests/ \
260-
--device emulator-5554 \
261-
--format junit \
262-
-o results.xml \
263-
--timeout 60s -v -y
264-
265-
- name: Upload results
266-
uses: actions/upload-artifact@v4
267-
with:
268-
name: test-results
269-
path: results.xml
313+
curl -Lo probe https://github.com/AlphaWaveSystems/flutter-probe/releases/download/v0.1.0/probe-linux-amd64
314+
chmod +x probe && sudo mv probe /usr/local/bin/
270315
```
271316
272317
Generate a portable HTML report from JSON output:

0 commit comments

Comments
 (0)