buraq

Documentation

Index

• Constants
• func AttemptConnection(proto, username, host, password string, port uint, timeout time.Duration) (bool, error)
• func ValidCommands() []string

Constants

const (
	CommandAttackHelp = `` /* 974-byte string literal not displayed */

	CommandHelpHelp = `` /* 321-byte string literal not displayed */

	CommandVersionHelp = `USAGE:
    buraq version

The 'version' command reports the version of buraq in use.`
	CommandEnvHelp = `` /* 166-byte string literal not displayed */

	CommandRepairHelp = `` /* 202-byte string literal not displayed */

	CommandCleanHelp = `USAGE:
    buraq clean

The 'clean' command deletes/removes all binaries compiled and used by buraq.`
)

The help/manuals for each command.

const BannerArt string = `` /* 496-byte string literal not displayed */

BannerArt for the CLI

const HelpScreen string = `` /* 1134-byte string literal not displayed */

HelpScreen lists all command line flags and usage for buraq.

const Version string = "v1.0.0"

Version for the buraq CLI

Functions

func AttemptConnection

func AttemptConnection(proto, username, host, password string, port uint, timeout time.Duration) (bool, error)

AttemptConnection tries to connect to the ssh server using credentials provided.

func ValidCommands

func ValidCommands() []string

ValidCommands that can be provided to the CLI.