From dafde9b294e279f31ede13f5d83840e8b47fa37f Mon Sep 17 00:00:00 2001 From: agrasth Date: Mon, 9 Mar 2026 11:19:51 +0530 Subject: [PATCH] Fixed Critical Violations by UX writing Audit of Jfrog CLI --- config/cli.go | 4 ++-- docs/artifactory/accesstokencreate/help.go | 2 +- docs/buildtools/docker/help.go | 4 ++-- docs/buildtools/dockerlogin/help.go | 6 +++--- docs/general/stats/help.go | 2 +- docs/general/token/help.go | 2 +- main.go | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/config/cli.go b/config/cli.go index 1b8f0ca7c..a99a3b7d9 100644 --- a/config/cli.go +++ b/config/cli.go @@ -245,7 +245,7 @@ func ValidateServerId(serverId string) error { reservedIds := []string{"delete", "use", "show", "clear"} for _, reservedId := range reservedIds { if serverId == reservedId { - return fmt.Errorf("server can't have one of the following ID's: %s\n%s", strings.Join(reservedIds, ", "), cliutils.GetDocumentationMessage()) + return fmt.Errorf("server can't have one of the following IDs: %s\n%s", strings.Join(reservedIds, ", "), cliutils.GetDocumentationMessage()) } } return nil @@ -300,7 +300,7 @@ func validatePathsExist(paths ...string) error { return err } if !exists { - return errorutils.CheckErrorf("file does not exit at %s", path) + return errorutils.CheckErrorf("File doesn't exist at %s", path) } } } diff --git a/docs/artifactory/accesstokencreate/help.go b/docs/artifactory/accesstokencreate/help.go index f51c8e6f0..e2c2571db 100644 --- a/docs/artifactory/accesstokencreate/help.go +++ b/docs/artifactory/accesstokencreate/help.go @@ -3,7 +3,7 @@ package accesstokencreate var Usage = []string{"rt atc", "rt atc "} func GetDescription() string { - return "Creates an Artifactory access token. By default an user-scoped token will be created, unless the --groups and/or --grant-admin options are specified." + return "Creates an Artifactory access token. By default, a user-scoped token is created, unless the --groups and/or --grant-admin options are specified." } func GetArguments() string { diff --git a/docs/buildtools/docker/help.go b/docs/buildtools/docker/help.go index a27f53378..a91519f6d 100644 --- a/docs/buildtools/docker/help.go +++ b/docs/buildtools/docker/help.go @@ -3,11 +3,11 @@ package docker var Usage = []string{"docker [command options]"} func GetDescription() string { - return `Run any docker command, including ‘jf docker scan’ for scanning a local image with Xray.` + return `Run any docker command, including ‘jf docker scan’ for scanning a local image with JFrog Xray.` } func GetArguments() string { - return ` login Login to a artifactory Docker registry. + return ` login Log in to an Artifactory Docker registry. build Run docker build. push Run docker push. pull Run docker pull. diff --git a/docs/buildtools/dockerlogin/help.go b/docs/buildtools/dockerlogin/help.go index 1a0869524..0131458b1 100644 --- a/docs/buildtools/dockerlogin/help.go +++ b/docs/buildtools/dockerlogin/help.go @@ -7,10 +7,10 @@ var Usage = []string{"docker login [registry] [command options]", "docker login my-docker-registry.jfrog.io --username my-username --password my-password"} func GetDescription() string { - return `Login to a artifactory Docker registry` + return `Log in to an Artifactory Docker registry` } func GetArguments() string { - return ` Command accepts optional registry for login. If not provided, the registry from the jfrog config server-id will be used. - This argument is mandatory when logging in using username and password.` + return ` You can optionally specify a registry. If not provided, the registry from the JFrog config server-id is used. + This argument is mandatory when logging in with a username and password.` } diff --git a/docs/general/stats/help.go b/docs/general/stats/help.go index ebd92f9a7..193dfa157 100644 --- a/docs/general/stats/help.go +++ b/docs/general/stats/help.go @@ -21,6 +21,6 @@ func GetArguments() string { The output format in which you want statistics to be shown. Currently, Json, Table and Text (default) are supported. --access-token(optional) - The access token using which you want statistics will be fetched from jfrog instance. By default, logged user access token is used. For some products, like JPDs, projects, user needs to provide admin token. + The access token using which you want statistics will be fetched from jfrog instance. By default, logged user access token is used. For some products, like JFrog Platform Deployments and projects, you need to provide an admin token. ` } diff --git a/docs/general/token/help.go b/docs/general/token/help.go index d7dc4124d..5cef2c3e1 100644 --- a/docs/general/token/help.go +++ b/docs/general/token/help.go @@ -3,7 +3,7 @@ package token var Usage = []string{"atc", "atc "} func GetDescription() string { - return `Creates an access token. By default, an user-scoped token will be created. Administrator may provide the scope explicitly with '--scope', or implicitly with '--groups', '--grant-admin'.` + return `Creates an access token. By default, a user-scoped token is created. Administrator may provide the scope explicitly with '--scope', or implicitly with '--groups', '--grant-admin'.` } func GetArguments() string { diff --git a/main.go b/main.go index 73585f5e4..eee74d3d0 100644 --- a/main.go +++ b/main.go @@ -86,7 +86,7 @@ func execMain() error { app := cli.NewApp() app.Name = jfrogAppName - app.Usage = "See https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli for full documentation." + app.Usage = "For full documentation, visit https://docs.jfrog.com/" app.Version = cliutils.GetVersion() args := os.Args cliutils.SetCliExecutableName(args[0])