opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: move api and cli docs routes to reference/ (#14241)

Browse Source
This commit is contained in:
Muhammad Atif Ali
2024-08-13 18:39:46 +03:00
committed by GitHub
parent 6f9b1a39f4
commit 48f29a1995
145 changed files with 4121 additions and 3448 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/cli/ping.md
Generated
+40
View File
@@ -0,0 +1,40 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ping
Ping a workspace
## Usage
```console
coder ping [flags] <workspace>
```
## Options
### --wait
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>1s</code> |
Specifies how long to wait between pings.
### -t, --timeout
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>5s</code> |
Specifies how long to wait for a ping to complete.
### -n, --num
| | |
| ------- | ---------------- |
| Type | <code>int</code> |
| Default | <code>10</code> |
Specifies the number of pings to perform.