Skip to content
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: 1 addition & 1 deletion pkg/cmd/application/application.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ func NewApplicationCmd(f *cmdutil.Factory) *cobra.Command {
cmd := &cobra.Command{
Use: "application",
Aliases: []string{"app"},
Short: "Manage your Algolia applications",
Short: "Create, select, and manage your Algolia applications",
}

cmd.AddCommand(create.NewCreateCmd(f))
Expand Down
8 changes: 7 additions & 1 deletion pkg/cmd/describe/describe.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ func NewDescribeCmd(f *cmdutil.Factory) *cobra.Command {
Use: "describe [command] [subcommand]...",
Aliases: []string{"schema"},
Args: cobra.ArbitraryArgs,
Short: "Describe commands and flags as JSON.",
Short: "Print the full command and flag tree as JSON, for scripting and discovery",
// Describe only walks the command tree; it needs no credentials and
// must work on a machine with nothing configured.
Annotations: map[string]string{
Expand All @@ -46,6 +46,9 @@ func NewDescribeCmd(f *cmdutil.Factory) *cobra.Command {
Long: heredoc.Doc(`
Describe the CLI's command tree in a machine-readable format.
With no arguments, this command describes the root command.

Use it to discover every command, subcommand, and flag without
crawling the --help pages one by one.
`),
Example: heredoc.Doc(`
# Describe the root command
Expand All @@ -56,6 +59,9 @@ func NewDescribeCmd(f *cmdutil.Factory) *cobra.Command {

# Describe the objects browse command
$ algolia describe objects browse

# List every top-level command
$ algolia describe | jq '.command.subCommands[].name'
`),
RunE: func(cmd *cobra.Command, args []string) error {
opts.CommandPath = args
Expand Down
2 changes: 1 addition & 1 deletion pkg/cmd/indices/index.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ func NewIndicesCmd(f *cmdutil.Factory) *cobra.Command {
cmd := &cobra.Command{
Use: "indices",
Aliases: []string{"index"},
Short: "Manage your Algolia indices",
Short: "List, copy, move, clear, and delete indices",
}

cmd.AddCommand(list.NewListCmd(f))
Expand Down
2 changes: 1 addition & 1 deletion pkg/cmd/objects/objects.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (
func NewObjectsCmd(f *cmdutil.Factory) *cobra.Command {
cmd := &cobra.Command{
Use: "objects",
Short: "Add, update, and delete records",
Short: "Import, browse, add, update, and delete records",
Aliases: []string{"records"},
}

Expand Down
1 change: 1 addition & 0 deletions pkg/cmd/root/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ func NewRootCmd(f *cmdutil.Factory) *cobra.Command {
SilenceUsage: true,
SilenceErrors: true,
Example: heredoc.Doc(`
$ algolia auth login
$ algolia search MOVIES --query "toy story"
$ algolia objects browse MOVIES
$ algolia apikeys create --acl search
Expand Down
2 changes: 1 addition & 1 deletion pkg/cmd/settings/settings.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (
func NewSettingsCmd(f *cmdutil.Factory) *cobra.Command {
cmd := &cobra.Command{
Use: "settings",
Short: "Manage your Algolia index settings.",
Short: "Manage your Algolia index settings",
}

cmd.AddCommand(get.NewGetCmd(f))
Expand Down
Loading