@scoutqa/cli 0.8.4-alpha.2 → 0.8.5-alpha.2

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 (3) hide show
  1. package/README.md +40 -0
  2. package/dist/index.cjs +100 -52426
  3. package/package.json +5 -2
package/README.md CHANGED
@@ -76,6 +76,46 @@ Priority order for settings:
76
76
  2. Config file
77
77
  3. Defaults
78
78
 
79
+ ## Testing Local/Intranet URLs
80
+
81
+ The CLI supports testing local and intranet URLs using Cloudflare Tunnel. This allows cloud-based agents to access applications running on your local machine or private network.
82
+
83
+ No additional setup is required - the CLI automatically manages the tunnel binary.
84
+
85
+ ### How It Works
86
+
87
+ When you run a test against a local URL (e.g., `http://localhost:3000`):
88
+
89
+ 1. The CLI detects the local URL
90
+ 2. The server creates a secure Cloudflare Tunnel and returns a tunnel token
91
+ 3. The CLI automatically downloads (if needed) and starts `cloudflared` to establish the tunnel
92
+ 4. The cloud agent accesses your local app through the tunnel
93
+ 5. When the execution completes, the tunnel is automatically cleaned up
94
+
95
+ ### Supported URL Types
96
+
97
+ - Loopback addresses: `localhost`, `127.0.0.1`
98
+ - Private networks: `192.168.x.x`, `10.x.x.x`, `172.16-31.x.x`
99
+ - Link-local: `169.254.x.x`
100
+ - mDNS hostnames: `*.local`
101
+ - Single-label hosts: `intranet`, `myserver`
102
+
103
+ > **Note:** IPv6 addresses are not supported.
104
+
105
+ ### Example
106
+
107
+ ```bash
108
+ # Start your local app
109
+ npm run dev # Runs on localhost:3000
110
+
111
+ # In another terminal, run Scout
112
+ scoutqa create-execution \
113
+ --url http://localhost:3000 \
114
+ --prompt "Test the homepage"
115
+ ```
116
+
117
+ The CLI will automatically set up the tunnel and connect your local app to the cloud agent.
118
+
79
119
  ## Examples
80
120
 
81
121
  ### Create and run a test