Skip to content

chore(cli): unhide netcheck command #8412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2023
Merged

chore(cli): unhide netcheck command #8412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions cli/netcheck.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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),
),
Expand Down
4 changes: 2 additions & 2 deletions cli/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -107,7 +108,6 @@ func (r *RootCmd) Core() []*clibase.Cmd {

// Hidden
r.gitssh(),
r.netcheck(),
r.vscodeSSH(),
r.workspaceAgent(),
r.expCmd(),
Expand Down
1 change: 1 addition & 0 deletions cli/testdata/coder_--help.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions cli/testdata/coder_netcheck_--help.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Usage: coder netcheck

Print network debug information for DERP and STUN

---
Run `coder --help` for a list of global options.
1 change: 1 addition & 0 deletions docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
11 changes: 11 additions & 0 deletions docs/cli/netcheck.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->

# netcheck

Print network debug information for DERP and STUN

## Usage

```console
coder netcheck
```
5 changes: 5 additions & 0 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down