Skip to content

Commit 3fccd9f

Browse files
Update k6 Options, Address description (#2093)
* Update k6 Options, Address description Edit the description on how to disable the HTTP server * Apply to previous versions
1 parent 9ba635b commit 3fccd9f

File tree

4 files changed

+12
-16
lines changed

4 files changed

+12
-16
lines changed

docs/sources/k6/next/using-k6/k6-options/reference.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,10 @@ and `k6 cloud run ...`, which you can use to override options specified in the c
8888

8989
## Address
9090

91-
Address of the API server. When executing scripts with `k6 run` an HTTP server with a REST API is spun up,
91+
Address of the API server. When executing scripts with `k6 run`, an HTTP server with a REST API is spun up,
9292
which can be used to control some of the parameters of the test execution.
93-
By default, the server listens on `localhost:6565`. Read more on [k6 REST API](https://grafana.com/docs/k6/<K6_VERSION>/misc/k6-rest-api).
93+
94+
By default, the server listens on `localhost:6565`. Read more on [k6 REST API](https://grafana.com/docs/k6/<K6_VERSION>/misc/k6-rest-api). You can disable the HTTP server by setting the address value to an empty string, for example: `k6 run -a '' script.js`.
9495

9596
| Env | CLI | Code / Config file | Default |
9697
| --- | ----------------- | ------------------ | ---------------- |
@@ -104,8 +105,6 @@ k6 run --address "localhost:3000" script.js
104105

105106
{{< /code >}}
106107

107-
If you don't want to enable the HTTP server then sets the value to an empty string `k6 run -a '' script.js`.
108-
109108
## Batch
110109

111110
The maximum number of simultaneous/parallel connections in total that an

docs/sources/k6/v1.1.x/using-k6/k6-options/reference.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,10 @@ and `k6 cloud run ...`, which you can use to override options specified in the c
8888

8989
## Address
9090

91-
Address of the API server. When executing scripts with `k6 run` an HTTP server with a REST API is spun up,
91+
Address of the API server. When executing scripts with `k6 run`, an HTTP server with a REST API is spun up,
9292
which can be used to control some of the parameters of the test execution.
93-
By default, the server listens on `localhost:6565`. Read more on [k6 REST API](https://grafana.com/docs/k6/<K6_VERSION>/misc/k6-rest-api).
93+
94+
By default, the server listens on `localhost:6565`. Read more on [k6 REST API](https://grafana.com/docs/k6/<K6_VERSION>/misc/k6-rest-api). You can disable the HTTP server by setting the address value to an empty string, for example: `k6 run -a '' script.js`.
9495

9596
| Env | CLI | Code / Config file | Default |
9697
| --- | ----------------- | ------------------ | ---------------- |
@@ -104,8 +105,6 @@ k6 run --address "localhost:3000" script.js
104105

105106
{{< /code >}}
106107

107-
If you don't want to enable the HTTP server then sets the value to an empty string `k6 run -a '' script.js`.
108-
109108
## Batch
110109

111110
The maximum number of simultaneous/parallel connections in total that an

docs/sources/k6/v1.2.x/using-k6/k6-options/reference.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,10 @@ and `k6 cloud run ...`, which you can use to override options specified in the c
8888

8989
## Address
9090

91-
Address of the API server. When executing scripts with `k6 run` an HTTP server with a REST API is spun up,
91+
Address of the API server. When executing scripts with `k6 run`, an HTTP server with a REST API is spun up,
9292
which can be used to control some of the parameters of the test execution.
93-
By default, the server listens on `localhost:6565`. Read more on [k6 REST API](https://grafana.com/docs/k6/<K6_VERSION>/misc/k6-rest-api).
93+
94+
By default, the server listens on `localhost:6565`. Read more on [k6 REST API](https://grafana.com/docs/k6/<K6_VERSION>/misc/k6-rest-api). You can disable the HTTP server by setting the address value to an empty string, for example: `k6 run -a '' script.js`.
9495

9596
| Env | CLI | Code / Config file | Default |
9697
| --- | ----------------- | ------------------ | ---------------- |
@@ -104,8 +105,6 @@ k6 run --address "localhost:3000" script.js
104105

105106
{{< /code >}}
106107

107-
If you don't want to enable the HTTP server then sets the value to an empty string `k6 run -a '' script.js`.
108-
109108
## Batch
110109

111110
The maximum number of simultaneous/parallel connections in total that an

docs/sources/k6/v1.3.x/using-k6/k6-options/reference.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,10 @@ and `k6 cloud run ...`, which you can use to override options specified in the c
8888

8989
## Address
9090

91-
Address of the API server. When executing scripts with `k6 run` an HTTP server with a REST API is spun up,
91+
Address of the API server. When executing scripts with `k6 run`, an HTTP server with a REST API is spun up,
9292
which can be used to control some of the parameters of the test execution.
93-
By default, the server listens on `localhost:6565`. Read more on [k6 REST API](https://grafana.com/docs/k6/<K6_VERSION>/misc/k6-rest-api).
93+
94+
By default, the server listens on `localhost:6565`. Read more on [k6 REST API](https://grafana.com/docs/k6/<K6_VERSION>/misc/k6-rest-api). You can disable the HTTP server by setting the address value to an empty string, for example: `k6 run -a '' script.js`.
9495

9596
| Env | CLI | Code / Config file | Default |
9697
| --- | ----------------- | ------------------ | ---------------- |
@@ -104,8 +105,6 @@ k6 run --address "localhost:3000" script.js
104105

105106
{{< /code >}}
106107

107-
If you don't want to enable the HTTP server then sets the value to an empty string `k6 run -a '' script.js`.
108-
109108
## Batch
110109

111110
The maximum number of simultaneous/parallel connections in total that an

0 commit comments

Comments
 (0)