raid

package

v0.2.2-beta Latest Latest Go to latest Published: Mar 16, 2026 License: GPL-3.0 Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/8bitalex/raid

Links

Open Source Insights

Documentation ¶

Overview ¶

The primary interface for the raid CLI tool functionality.

Lifecycle:

Initialize: set up the raid environment, including loading configurations and initializing data storage.
Compile: compile the raid configurations and prepare them for execution.
Execute: run the raid commands based on the compiled configurations.
Shutdown: gracefully shut down the raid environment, ensuring all resources are released and saved.

Related packages:

`raid/profile`: provides the core functionality for loading and managing profiles
`raid/repo`: provides the core functionality for loading and managing repositories
`raid/env`: provides the core functionality for loading and managing environments

Index ¶

Constants
Variables
func ExecuteCommand(name string) error
func ForceLoad() error
func GetCommands() []lib.Command
func GetProperty(name Property) (string, error)
func Initialize()
func Install(maxThreads int) error
func Load() error
type Environment
type Finding
- func Doctor() []Finding
type Property
type Severity

Constants ¶

View Source

const (
	RaidConfigFileName  = lib.RaidConfigFileName
	ConfigPathFlag      = lib.ConfigPathFlag
	ConfigPathFlagDesc  = lib.ConfigPathFlagDesc
	ConfigPathFlagShort = lib.ConfigPathFlagShort
	ConfigPathDefault   = lib.ConfigPathDefault
	ConfigDirName       = lib.ConfigDirName
	ConfigFileName      = lib.ConfigFileName
)

View Source

const (
	SeverityOK    = lib.SeverityOK
	SeverityWarn  = lib.SeverityWarn
	SeverityError = lib.SeverityError
)

View Source

const (
	PropertyVersion     = resources.PropertyVersion
	PropertyEnvironment = resources.PropertyEnvironment
)

View Source

const (
	EnvironmentDevelopment = resources.EnvironmentDevelopment
	EnvironmentPreview     = resources.EnvironmentPreview
	EnvironmentProduction  = resources.EnvironmentProduction
)

Variables ¶

View Source

var ConfigPath = &lib.CfgPath

Pointer to the configuration path

Functions ¶

func ExecuteCommand ¶

func ExecuteCommand(name string) error

ExecuteCommand runs the named command from the active profile.

func ForceLoad ¶

func ForceLoad() error

Force load the raid configurations for execution. Ignores cache.

func GetCommands ¶

func GetCommands() []lib.Command

GetCommands returns all commands available in the active profile.

func GetProperty ¶

func GetProperty(name Property) (string, error)

GetProperty returns the value of the named property from app.properties.

func Initialize ¶

func Initialize()

Initialize the raid environment, including loading configurations and initializing data storage.

func Install ¶

func Install(maxThreads int) error

Install the active profile

func Load ¶

func Load() error

Load the raid configurations for execution. Uses cached results if available.

Types ¶

type Environment ¶

type Environment = resources.Environment

Environment identifies the runtime environment the binary was built for.

type Finding ¶

type Finding = lib.Finding

Finding represents the result of a single Doctor check.

func Doctor ¶

func Doctor() []Finding

Doctor performs all configuration checks and returns the findings.

type Property ¶

type Property = resources.Property

Property identifies a key in app.properties.

type Severity ¶

type Severity = lib.Severity

Severity indicates the importance of a Doctor finding.

Source Files ¶

View all Source files

raid.go

Directories ¶

Path	Synopsis
env Manage raid environments.	Manage raid environments.
profile Manage raid profiles.	Manage raid profiles.

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