Files
coder/docs/reference/cli/ping.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

59 lines
1.1 KiB
Markdown
Raw Normal View History

---
# Code generated by make gen. DO NOT EDIT.
title: ping
description: Ping a workspace
---
2023-03-23 17:42:20 -05:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
Ping a workspace
## Usage
```console
coder ping [flags] <workspace>
```
## Options
### --wait
2023-03-23 17:42:20 -05:00
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>1s</code> |
2023-03-23 17:42:20 -05:00
Specifies how long to wait between pings.
2023-03-23 17:42:20 -05:00
### -t, --timeout
| | |
|---------|-----------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>duration</code> |
| Default | <code>5s</code> |
Specifies how long to wait for a ping to complete.
### -n, --num
2023-03-23 17:42:20 -05:00
2024-09-25 13:24:23 +10:00
| | |
|------|------------------|
2024-09-25 13:24:23 +10:00
| Type | <code>int</code> |
2023-03-23 17:42:20 -05:00
2024-09-25 13:24:23 +10:00
Specifies the number of pings to perform. By default, pings will continue until interrupted.
### --time
| | |
|------|-------------------|
| Type | <code>bool</code> |
Show the response time of each pong in local time.
### --utc
| | |
|------|-------------------|
| Type | <code>bool</code> |
Show the response time of each pong in UTC (implies --time).