Add help command

Author: alebeck

README.md

@@ -42,6 +42,7 @@ Usage:
   boring close, c                Close tunnels (same options as 'open')
   boring edit, e                 Edit the configuration file
   boring version, v              Show the version number
+  boring help, h                 Show this help message
 ```
 
 ## Configuration

cmd/boring/main.go

@@ -54,6 +54,8 @@ func main() {
 		editConfig()
 	case "version", "v":
 		printVersion()
+	case "help", "h":
+		printUsage()
 	default:
 		log.Printf("Unknown command: %v\n\n", os.Args[1])
 		printUsage()
@@ -102,4 +104,5 @@ func printUsage() {
 	log.Printf("  boring close, c                Close tunnels (same options as 'open')\n")
 	log.Printf("  boring edit, e                 Edit the configuration file\n")
 	log.Printf("  boring version, v              Show the version number\n")
+	log.Printf("  boring help, h                 Show this help message\n")
 }

completions/boring.bash

@@ -3,7 +3,7 @@ _boring() {
     cur="${COMP_WORDS[COMP_CWORD]}"
     prev="${COMP_WORDS[COMP_CWORD-1]}"
 
-    local commands=("open" "close" "list" "edit" "version")
+    local commands=("open" "close" "list" "edit" "version" "help")
 
     _boring_get_names() {
         local status="$1"

completions/boring.fish

@@ -34,7 +34,7 @@ function __boring_complete
     set arguments (commandline -opc)[3..-1]
 
     if test (count $command) -eq 0
-        printf "%s\n" open close list edit version
+        printf "%s\n" open close list edit version help
         return
     end
 

completions/boring.zsh

@@ -8,6 +8,7 @@ _boring() {
         "list"
         "edit"
         "version"
+        "help"
     )
 
     _boring_get_names() {

test/e2e/usage_test.go

@@ -5,7 +5,7 @@ import (
 	"testing"
 )
 
-func TestUsage(t *testing.T) {
+func TestUsagePlain(t *testing.T) {
 	env, err := makeDefaultEnv(t)
 	if err != nil {
 		t.Fatalf("%v", err.Error())
@@ -23,13 +23,31 @@ func TestUsage(t *testing.T) {
 	}
 }
 
-func TestUsageWithCommand(t *testing.T) {
+func TestUsageHelp(t *testing.T) {
 	env, err := makeDefaultEnv(t)
 	if err != nil {
 		t.Fatalf("%v", err.Error())
 	}
 
-	c, out, err := cliCommand(env, "help") // or any other unknown command
+	c, out, err := cliCommand(env, "help")
+	if err != nil {
+		t.Fatalf("failed to run CLI command: %v", err)
+	}
+	if c != 0 {
+		t.Fatalf("exit code %d: %v", c, err)
+	}
+	if !strings.Contains(out, "Usage:") {
+		t.Errorf("output did not contain usage information: %s", out)
+	}
+}
+
+func TestUsageUnknownCommand(t *testing.T) {
+	env, err := makeDefaultEnv(t)
+	if err != nil {
+		t.Fatalf("%v", err.Error())
+	}
+
+	c, out, err := cliCommand(env, "foo") // or any other unknown command
 	if err != nil {
 		t.Fatalf("failed to run CLI command: %v", err)
 	}
@@ -39,7 +57,8 @@ func TestUsageWithCommand(t *testing.T) {
 	if !strings.Contains(out, "Usage:") {
 		t.Errorf("output did not contain usage information: %s", out)
 	}
-	if !strings.Contains(out, "Unknown command: help") {
+	if !strings.Contains(out, "Unknown command: foo") {
 		t.Errorf("output did not contain unknown command warning: %s", out)
 	}
 }
+