From a7be4a3f196ec5ea6f6b5cf0e09bb1ee71776cee Mon Sep 17 00:00:00 2001 From: Jesse Szwedko Date: Sun, 20 Mar 2016 12:18:28 -0700 Subject: [PATCH] Describe category behavior in README --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/README.md b/README.md index 364c964..89de990 100644 --- a/README.md +++ b/README.md @@ -328,6 +328,45 @@ app.Commands = []cli.Command{ ... ``` +### Subcommands categories + +For additional organization in apps that have many subcommands, you can +associate a category for each command to group them together in the help +output. + +E.g. + +```go +... + app.Commands = []cli.Command{ + { + Name: "noop", + }, + { + Name: "add", + Category: "template", + }, + { + Name: "remove", + Category: "template", + }, + } +... +``` + +Will include: + +``` +... +COMMANDS: + noop + + Template actions: + add + remove +... +``` + ### Bash Completion You can enable completion commands by setting the `EnableBashCompletion`