diff --git a/README.md b/README.md index 8e6d8de1..55eccc23 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,4 @@ For [installation options see below](#installation), for usage instructions [see ## Installation -For Windows, Mac OS(10.12+) or Linux, you can download a binary from the [releases page][]. +`azdo` is availeable for Windows, Mac OS(10.12+), Linux or FreeBSD, as downloadable binary from the [releases page][]. diff --git a/cmd/gen-docs/gen-docs.go b/cmd/gen-docs/gen-docs.go index 385fd414..5c6598c8 100644 --- a/cmd/gen-docs/gen-docs.go +++ b/cmd/gen-docs/gen-docs.go @@ -4,7 +4,6 @@ import ( "fmt" "os" "path/filepath" - "strings" "github.com/spf13/pflag" "github.com/tmeckel/azdo-cli/internal/cmd/root" @@ -72,5 +71,5 @@ func filePrepender(filename string) string { } func linkHandler(name string) string { - return fmt.Sprintf("./%s", strings.TrimSuffix(name, ".md")) + return fmt.Sprintf("./%s", name) } diff --git a/docs/azdo.md b/docs/azdo.md index f6bf7b2c..d4e0938b 100644 --- a/docs/azdo.md +++ b/docs/azdo.md @@ -1,12 +1,12 @@ ## azdo Work seamlessly with Azure DevOps from the command line. ### Core commands -* [azdo auth](./azdo_auth) -* [azdo project](./azdo_project) -* [azdo repo](./azdo_repo) +* [azdo auth](./azdo_auth.md) +* [azdo project](./azdo_project.md) +* [azdo repo](./azdo_repo.md) ### Additional commands -* [azdo config](./azdo_config) +* [azdo config](./azdo_config.md) ### Options diff --git a/docs/azdo_auth.md b/docs/azdo_auth.md index a5d92c8d..3a1e4a1d 100644 --- a/docs/azdo_auth.md +++ b/docs/azdo_auth.md @@ -1,11 +1,11 @@ ## azdo auth Authenticate azdo and git with Azure DevOps ### Available commands -* [azdo auth login](./azdo_auth_login) -* [azdo auth logout](./azdo_auth_logout) -* [azdo auth setup-git](./azdo_auth_setup-git) -* [azdo auth status](./azdo_auth_status) +* [azdo auth login](./azdo_auth_login.md) +* [azdo auth logout](./azdo_auth_logout.md) +* [azdo auth setup-git](./azdo_auth_setup-git.md) +* [azdo auth status](./azdo_auth_status.md) ### See also -* [azdo](./azdo) +* [azdo](./azdo.md) diff --git a/docs/azdo_auth_login.md b/docs/azdo_auth_login.md index b5d20e74..6b909e9a 100644 --- a/docs/azdo_auth_login.md +++ b/docs/azdo_auth_login.md @@ -51,4 +51,4 @@ $ azdo auth login --organizationUrl https://dev.azure.com/myorg ### See also -* [azdo auth](./azdo_auth) +* [azdo auth](./azdo_auth.md) diff --git a/docs/azdo_auth_logout.md b/docs/azdo_auth_logout.md index 54fff72f..fc740169 100644 --- a/docs/azdo_auth_logout.md +++ b/docs/azdo_auth_logout.md @@ -27,4 +27,4 @@ $ azdo auth logout --hostname enterprise.internal ### See also -* [azdo auth](./azdo_auth) +* [azdo auth](./azdo_auth.md) diff --git a/docs/azdo_auth_setup-git.md b/docs/azdo_auth_setup-git.md index 2ba0810b..f3b1c50c 100644 --- a/docs/azdo_auth_setup-git.md +++ b/docs/azdo_auth_setup-git.md @@ -34,4 +34,4 @@ $ azdo auth setup-git --organization enterprise.internal ### See also -* [azdo auth](./azdo_auth) +* [azdo auth](./azdo_auth.md) diff --git a/docs/azdo_auth_status.md b/docs/azdo_auth_status.md index ac0737d9..b410320a 100644 --- a/docs/azdo_auth_status.md +++ b/docs/azdo_auth_status.md @@ -17,4 +17,4 @@ report any issues. ### See also -* [azdo auth](./azdo_auth) +* [azdo auth](./azdo_auth.md) diff --git a/docs/azdo_config.md b/docs/azdo_config.md index 3b1c0c8a..6114a417 100644 --- a/docs/azdo_config.md +++ b/docs/azdo_config.md @@ -11,10 +11,10 @@ Current respected settings: - default_organization: the default Azure DevOps organization to use, if no organization is specified ### Available commands -* [azdo config get](./azdo_config_get) -* [azdo config list](./azdo_config_list) -* [azdo config set](./azdo_config_set) +* [azdo config get](./azdo_config_get.md) +* [azdo config list](./azdo_config_list.md) +* [azdo config set](./azdo_config_set.md) ### See also -* [azdo](./azdo) +* [azdo](./azdo.md) diff --git a/docs/azdo_config_get.md b/docs/azdo_config_get.md index ae73b135..8cd65062 100644 --- a/docs/azdo_config_get.md +++ b/docs/azdo_config_get.md @@ -14,11 +14,10 @@ azdo config get [flags] ### Examples ```bash - - $ azdo config get git_protocol - https - ``` +$ azdo config get git_protocol +https +``` ### See also -* [azdo config](./azdo_config) +* [azdo config](./azdo_config.md) diff --git a/docs/azdo_config_list.md b/docs/azdo_config_list.md index 0ab5a877..234f3a7b 100644 --- a/docs/azdo_config_list.md +++ b/docs/azdo_config_list.md @@ -13,4 +13,4 @@ azdo config list [flags] ### See also -* [azdo config](./azdo_config) +* [azdo config](./azdo_config.md) diff --git a/docs/azdo_config_set.md b/docs/azdo_config_set.md index 6fb28904..b0073453 100644 --- a/docs/azdo_config_set.md +++ b/docs/azdo_config_set.md @@ -22,4 +22,4 @@ $ azdo config set prompt disabled ### See also -* [azdo config](./azdo_config) +* [azdo config](./azdo_config.md) diff --git a/docs/azdo_help.md b/docs/azdo_help.md index 966fbaf3..1f0ee638 100644 --- a/docs/azdo_help.md +++ b/docs/azdo_help.md @@ -6,4 +6,4 @@ Help provides help for any command in the application. Simply type azdo help [path to command] for full details. ### See also -* [azdo](./azdo) +* [azdo](./azdo.md) diff --git a/docs/azdo_help_environment.md b/docs/azdo_help_environment.md index d4160b77..62b8351c 100644 --- a/docs/azdo_help_environment.md +++ b/docs/azdo_help_environment.md @@ -42,4 +42,4 @@ AZDO_PROMPT_DISABLED: set to any value to disable interactive prompting in the t ### See also -* [azdo](./azdo) +* [azdo](./azdo.md) diff --git a/docs/azdo_help_exit-codes.md b/docs/azdo_help_exit-codes.md index 59bd156e..4f488da7 100644 --- a/docs/azdo_help_exit-codes.md +++ b/docs/azdo_help_exit-codes.md @@ -15,4 +15,4 @@ control some behavior. ### See also -* [azdo](./azdo) +* [azdo](./azdo.md) diff --git a/docs/azdo_help_mintty.md b/docs/azdo_help_mintty.md index 15ad01b6..b229b108 100644 --- a/docs/azdo_help_mintty.md +++ b/docs/azdo_help_mintty.md @@ -16,4 +16,4 @@ There are a few workarounds to make azdo work with MinTTY: ### See also -* [azdo](./azdo) +* [azdo](./azdo.md) diff --git a/docs/azdo_help_reference.md b/docs/azdo_help_reference.md index d315df28..f58583ae 100644 --- a/docs/azdo_help_reference.md +++ b/docs/azdo_help_reference.md @@ -113,4 +113,4 @@ List repositories of a project inside an organization ### See also -* [azdo](./azdo) +* [azdo](./azdo.md) diff --git a/docs/azdo_project.md b/docs/azdo_project.md index e5aae220..bf1fb699 100644 --- a/docs/azdo_project.md +++ b/docs/azdo_project.md @@ -1,7 +1,7 @@ ## azdo project Work with Azure DevOps Projects. ### Available commands -* [azdo project list](./azdo_project_list) +* [azdo project list](./azdo_project_list.md) ### Examples @@ -13,4 +13,4 @@ $ azdo project delete -o ### See also -* [azdo](./azdo) +* [azdo](./azdo.md) diff --git a/docs/azdo_project_list.md b/docs/azdo_project_list.md index ed76c101..2f504106 100644 --- a/docs/azdo_project_list.md +++ b/docs/azdo_project_list.md @@ -35,4 +35,4 @@ azdo project list --organization myorg --closed ### See also -* [azdo project](./azdo_project) +* [azdo project](./azdo_project.md) diff --git a/docs/azdo_repo.md b/docs/azdo_repo.md index 2c4edafe..0a64ce64 100644 --- a/docs/azdo_repo.md +++ b/docs/azdo_repo.md @@ -1,8 +1,8 @@ ## azdo repo Work with Azure DevOps Git repositories. ### Available commands -* [azdo repo clone](./azdo_repo_clone) -* [azdo repo list](./azdo_repo_list) +* [azdo repo clone](./azdo_repo_clone.md) +* [azdo repo list](./azdo_repo_list.md) ### Examples @@ -15,4 +15,4 @@ $ azdo repo view --web ### See also -* [azdo](./azdo) +* [azdo](./azdo.md) diff --git a/docs/azdo_repo_clone.md b/docs/azdo_repo_clone.md index 1a3c75ef..f2f754d7 100644 --- a/docs/azdo_repo_clone.md +++ b/docs/azdo_repo_clone.md @@ -27,4 +27,4 @@ them after "--". ### See also -* [azdo repo](./azdo_repo) +* [azdo repo](./azdo_repo.md) diff --git a/docs/azdo_repo_list.md b/docs/azdo_repo_list.md index 7044a7c9..62457250 100644 --- a/docs/azdo_repo_list.md +++ b/docs/azdo_repo_list.md @@ -39,4 +39,4 @@ azdo repo list myproject --organization myorg ### See also -* [azdo repo](./azdo_repo) +* [azdo repo](./azdo_repo.md) diff --git a/internal/cmd/config/get/get.go b/internal/cmd/config/get/get.go index e722f96b..aaf82b60 100644 --- a/internal/cmd/config/get/get.go +++ b/internal/cmd/config/get/get.go @@ -3,6 +3,7 @@ package get import ( "fmt" + "github.com/MakeNowJust/heredoc" "github.com/spf13/cobra" "github.com/tmeckel/azdo-cli/internal/cmd/util" "github.com/tmeckel/azdo-cli/internal/config" @@ -19,10 +20,10 @@ func NewCmdConfigGet(ctx util.CmdContext) *cobra.Command { cmd := &cobra.Command{ Use: "get ", Short: "Print the value of a given configuration key", - Example: ` + Example: heredoc.Doc(` $ azdo config get git_protocol https - `, + `), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.Key = args[0]