Fix daemon synopsis and command grouping (#4249)
This commit is contained in:
7 files changed
+79
-6
No files matched your search
@@ -0,0 +1,57 @@
|
||||
// Copyright (c) HashiCorp, Inc.
|
||||
// SPDX-License-Identifier: BUSL-1.1
|
||||
|
||||
package daemon
|
||||
|
||||
import (
|
||||
"strings"
|
||||
|
||||
"github.com/hashicorp/boundary/internal/cmd/base"
|
||||
"github.com/mitchellh/cli"
|
||||
"github.com/posener/complete"
|
||||
)
|
||||
|
||||
var (
|
||||
_ cli.Command = (*StartCommand)(nil)
|
||||
_ cli.CommandAutocomplete = (*StartCommand)(nil)
|
||||
)
|
||||
|
||||
type DaemonCommand struct {
|
||||
*base.Command
|
||||
}
|
||||
|
||||
func (c *DaemonCommand) Synopsis() string {
|
||||
return "Manages the client side Boundary cache daemon"
|
||||
}
|
||||
|
||||
func (c *DaemonCommand) Help() string {
|
||||
helpText := `
|
||||
Usage: boundary daemon [sub command] [options]
|
||||
|
||||
This command allows interacting with the Boundary daemon.
|
||||
|
||||
Start a daemon:
|
||||
|
||||
$ boundary daemon start
|
||||
|
||||
For a full list of examples, please see the documentation.
|
||||
|
||||
`
|
||||
return strings.TrimSpace(helpText)
|
||||
}
|
||||
|
||||
func (c *DaemonCommand) Flags() *base.FlagSets {
|
||||
return c.FlagSet(base.FlagSetNone)
|
||||
}
|
||||
|
||||
func (c *DaemonCommand) AutocompleteArgs() complete.Predictor {
|
||||
return complete.PredictNothing
|
||||
}
|
||||
|
||||
func (c *DaemonCommand) AutocompleteFlags() complete.Flags {
|
||||
return c.Flags().Completions()
|
||||
}
|
||||
|
||||
func (c *DaemonCommand) Run(args []string) int {
|
||||
return cli.RunResultHelp
|
||||
}
|
||||
@@ -44,7 +44,7 @@ type SearchCommand struct {
|
||||
}
|
||||
|
||||
func (c *SearchCommand) Synopsis() string {
|
||||
return "Search resources in boundary"
|
||||
return "Search Boundary resources using client side cache"
|
||||
}
|
||||
|
||||
func (c *SearchCommand) Help() string {
|
||||
|
||||
@@ -298,7 +298,7 @@ func groupedHelpFunc(f cli.HelpFunc) cli.HelpFunc {
|
||||
typeSpecificCommands := make([]string, 0, len(commands)-cap(genericCommands)-cap(clientCommands))
|
||||
for k := range commands {
|
||||
switch k {
|
||||
case "authenticate", "config", "connect", "dev", "logout", "server":
|
||||
case "authenticate", "config", "connect", "daemon", "dev", "logout", "search", "server":
|
||||
clientCommands = append(clientCommands, k)
|
||||
case "read", "update", "delete":
|
||||
genericCommands = append(genericCommands, k)
|
||||
|
||||
@@ -14,7 +14,11 @@ func init() {
|
||||
clientCacheWrapper = daemonWrap
|
||||
|
||||
extraCommandsFuncs = append(extraCommandsFuncs, func(ui, serverCmdUi cli.Ui, runOpts *RunOptions) {
|
||||
delete(Commands, "daemon")
|
||||
Commands["daemon"] = func() (cli.Command, error) {
|
||||
return &daemon.DaemonCommand{
|
||||
Command: base.NewCommand(ui),
|
||||
}, nil
|
||||
}
|
||||
Commands["daemon start"] = func() (cli.Command, error) {
|
||||
return &daemon.StartCommand{
|
||||
Command: base.NewCommand(ui),
|
||||
|
||||
@@ -16,7 +16,11 @@ func init() {
|
||||
clientCacheWrapper = daemonWrap
|
||||
|
||||
extraCommandsFuncs = append(extraCommandsFuncs, func(ui, serverCmdUi cli.Ui, runOpts *RunOptions) {
|
||||
delete(Commands, "daemon")
|
||||
Commands["daemon"] = func() (cli.Command, error) {
|
||||
return &daemon.DaemonCommand{
|
||||
Command: base.NewCommand(ui),
|
||||
}, nil
|
||||
}
|
||||
Commands["daemon start"] = func() (cli.Command, error) {
|
||||
return &daemon.StartCommand{
|
||||
Command: base.NewCommand(ui),
|
||||
|
||||
@@ -14,7 +14,11 @@ func init() {
|
||||
clientCacheWrapper = daemonWrap
|
||||
|
||||
extraCommandsFuncs = append(extraCommandsFuncs, func(ui, serverCmdUi cli.Ui, runOpts *RunOptions) {
|
||||
delete(Commands, "daemon")
|
||||
Commands["daemon"] = func() (cli.Command, error) {
|
||||
return &daemon.DaemonCommand{
|
||||
Command: base.NewCommand(ui),
|
||||
}, nil
|
||||
}
|
||||
Commands["daemon start"] = func() (cli.Command, error) {
|
||||
return &daemon.StartCommand{
|
||||
Command: base.NewCommand(ui),
|
||||
|
||||
@@ -16,7 +16,11 @@ func init() {
|
||||
clientCacheWrapper = daemonWrap
|
||||
|
||||
extraCommandsFuncs = append(extraCommandsFuncs, func(ui, serverCmdUi cli.Ui, runOpts *RunOptions) {
|
||||
delete(Commands, "daemon")
|
||||
Commands["daemon"] = func() (cli.Command, error) {
|
||||
return &daemon.DaemonCommand{
|
||||
Command: base.NewCommand(ui),
|
||||
}, nil
|
||||
}
|
||||
Commands["daemon start"] = func() (cli.Command, error) {
|
||||
return &daemon.StartCommand{
|
||||
Command: base.NewCommand(ui),
|
||||
|
||||
Reference in new issue
Block a user