Skip to content

chore: disable auto generated tag for CLI docs #5905

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.

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
Jan 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 0 additions & 2 deletions docs/cli/coder.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,3 @@ coder [flags]
- [coder update](coder_update.md) - Update a workspace
- [coder users](coder_users.md) - Manage users
- [coder version](coder_version.md) - Show coder version

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_config-ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,3 @@ coder config-ssh [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,3 @@ coder create [name] [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,3 @@ coder delete <workspace> [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_dotfiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,3 @@ coder dotfiles [git_repo_url] [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,3 @@ coder list [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_login.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,3 @@ coder login <url> [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_logout.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,3 @@ coder logout [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_port-forward.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,3 @@ coder port-forward <workspace> [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_publickey.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,3 @@ coder publickey [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_rename.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,3 @@ coder rename <workspace> <new name> [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_reset-password.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,3 @@ coder reset-password <username> [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_restart.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,3 @@ coder restart <workspace> [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_scaletest.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,3 @@ coder scaletest [flags]
- [coder](coder.md) -
- [coder scaletest cleanup](coder_scaletest_cleanup.md) - Cleanup any orphaned scaletest resources
- [coder scaletest create-workspaces](coder_scaletest_create-workspaces.md) - Creates many workspaces and waits for them to be ready

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_scaletest_cleanup.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,3 @@ coder scaletest cleanup [flags]
### SEE ALSO

- [coder scaletest](coder_scaletest.md) - Run a scale test against the Coder API

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_scaletest_create-workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,3 @@ coder scaletest create-workspaces [flags]
### SEE ALSO

- [coder scaletest](coder_scaletest.md) - Run a scale test against the Coder API

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_schedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,3 @@ coder schedule { show | start | stop | override } <workspace> [flags]
- [coder schedule show](coder_schedule_show.md) - Show workspace schedule
- [coder schedule start](coder_schedule_start.md) - Edit workspace start schedule
- [coder schedule stop](coder_schedule_stop.md) - Edit workspace stop schedule

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_schedule_override-stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,3 @@ coder schedule override-stop <workspace-name> <duration from now> [flags]
### SEE ALSO

- [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_schedule_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,3 @@ coder schedule show <workspace-name> [flags]
### SEE ALSO

- [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_schedule_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,3 @@ coder schedule start <workspace-name> { <start-time> [day-of-week] [location] |
### SEE ALSO

- [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_schedule_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,3 @@ coder schedule stop <workspace-name> { <duration> | manual } [flags]
### SEE ALSO

- [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,5 +168,3 @@ coder server [flags]
- [coder](coder.md) -
- [coder server postgres-builtin-serve](coder_server_postgres-builtin-serve.md) - Run the built-in PostgreSQL deployment.
- [coder server postgres-builtin-url](coder_server_postgres-builtin-url.md) - Output the connection URL for the built-in PostgreSQL deployment.

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_server_postgres-builtin-serve.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,3 @@ coder server postgres-builtin-serve [flags]
### SEE ALSO

- [coder server](coder_server.md) - Start a Coder server

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_server_postgres-builtin-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,3 @@ coder server postgres-builtin-url [flags]
### SEE ALSO

- [coder server](coder_server.md) - Start a Coder server

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,3 @@ coder show <workspace> [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_speedtest.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,3 @@ coder speedtest <workspace> [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,3 @@ coder ssh <workspace> [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,3 @@ coder start <workspace> [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_state.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,3 @@ coder state [flags]
- [coder](coder.md) -
- [coder state pull](coder_state_pull.md) -
- [coder state push](coder_state_push.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_state_pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,3 @@ coder state pull <workspace> [file] [flags]
### SEE ALSO

- [coder state](coder_state.md) - Manually manage Terraform state to fix broken workspaces

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_state_push.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,3 @@ coder state push <workspace> <file> [flags]
### SEE ALSO

- [coder state](coder_state.md) - Manually manage Terraform state to fix broken workspaces

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,3 @@ coder stop <workspace> [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,3 @@ coder templates [flags]
- [coder templates pull](coder_templates_pull.md) - Download the latest version of a template to a path.
- [coder templates push](coder_templates_push.md) - Push a new template version from the current directory or as specified by flag
- [coder templates versions](coder_templates_versions.md) - Manage different versions of the specified template

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_templates_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,3 @@ coder templates create [name] [flags]
### SEE ALSO

- [coder templates](coder_templates.md) - Manage templates

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_templates_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,3 @@ coder templates delete [name...] [flags]
### SEE ALSO

- [coder templates](coder_templates.md) - Manage templates

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_templates_edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,3 @@ coder templates edit <template> [flags]
### SEE ALSO

- [coder templates](coder_templates.md) - Manage templates

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_templates_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,3 @@ coder templates init [directory] [flags]
### SEE ALSO

- [coder templates](coder_templates.md) - Manage templates

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_templates_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,3 @@ coder templates list [flags]
### SEE ALSO

- [coder templates](coder_templates.md) - Manage templates

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_templates_plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,3 @@ coder templates plan <directory> [flags]
### SEE ALSO

- [coder templates](coder_templates.md) - Manage templates

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_templates_pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,3 @@ coder templates pull <name> [destination] [flags]
### SEE ALSO

- [coder templates](coder_templates.md) - Manage templates

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_templates_push.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,3 @@ coder templates push [template] [flags]
### SEE ALSO

- [coder templates](coder_templates.md) - Manage templates

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_templates_versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,3 @@ coder templates versions [flags]

- [coder templates](coder_templates.md) - Manage templates
- [coder templates versions list](coder_templates_versions_list.md) - List all the versions of the specified template

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_templates_versions_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,3 @@ coder templates versions list <template> [flags]
### SEE ALSO

- [coder templates versions](coder_templates_versions.md) - Manage different versions of the specified template

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,3 @@ coder tokens [flags]
- [coder tokens create](coder_tokens_create.md) - Create a tokens
- [coder tokens list](coder_tokens_list.md) - List tokens
- [coder tokens remove](coder_tokens_remove.md) - Delete a token

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_tokens_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,3 @@ coder tokens create [flags]
### SEE ALSO

- [coder tokens](coder_tokens.md) - Manage personal access tokens

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_tokens_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,3 @@ coder tokens list [flags]
### SEE ALSO

- [coder tokens](coder_tokens.md) - Manage personal access tokens

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_tokens_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,3 @@ coder tokens remove [id] [flags]
### SEE ALSO

- [coder tokens](coder_tokens.md) - Manage personal access tokens

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,3 @@ coder update <workspace> [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_users.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,3 @@ coder users [flags]
- [coder users list](coder_users_list.md) -
- [coder users show](coder_users_show.md) - Show a single user. Use 'me' to indicate the currently authenticated user.
- [coder users suspend](coder_users_suspend.md) - Update a user's status to 'suspended'. A suspended user cannot log into the platform

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_users_activate.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,3 @@ coder users activate <username|user_id> [flags]
### SEE ALSO

- [coder users](coder_users.md) - Manage users

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_users_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,3 @@ coder users create [flags]
### SEE ALSO

- [coder users](coder_users.md) - Manage users

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_users_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,3 @@ coder users list [flags]
### SEE ALSO

- [coder users](coder_users.md) - Manage users

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_users_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,3 @@ coder users show <username|user_id|'me'> [flags]
### SEE ALSO

- [coder users](coder_users.md) - Manage users

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_users_suspend.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,3 @@ coder users suspend <username|user_id> [flags]
### SEE ALSO

- [coder users](coder_users.md) - Manage users

###### Auto generated by spf13/cobra on 27-Jan-2023
2 changes: 0 additions & 2 deletions docs/cli/coder_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,3 @@ coder version [flags]
### SEE ALSO

- [coder](coder.md) -

###### Auto generated by spf13/cobra on 27-Jan-2023
11 changes: 11 additions & 0 deletions scripts/clidocgen/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"regexp"
"strings"

"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"

"github.com/coder/coder/buildinfo"
Expand Down Expand Up @@ -63,6 +64,16 @@ func main() {
markdownDocsDir := path.Join(basePath, "docs/cli")
manifestFilepath := path.Join(basePath, "docs/manifest.json")

// Disables the "Auto generated by spf13/cobra" tag
var disableAutoGenTag func(cmd *cobra.Command)
disableAutoGenTag = func(cmd *cobra.Command) {
for _, c := range cmd.Commands() {
disableAutoGenTag(c)
}
cmd.DisableAutoGenTag = true
}
disableAutoGenTag(cmd)

// Generate markdown
err = doc.GenMarkdownTree(cmd, markdownDocsDir)
if err != nil {
Expand Down