package
0.1.2
Repository: https://github.com/specterops/bloodhound_cli.git
Documentation: pkg.go.dev

# Functions

AskForConfirmation asks the user for confirmation.
CheckPath checks the $PATH environment variable for a given "cmd" and return a "bool" indicating if it exists.
Contains checks if a slice of strings ("slice" parameter) contains a given string ("search" parameter).
DirExists determines if a given string is a valid directory.
DownloadFile downloads a file from the specified URL and saves it to the provided filepath.
EvaluateDockerComposeStatus determines if the host has the "docker compose" plugin or the "docker compose" script installed and set the global `dockerCmd` variable.
FetchLogs fetches logs from the container with the specified "name" label ("containerName" parameter).
FileExists determines if a given string is a valid filepath.
GenerateRandomPassword generates a random password of the given length The password will be comprised of a-zA-Z0-9 and !@#$%^&*()_-+=/?<>., Special characters exclude the following: '";:`~\/| Exclusions are to help avoid issues with escaping and breaking quotes in env files.
GetConfig retrieves the specified values from the JSON config file.
GetConfigAll retrieves all values from the JSON config configuration file.
GetCwdFromExe gets the current working directory based on "bloodhound-cli" location.
GetRunning determines if the container with the specified "name" label ("containerName" parameter) is running.
ParseBloodHoundEnvironmentVariables attempts to find and open an existing JSON config file or create a new one.
RunBasicCmd executes a given command ("name") with a list of arguments ("args") and return a "string" with the output.
RunCmd executes a given command ("name") with a list of arguments ("args") and return stdout and stderr buffers.
RunDockerComposeDown executes the "docker compose" commands to bring down the environment with the specified YAML file ("yaml" parameter).
RunDockerComposeInstall executes the "docker compose" commands for a first-time installation with the specified YAML file ("yaml" parameter).
RunDockerComposeRestart executes the "docker compose" commands to restart the environment with the specified YAML file ("yaml" parameter).
RunDockerComposeStart executes the "docker compose" commands to start the environment with the specified YAML file ("yaml" parameter).
RunDockerComposeStop executes the "docker compose" commands to stop all services in the environment with the specified YAML file ("yaml" parameter).
RunDockerComposeUp executes the "docker compose" commands to bring up the environment with the specified YAML file ("yaml" parameter).
RunDockerComposeUpgrade executes the "docker compose" commands for re-building or upgrading an installation with the specified YAML file ("yaml" parameter).
SetConfig sets the value of the specified key in the JSON config file.
WriteBloodHoundEnvironmentVariables writes the environment variables to the JSON config file.

# Structs

Configuration is a custom type for storing configuration values as Key:Val pairs.
Container is a custom type for storing container information similar to output from "docker containers ls".
HealthIssue is a custom type for storing healthcheck output.

# Type aliases

Configurations is a custom type for storing `Configuration` values.
Containers is a collection of Container structs.
No description provided by the author