Files
coder/docs/reference/cli/ping.md
T
Nick Vigilante 1893b80805 fix(docs/reference/cli): regenerate ping docs with table headers (#31292)
## 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.
2026-10-26 13:44:04 -04:00

78 lines
1.8 KiB
Markdown
Generated

---
# Code generated by make gen. DO NOT EDIT.
title: "`coder ping`"
description: Ping a workspace.
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
Ping a workspace
## Usage
```console
coder ping [flags] <workspace>
```
## Options
### --wait
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>1s</code> |
Specifies how long to wait between pings.
### -t, --timeout
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
Specifies how long to wait for a ping to complete.
### -n, --num
| Property | Value |
|----------|------------------|
| Type | <code>int</code> |
Specifies the number of pings to perform. By default, pings will continue until interrupted. Required with --output json.
### --time
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Show the response time of each pong in local time.
### --utc
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Show the response time of each pong in UTC (implies --time).
### -c, --column
| Property | Value |
|----------|----------------------------------------------------------------------|
| Type | <code>[workspace\|total\|successful\|min\|avg\|max\|variance]</code> |
| Default | <code>workspace,total,successful,min,avg,max,variance</code> |
Columns to display in table output.
### -o, --output
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.