1package command
2
3import (
4	"strings"
5
6	"github.com/mitchellh/cli"
7)
8
9type AllocCommand struct {
10	Meta
11}
12
13func (f *AllocCommand) Help() string {
14	helpText := `
15Usage: nomad alloc <subcommand> [options] [args]
16
17  This command groups subcommands for interacting with allocations. Users can
18  inspect the status, examine the filesystem or logs of an allocation.
19
20  Examine an allocations status:
21
22      $ nomad alloc status <alloc-id>
23
24  Stream a task's logs:
25
26      $ nomad alloc logs -f <alloc-id> <task>
27
28  Please see the individual subcommand help for detailed usage information.
29`
30
31	return strings.TrimSpace(helpText)
32}
33
34func (f *AllocCommand) Synopsis() string {
35	return "Interact with allocations"
36}
37
38func (f *AllocCommand) Name() string { return "alloc" }
39
40func (f *AllocCommand) Run(args []string) int {
41	return cli.RunResultHelp
42}
43