@xcelera/cli 2.3.1 → 3.0.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 CHANGED
@@ -8,7 +8,7 @@ A CLI for running Lighthouse performance audits using xcelera.dev
8
8
 
9
9
  ```bash
10
10
  # Basic audit
11
- xcelera audit --url https://example.com --token your-api-token
11
+ xcelera audit --ref https://example.com --token your-api-token
12
12
  ```
13
13
 
14
14
  ### Authenticated Pages
@@ -17,23 +17,20 @@ For pages behind login, you can pass authentication credentials:
17
17
 
18
18
  ```bash
19
19
  # With session cookie
20
- xcelera audit --url https://myapp.com/dashboard --cookie "session=abc123"
20
+ xcelera audit --ref myapp-com-dashboard --cookie "session=abc123"
21
21
 
22
22
  # With bearer token header
23
- xcelera audit --url https://api.myapp.com/admin \
23
+ xcelera audit --ref myapp-com-admin \
24
24
  --header "Authorization: Bearer eyJhbG..."
25
25
 
26
26
  # Multiple cookies
27
- xcelera audit --url https://myapp.com/dashboard \
27
+ xcelera audit --ref myapp-com-dashboard \
28
28
  --cookie "session=abc123" --cookie "csrf=xyz"
29
29
 
30
- # Full auth JSON (multiple cookies and custom headers)
31
- xcelera audit --url https://myapp.com/dashboard \
32
- --auth '{"cookies":[{"name":"session","value":"abc123"}],"headers":{"X-Custom":"value"}}'
30
+ # With Netscape cookie file (cookies.txt)
31
+ xcelera audit --ref myapp-com-dashboard \
32
+ --cookie-file ./cookies.txt
33
33
 
34
- # Using environment variable
35
- export XCELERA_AUTH='{"cookies":[{"name":"session","value":"abc123"}]}'
36
- xcelera audit --url https://myapp.com/dashboard
37
34
  ```
38
35
 
39
36
  ### GitHub Action Usage
@@ -42,7 +39,7 @@ xcelera audit --url https://myapp.com/dashboard
42
39
  - name: Lighthouse Performance Audit
43
40
  uses: xcelera/cli@v1
44
41
  with:
45
- url: https://example.com
42
+ ref: myapp-com-dashboard
46
43
  token: ${{ secrets.XCELERA_TOKEN }}
47
44
  ```
48
45
 
@@ -53,15 +50,23 @@ For authenticated pages in CI:
53
50
  - name: Lighthouse Audit (Cookie Auth)
54
51
  uses: xcelera/cli@v1
55
52
  with:
56
- url: https://example.com/dashboard
53
+ ref: myapp-com-dashboard
57
54
  token: ${{ secrets.XCELERA_TOKEN }}
58
55
  cookie: "session=value"
59
56
 
57
+ # With Netscape cookie file (cookies.txt)
58
+ - name: Lighthouse Audit (Cookie File Auth)
59
+ uses: xcelera/cli@v1
60
+ with:
61
+ ref: myapp-com-dashboard
62
+ token: ${{ secrets.XCELERA_TOKEN }}
63
+ cookie-file: ./cookies.txt
64
+
60
65
  # With bearer token header
61
66
  - name: Lighthouse Audit (Bearer Auth)
62
67
  uses: xcelera/cli@v1
63
68
  with:
64
- url: https://example.com/admin
69
+ ref: myapp-com-admin
65
70
  token: ${{ secrets.XCELERA_TOKEN }}
66
71
  header: "Authorization: Bearer eybDfd..."
67
72
 
@@ -69,7 +74,7 @@ For authenticated pages in CI:
69
74
  - name: Lighthouse Audit (Full Auth)
70
75
  uses: xcelera/cli@v1
71
76
  with:
72
- url: https://example.com/dashboard
77
+ ref: myapp-com-dashboard
73
78
  token: ${{ secrets.XCELERA_TOKEN }}
74
79
  auth: '{"cookies":[{"name":"session","value":"session_value"},{"name":"csrf","value":"csrf_value"}]}'
75
80
  ```