client

Documentation

Overview

Package client provides utility functions for gluing new commands easily into sanssh.

Index

• func GenerateSynopsis(c *subcommands.Commander) string
• func GenerateUsage(name string, synopsis string) string
• func SetupSubpackage(name string, f *flag.FlagSet) *subcommands.Commander

Functions

func GenerateSynopsis

func GenerateSynopsis(c *subcommands.Commander) string

GenerateSynopsis will generate a consistent snnopysis for a top level command with N sub-commands contained within it.

func GenerateUsage

func GenerateUsage(name string, synopsis string) string

GenerateUsage will return a usage string to a top level command with N sub-commands contained within it.

func SetupSubpackage

func SetupSubpackage(name string, f *flag.FlagSet) *subcommands.Commander

SetupSubpackage is a helper to create a Commander to hold the actual commands run inside of a top-level command. The returned Commander should then have the relevant sub-commands registered within it.