utils

package
v0.4.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 11, 2025 License: MIT Imports: 21 Imported by: 1

Documentation

Index

Constants

View Source
const (
	CodeAuthMFARequired = "auth_mfa_required"
)

Variables

View Source
var Version string = "dev"

Functions

func Blue

func Blue(value string) string

Blue converts a string to blue color in the console with bold text.

func BoolPointerToString

func BoolPointerToString(value *bool) string

func BuildURL

func BuildURL(basePath, relativePath string, params map[string]string) string

func CliError

func CliError(msg string, args ...interface{})

CliError handles all error messages in the CLI.

func CliInfo

func CliInfo(msg string, args ...interface{})

CliInfo handles all informational messages in the CLI.

func CliInfoWithExit

func CliInfoWithExit(msg string, args ...interface{})

CliInfoWithExit prints an informational message to stderr and exits the program with a status code of 0

func CliWarning

func CliWarning(msg string, args ...interface{})

CliWarning handles all warning messages in the CLI.

func CommandConfirm added in v0.4.4

func CommandConfirm() bool

CommandConfirm prompts the user for confirmation to continue executing a command. It returns true if the user enters "y" or "yes" (case-insensitive), and false otherwise.

func CreateAndEditTempFile

func CreateAndEditTempFile(data []byte) (string, error)

func DeleteFile

func DeleteFile(path string) error

func ExtractWorkspaceName added in v0.4.0

func ExtractWorkspaceName(workspaceURL string) string

ExtractWorkspaceName extracts workspace name from workspace URL

func FormatSSHTarget added in v0.4.0

func FormatSSHTarget(target SSHTarget) string

FormatSSHTarget formats an SSHTarget back into a string representation

func GetCLIVersion

func GetCLIVersion() string

func GetUserAgent

func GetUserAgent() string

func Green

func Green(value string) string

Green converts a string to green color in the console with bold text.

func IsInteractiveShell added in v0.4.4

func IsInteractiveShell() bool

IsInteractiveShell checks if the current program is running in an interactive terminal.

func IsLocalTarget added in v0.4.0

func IsLocalTarget(target string) bool

IsLocalTarget checks if a target string represents a local location

func IsRemoteTarget added in v0.4.0

func IsRemoteTarget(target string) bool

IsRemoteTarget checks if a target string represents a remote location A target is considered remote if it contains a colon (:)

func IsUUID

func IsUUID(str string) bool

func ParseErrorResponse added in v0.4.0

func ParseErrorResponse(err error) (code, source string)

func PrettyJSON

func PrettyJSON(data []byte) (*bytes.Buffer, error)

func PrintHeader

func PrintHeader(header string)

func PrintJson

func PrintJson(body []byte)

func PrintTable

func PrintTable(slice interface{})

func ProcessEditedData

func ProcessEditedData(originalData []byte) (interface{}, error)

ProcessEditedData facilitates user modifications to original data, formats it, supports editing via a temp file, compares the edited data against the original, and parses it into JSON. If no changes are made, the update is aborted and an error is returned.

func PromptForBool

func PromptForBool(prompt string) bool

func PromptForInput

func PromptForInput(promptText string) string

func PromptForIntInput

func PromptForIntInput(promptText string, defaultValue int) int

func PromptForListInput

func PromptForListInput(promptText string) []string

func PromptForPassword

func PromptForPassword(promptText string) string

func PromptForRequiredInput

func PromptForRequiredInput(promptText string) string

func PromptForRequiredIntInput

func PromptForRequiredIntInput(promptText string) int

func PromptForRequiredListInput

func PromptForRequiredListInput(promptText string) []string

func ReadFileFromPath

func ReadFileFromPath(filePath string) ([]byte, error)

func Red

func Red(value string) string

Red converts a string to red color in the console with bold text.

func RemovePrefixBeforeAPI

func RemovePrefixBeforeAPI(url string) string

func SaveFile

func SaveFile(fileName string, data []byte) error
func ShowLogo()

func SplitAndParseInt

func SplitAndParseInt(input string) []int

func SplitPath

func SplitPath(path string) (string, string)

func TimeFormat

func TimeFormat(value int) *string

func TimeUtils

func TimeUtils(t time.Time) string

func TruncateString

func TruncateString(str string, num int) string

func Unzip

func Unzip(src string, dest string) error

func Yellow

func Yellow(value string) string

Yellow converts a string to yellow color in the console with bold text.

func Zip

func Zip(folderPath string) ([]byte, error)

Types

type ErrorResponse added in v0.4.0

type ErrorResponse struct {
	Code   string `json:"code"`
	Source string `json:"source"`
}

type SSHTarget added in v0.4.0

type SSHTarget struct {
	User string // Username (empty if not specified)
	Host string // Hostname/server name
	Path string // Path (empty if not specified)
}

SSHTarget represents a parsed SSH-like target with user, host, and path components

func ParseSSHTarget added in v0.4.0

func ParseSSHTarget(target string) SSHTarget

ParseSSHTarget parses SSH-like target strings and returns the components Supports formats: - host - user@host - host:path - user@host:path

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL