consul/command/resource/resource.go

56 lines
1.0 KiB
Go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1
package resource
import (
"github.com/mitchellh/cli"
"github.com/hashicorp/consul/command/flags"
)
func New() *cmd {
return &cmd{}
}
type cmd struct{}
func (c *cmd) Run(args []string) int {
return cli.RunResultHelp
}
func (c *cmd) Synopsis() string {
return synopsis
}
func (c *cmd) Help() string {
return flags.Usage(help, nil)
}
const synopsis = "Interact with Consul's resources"
const help = `
Usage: consul resource <subcommand> [options]
This command has subcommands for interacting with Consul's resources.
Here are some simple examples, and more detailed examples are available
in the subcommands or the documentation.
Read a resource:
$ consul resource read [type] [name] -partition=<default> -namespace=<default> -consistent=<false> -json
Write/update a resource:
$ consul resource apply -f=<file-path>
List resources by type:
$ consul resource list [type] -partition=<default> -namespace=<default>
Run
consul resource <subcommand> -h
for help on that subcommand.
`