Documentation
¶
Index ¶
- Variables
- func Execute()
- func PrintContainersInfo()
- func PrintDatabaseSummaryForStatus()
- func PrintGitConfigInfo()
- func PrintNetworkInfo()
- func PrintPackageSummary()
- func PrintPortsInfo()
- func PrintRuntimes()
- func PrintSecurityInfo()
- func PrintSystemctlInfo()
- type AIAgent
- type BrowserInfo
- type CPUDetails
- type ContainerInfo
- type DatabaseInfo
- type DiskInfo
- type GPUInfo
- type GitConfigInfo
- type InterfaceInfo
- type NetworkDetails
- type PackageResult
- type PackageSummaryFuture
- type PortInfo
- type RepoInfo
- type RuntimeCheck
- type RuntimeInfo
- type SecurityInfo
- type SystemctlInfo
- type UpdateInfo
- type WiFiInfo
Constants ¶
This section is empty.
Variables ¶
var ( Version = "dev" Commit = "unknown" )
var BootstrapCmd = &cobra.Command{ Use: "bootstrap", Aliases: []string{ "bs", }, Short: "Manage workstation bootstrap configuration", Long: `Manage workstation bootstrap configuration including directories, tools, SSH keys, and dotfiles. Available subcommands: status - Check current bootstrap status install - Apply bootstrap configuration to setup this machine reset - Reset bootstrap configuration`, Run: func(cmd *cobra.Command, args []string) { _ = cmd.Help() }, }
var ContainersCmd = &cobra.Command{ Use: "containers", Short: "Display container and virtualization information", Long: `Display information about containers (Docker, Podman) and virtualization status.`, Run: func(cmd *cobra.Command, args []string) { PrintContainersInfo() }, }
var DbCmd = &cobra.Command{ Use: "db [database]", Short: "Display detected databases and their information", Long: `Display detected database management systems (DBMS) and their information. Shows database clients, versions, running status, and database files. Examples: allbctl status db # Show all detected databases allbctl status db sqlite3 # Show only SQLite3 info allbctl status db postgres # Show only PostgreSQL info allbctl status db --detail # Show detailed info for all databases allbctl status db sqlite3 --detail # Show detailed SQLite3 info with .db files`, Run: func(cmd *cobra.Command, args []string) { if len(args) > 0 { dbName := args[0] showDatabaseInfo(dbName, dbDetailFlag) } else { showAllDatabases(dbDetailFlag) } }, }
DbCmd represents the db command
var GitConfigCmd = &cobra.Command{ Use: "git", Short: "Display git global configuration", Long: `Display git global configuration including user name, email, and editor.`, Run: func(cmd *cobra.Command, args []string) { PrintGitConfigInfo() }, }
var ListPackagesCmd = &cobra.Command{ Use: "list-packages [package-manager]", Short: "Show package count summary from all detected package managers", Long: `Show package count summary from all detected package managers. By default, shows the same summary as the 'Packages:' section in 'allbctl status'. For system package managers (apt, yum, brew, chocolatey, etc.), only explicitly installed packages are counted, not their dependencies. For programming runtime package managers (npm, pip, gem, etc.), only globally installed packages are counted. If a package manager is not detected on the system, it will not be displayed. Use --detail flag to see the full list of all installed packages. You can also specify a specific package manager to list only its packages: allbctl list-packages apt allbctl list-packages npm allbctl list-packages flatpak`, Run: func(cmd *cobra.Command, args []string) { listInstalledPackages(args) }, }
ListPackagesCmd represents the list-packages command
var NetworkCmd = &cobra.Command{ Use: "network", Short: "Display network interface information", Long: `Display network interface information including IP addresses, router, connection type, VPN status, DNS, and connectivity. This is the same output shown in the 'Network:' section of 'allbctl status'.`, Run: func(cmd *cobra.Command, args []string) { PrintNetworkInfo() }, }
var PortsCmd = &cobra.Command{ Use: "ports", Short: "Display listening ports", Long: `Display count of listening TCP/UDP ports and details about what's listening.`, Run: func(cmd *cobra.Command, args []string) { PrintPortsInfo() }, }
var ProjectsCmd = &cobra.Command{ Use: "projects", Short: "Display git repositories in ~/src", Long: `Display a summary of git repositories found in ~/src directory. By default, shows the same summary as the 'Projects:' section in 'allbctl status'. Dirty repos are marked with an asterisk (*). Examples: allbctl status projects # Show summary (default, same as status) allbctl status projects --all # Show all repos allbctl status projects --dirty # Show only dirty repos allbctl status projects --clean # Show only clean repos`, Run: func(cmd *cobra.Command, args []string) { if allFlag || dirtyFlag || cleanFlag { printProjectsSummary() } else { printProjectsInline() } }, }
ProjectsCmd represents the projects command
var RuntimesCmd = &cobra.Command{ Use: "runtimes", Short: "Display detected runtimes and their versions", Long: `Display detected programming language runtimes and their versions. This is the same output shown in the 'Runtimes:' section of 'allbctl status'.`, Run: func(cmd *cobra.Command, args []string) { PrintRuntimes() }, }
var SecurityCmd = &cobra.Command{ Use: "security", Short: "Display security and authentication status", Long: `Display information about SSH keys, GPG keys, and kernel keyring.`, Run: func(cmd *cobra.Command, args []string) { PrintSecurityInfo() }, }
var StatusCmd = &cobra.Command{ Use: "status", Short: "Display system information (like neofetch)", Run: func(cmd *cobra.Command, args []string) { printSystemInfo() }, }
StatusCmd represents status command
var SystemctlCmd = &cobra.Command{ Use: "systemctl", Short: "Display systemd service status", Long: `Display count of running system and user services, and any failed services.`, Run: func(cmd *cobra.Command, args []string) { PrintSystemctlInfo() }, }
Functions ¶
func PrintContainersInfo ¶ added in v0.0.26
func PrintContainersInfo()
func PrintDatabaseSummaryForStatus ¶ added in v0.0.22
func PrintDatabaseSummaryForStatus()
PrintDatabaseSummaryForStatus prints a one-line summary for the main status command
func PrintGitConfigInfo ¶ added in v0.0.26
func PrintGitConfigInfo()
func PrintNetworkInfo ¶ added in v0.0.25
func PrintNetworkInfo()
PrintNetworkInfo outputs comprehensive network information
func PrintPackageSummary ¶ added in v0.0.21
func PrintPackageSummary()
PrintPackageSummary prints package counts for all detected package managers (for status command) This is the synchronous version for backward compatibility
func PrintPortsInfo ¶ added in v0.0.26
func PrintPortsInfo()
func PrintRuntimes ¶ added in v0.0.21
func PrintRuntimes()
PrintRuntimes outputs the runtimes in inline format (same as status command)
func PrintSecurityInfo ¶ added in v0.0.26
func PrintSecurityInfo()
func PrintSystemctlInfo ¶ added in v0.0.26
func PrintSystemctlInfo()
Types ¶
type BrowserInfo ¶ added in v0.0.18
BrowserInfo holds browser information
type CPUDetails ¶ added in v0.0.18
type CPUDetails struct {
ModelName string
Architecture string
Cores int
ThreadsPerCore int
CoresPerSocket int
Sockets int
PhysicalCores int
LogicalCores int
BaseClock string
PCores int
ECores int
HasPECores bool
}
CPUDetails holds detailed CPU information
type ContainerInfo ¶ added in v0.0.26
type DatabaseInfo ¶ added in v0.0.22
type DiskInfo ¶ added in v0.0.27
type DiskInfo struct {
Device string
Mountpoint string
Filesystem string
Total uint64
Used uint64
Free uint64
UsedPercent float64
}
DiskInfo holds detailed disk information
type GPUInfo ¶ added in v0.0.18
type GPUInfo struct {
Name string
Vendor string
Memory string
Driver string
ComputeCap string
ClockGraphics string
ClockMemory string
}
GPUInfo holds detailed GPU information
type GitConfigInfo ¶ added in v0.0.26
type InterfaceInfo ¶ added in v0.0.25
InterfaceInfo holds interface details
type NetworkDetails ¶ added in v0.0.25
type NetworkDetails struct {
Interfaces []InterfaceInfo
VPNActive bool
VPNInterface *InterfaceInfo
PrimaryIface *InterfaceInfo
DefaultGateway string
DNSServers []string
VPNDNSServers []string
PublicIP string
InternetOK bool
WiFiDetails *WiFiInfo
}
NetworkDetails holds comprehensive network information
type PackageResult ¶ added in v0.0.27
PackageResult holds package count results for a single package manager
type PackageSummaryFuture ¶ added in v0.0.27
type PackageSummaryFuture struct {
// contains filtered or unexported fields
}
PackageSummaryFuture represents an ongoing package detection operation
func StartPackageSummary ¶ added in v0.0.27
func StartPackageSummary() *PackageSummaryFuture
StartPackageSummary initiates package detection in the background Returns a future that can be used to retrieve results later
func (*PackageSummaryFuture) PrintResults ¶ added in v0.0.27
func (f *PackageSummaryFuture) PrintResults()
PrintResults waits for all package detection to complete and prints the results
type RepoInfo ¶ added in v0.0.15
type RepoInfo struct {
Path string
ModTime time.Time
Dirty bool
RemoteRepo string // e.g., "aallbrig/allbctl" or "godotengine/godot"
}
RepoInfo contains information about a git repository
type RuntimeCheck ¶ added in v0.0.13
type RuntimeInfo ¶ added in v0.0.13
type SecurityInfo ¶ added in v0.0.26
type SystemctlInfo ¶ added in v0.0.26
type UpdateInfo ¶ added in v0.0.25
UpdateInfo holds information about available updates