## Summary Regenerate `docs/reference/cli/ping.md` so `main` passes `lint/docs-html` and the `offlinedocs` unstaged-files check again. #30148 committed the page from a branch that predated #30879, which gave CLI option tables a `Property | Value` header. ## Changes - Regenerate `docs/reference/cli/ping.md` with `make -B docs/reference/cli/index.md`. No hand edits. Linear: DOCS-1424 ## Testing - `make -B docs/reference/cli/index.md` reports that only `ping.md` changed, and the diff matches what CI reported. - `go run ./scripts/docshtmlcheck` passes. --- > [!NOTE] > Generated by Coder Agents on behalf of @nickvigilante.
1.8 KiB
Generated
1.8 KiB
Generated
title, description
| title | description |
|---|---|
| `coder ping` | Ping a workspace. |
Ping a workspace
Usage
coder ping [flags] <workspace>
Options
--wait
| Property | Value |
|---|---|
| Type | duration |
| Default | 1s |
Specifies how long to wait between pings.
-t, --timeout
| Property | Value |
|---|---|
| Type | duration |
| Default | 5s |
Specifies how long to wait for a ping to complete.
-n, --num
| Property | Value |
|---|---|
| Type | int |
Specifies the number of pings to perform. By default, pings will continue until interrupted. Required with --output json.
--time
| Property | Value |
|---|---|
| Type | bool |
Show the response time of each pong in local time.
--utc
| Property | Value |
|---|---|
| Type | bool |
Show the response time of each pong in UTC (implies --time).
-c, --column
| Property | Value |
|---|---|
| Type | [workspace|total|successful|min|avg|max|variance] |
| Default | workspace,total,successful,min,avg,max,variance |
Columns to display in table output.
-o, --output
| Property | Value |
|---|---|
| Type | table|json |
| Default | table |
Output format.