self-hosted/teleport
self-hosted/teleport
1
0
Fork 0
mirror of https://github.com/gravitational/teleport synced 2024-10-21 17:53:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update descriptions in our --help messages (#11267)

Browse source
This commit is contained in:
Zac Bergquist 2022-03-21 09:28:16 -06:00 committed by GitHub
parent 023f533be2
commit c9c35a1791
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
tool/tctl/common/usage.go
View file

@ -17,7 +17,7 @@ limitations under the License.
package common
const (
GlobalHelpString = "CLI Admin tool for the Teleport Auth service. Runs on a host where Teleport Auth is running."
GlobalHelpString = "Admin tool for the Teleport Access Plane"
AddUserHelp = `Notes:
@ -37,12 +37,12 @@ Examples:
`
AddNodeHelp = `Notes:
This command generates and prints an invitation token another node can use to
join the cluster.
This command generates and prints an invitation token another node can use to
join the cluster.
Examples:
> tctl nodes add
> tctl nodes add
Generates a token when can be used to add a regular SSH node to the cluster.
The token genrated single-use token will be valid for 30 minutes.
@ -50,7 +50,7 @@ Examples:
> tctl nodes add --roles=node,proxy --ttl=1h
Generates a token when can be used to add an SSH node to the cluster which
will also be a proxy node. This token can be used multiple times within an
will also be a proxy node. This token can be used multiple times within an
hour.
`
ListNodesHelp = `Notes:

2
tool/teleport/common/teleport.go
View file

@ -62,7 +62,7 @@ func Run(options Options) (app *kingpin.Application, executedCommand string, con
// configure logger for a typical CLI scenario until configuration file is
// parsed
utils.InitLogger(utils.LoggingForDaemon, log.ErrorLevel)
app = utils.InitCLIParser("teleport", "Clustered SSH service. Learn more at https://goteleport.com/teleport")
app = utils.InitCLIParser("teleport", "Teleport Access Plane. Learn more at https://goteleport.com")
// define global flags:
var (

2
tool/tsh/tsh.go
View file

@ -371,7 +371,7 @@ func Run(args []string, opts ...cliOption) error {
moduleCfg := modules.GetModules()
// configure CLI argument parser:
app := utils.InitCLIParser("tsh", "TSH: Teleport Authentication Gateway Client").Interspersed(false)
app := utils.InitCLIParser("tsh", "Teleport Command Line Client").Interspersed(false)
app.Flag("login", "Remote host login").Short('l').Envar(loginEnvVar).StringVar(&cf.NodeLogin)
localUser, _ := client.Username()
app.Flag("proxy", "SSH proxy address").Envar(proxyEnvVar).StringVar(&cf.Proxy)