chore(cli): unhide `netcheck` command (#8412)

This commit is contained in:
Colin Adler 2023-07-10 21:38:02 -05:00 committed by GitHub
parent d896b74fa2
commit 9df80530d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 28 additions and 5 deletions

View File

@ -17,9 +17,8 @@ func (r *RootCmd) netcheck() *clibase.Cmd {
client := new(codersdk.Client)
cmd := &clibase.Cmd{
Use: "netcheck",
Short: "Print network debug information for DERP and STUN",
Hidden: true,
Use: "netcheck",
Short: "Print network debug information for DERP and STUN",
Middleware: clibase.Chain(
r.InitClient(client),
),

View File

@ -79,13 +79,14 @@ func (r *RootCmd) Core() []*clibase.Cmd {
r.dotfiles(),
r.login(),
r.logout(),
r.netcheck(),
r.portForward(),
r.publickey(),
r.resetPassword(),
r.state(),
r.templates(),
r.users(),
r.tokens(),
r.users(),
r.version(defaultVersionInfo),
// Workspace Commands
@ -107,7 +108,6 @@ func (r *RootCmd) Core() []*clibase.Cmd {
// Hidden
r.gitssh(),
r.netcheck(),
r.vscodeSSH(),
r.workspaceAgent(),
r.expCmd(),

View File

@ -19,6 +19,7 @@ Coder v0.0.0-devel — A tool for provisioning self-hosted development environme
list List workspaces
login Authenticate with Coder deployment
logout Unauthenticate your local session
netcheck Print network debug information for DERP and STUN
ping Ping a workspace
port-forward Forward ports from machine to a workspace
publickey Output your Coder public key used for Git operations

View File

@ -0,0 +1,6 @@
Usage: coder netcheck
Print network debug information for DERP and STUN
---
Run `coder --help` for a list of global options.

View File

@ -35,6 +35,7 @@ Coder — A tool for provisioning self-hosted development environments with Terr
| [<code>list</code>](./cli/list.md) | List workspaces |
| [<code>login</code>](./cli/login.md) | Authenticate with Coder deployment |
| [<code>logout</code>](./cli/logout.md) | Unauthenticate your local session |
| [<code>netcheck</code>](./cli/netcheck.md) | Print network debug information for DERP and STUN |
| [<code>ping</code>](./cli/ping.md) | Ping a workspace |
| [<code>port-forward</code>](./cli/port-forward.md) | Forward ports from machine to a workspace |
| [<code>provisionerd</code>](./cli/provisionerd.md) | Manage provisioner daemons |

11
docs/cli/netcheck.md Normal file
View File

@ -0,0 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# netcheck
Print network debug information for DERP and STUN
## Usage
```console
coder netcheck
```

View File

@ -592,6 +592,11 @@
"description": "Unauthenticate your local session",
"path": "cli/logout.md"
},
{
"title": "netcheck",
"description": "Print network debug information for DERP and STUN",
"path": "cli/netcheck.md"
},
{
"title": "ping",
"description": "Ping a workspace",