help.go

// Package help is the help subcommand of the influxd command.
package help

import (
	"fmt"
	"io"
	"os"
	"strings"
)

// Command displays help for command-line sub-commands.
type Command struct {
	Stdout io.Writer
}

// NewCommand returns a new instance of Command.
func NewCommand() *Command {
	return &Command{
		Stdout: os.Stdout,
	}
}

// Run executes the command.
func (cmd *Command) Run(args ...string) error {
	fmt.Fprintln(cmd.Stdout, strings.TrimSpace(usage))
	return nil
}

const usage = `
Tools for managing and querying InfluxDB data.

Usage: influx-tools command [arguments]

The commands are:

    export               reshapes existing shards to a new shard duration
    compact-shard        fully compacts the specified shard
    gen-init             creates database and retention policy metadata 
    gen-exec             generates data
    help                 display this help message

Use "influx-tools command -help" for more information about a command.
`