allbctl

command module
v0.0.26 Latest Latest
Warning

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

 Go to latest Published: Jan 9, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

README

allbctl

allbctl is short for allbrightctl and represents a command line interface for computer operations that I (Andrew Allbright) do. This is meant to be a CLI that is used by myself.

📚 Full Documentation - Complete guide with installation, commands, and examples

Quick Start

Download the latest release for your platform:

Or build from source (requires Go 1.20+):

make build

Docs

# Help
allbctl --help

# System status (like neofetch, but better!)
allbctl status                     # Shows comprehensive system information:
allbctl cs status                  # Same as above (alias)
                                   # - User@hostname header with separator
                                   # - OS, kernel, uptime, host/virtualization info
                                   # - Package counts (dpkg, rpm, flatpak, snap, brew, etc.)
                                   # - Shell, terminal, detailed CPU and GPU info, memory
                                   # - Disks (count and total space)
                                   # - Network interfaces and connection type
                                   # - Ports (listening TCP/UDP ports count)
                                   # - Installed browsers (Chrome, Firefox, Edge, Safari, Brave, etc.)
                                   # - Computer setup status (dotfiles, directories, tools)

# Status subcommands (show specific sections from status output)
allbctl status runtimes            # Shows detected development runtimes with versions:
                                   # Example: Python (3.12.3), Node.js (24.11.1), Go (1.25.5)

allbctl status projects            # Shows summary: count and last 5 recently touched repos
allbctl status projects --all      # Shows all git repos in ~/src
allbctl status projects --dirty    # Shows only repos with uncommitted changes
allbctl status projects --clean    # Shows only clean repos
                                   # Dirty repos are marked with * (e.g., "~/src/myproject*")

allbctl status list-packages       # Summary: just show counts per package manager (default)
allbctl status list-packages --detail  # Full listing of all packages
allbctl status list-packages -d    # Short version of --detail
allbctl status list-packages apt   # List only apt packages (shows command for copy/paste)
allbctl status list-packages apt --detail  # List apt packages + last 5 installed with timestamps
allbctl status list-packages npm   # List only npm packages (shows command for copy/paste)
allbctl status list-packages npm --detail  # List npm packages + last 5 installed with timestamps
allbctl status list-packages pip --detail  # List pip packages + last 5 installed with timestamps
allbctl status list-packages flatpak # List only flatpak packages (shows command for copy/paste)
allbctl status list-packages vagrant # List only vagrant VMs (shows command for copy/paste)

allbctl status network             # Enhanced network information with VPN detection
                                    # Shows primary interface, WiFi details, VPN status, DNS, 
                                    # connectivity check, and public IP

allbctl status db                  # Shows detected database systems (SQLite, MySQL, PostgreSQL, etc.)
allbctl status db postgres --detail # Show detailed PostgreSQL info with files and env vars

allbctl status containers          # Shows container runtime info (Docker, Podman) and virtualization status

allbctl status security            # Shows SSH keys, GPG keys, and kernel keyring info

allbctl status systemctl           # Shows systemd service counts (running, failed)

allbctl status git                 # Shows git global configuration (user.name, user.email, core.editor)

allbctl status ports               # Shows listening TCP/UDP ports with details

# Computer setup (bootstrap development environment)
allbctl computer-setup status      # Check what's set up and what's missing
allbctl computer-setup install     # Install/configure dev environment automatically
allbctl cs status                  # Short alias for status
allbctl cs install                 # Short alias for install

# What computer-setup does:
# ✅ Ensures ~/src directory exists
# ✅ **Automatically installs git** (cross-platform: apt/dnf/yum/pacman/zypper/apk on Linux, brew on macOS, winget/choco/scoop on Windows)
# ✅ **Automatically installs GitHub CLI (gh)** (cross-platform package manager support)
# ✅ **Generates SSH keys** (if missing) and **registers them with GitHub** automatically
# ✅ **Clones dotfiles** from https://github.com/aallbrig/dotfiles to ~/src/dotfiles
# ✅ Runs dotfiles install script (./fresh.sh) which sets up:
#    - oh-my-zsh
#    - Symlinks for .zshrc, .gitconfig, .vimrc, .tmux.conf, .ssh/config
#    - zsh as default shell (on Linux)
# ✅ Checks tools referenced in shell config files (.zshrc, .bashrc, etc.)
#    - Detects commands in $(command), source <(command), which/command -v, eval patterns
#    - Shows which tools are INSTALLED (green) vs MISSING (red)
#    - Groups by config file with $HOME path notation
# ✅ **Fully cross-platform** - Works on Linux, macOS, and Windows
# ✅ **Idempotent** - Safe to run multiple times, only installs what's missing

Features

System Status

The status and cs status commands provide a neofetch-inspired view of your system:

  • User@Hostname Header: Shows current user and machine name with separator line
  • OS Information: Platform, version, architecture, kernel version
  • System Details: Host/virtualization info, uptime
  • Package Counts: Inline display of packages from detected package managers (dpkg, rpm, pacman, snap, flatpak, brew, choco, winget)
  • CPU Information: Detailed CPU details including:
    • Model name and architecture (x86_64, arm64, etc.)
    • Base clock speed (when available)
    • Physical vs logical cores with threads per core
    • Cores per socket and socket count
    • P-cores and E-cores for Apple Silicon (when available)
  • GPU Information: Detailed GPU information including:
    • GPU name and vendor (NVIDIA, AMD, Intel, Apple, Microsoft)
    • Memory size (when available)
    • Driver version (when available)
    • Compute capability for NVIDIA GPUs
    • Clock speeds (graphics and memory) for NVIDIA GPUs
    • Supports nvidia-smi for NVIDIA GPUs and fallback to platform-specific detection (lspci on Linux, system_profiler on macOS, wmic on Windows)
  • Memory: Total installed memory (e.g., "33.3 GiB")
  • Runtimes: Detected programming languages with versions (e.g., "Python (3.12.3), Node.js (24.11.1), Go (1.25.5)")
    • NEW: Shows available updates with arrow notation (e.g., "Node.js (24.11.1 → 24.12.0 (LTS))")
    • NEW: Highlights LTS versions for Node.js and Java
  • Databases: Detected databases with versions (e.g., "sqlite3 (3.45.1)")
    • NEW: Shows version information with update arrows
  • Network: Network interfaces, router IP, connection type, and VPN status
    • NEW: Enhanced formatting with colons for readability
    • NEW: VPN detection and status (e.g., "VPN: ✓ Active (tun0)")
    • NEW: Available as enhanced subcommand: allbctl status network
      • Primary Interface: Shows main interface with WiFi details (SSID, frequency, signal strength, speed)
      • VPN Status: Prominently displays active VPN tunnels with gateway info
      • DNS Configuration: System and VPN DNS servers separately
      • Connectivity: Internet check and public IP address
      • WiFi Quality: Signal strength with quality rating (Excellent/Good/Fair/Poor)
      • Other Interfaces: All other network interfaces with status
  • Browsers: Detected web browsers with versions (e.g., "Chrome (143.0.7499.109), Firefox (146.0), Edge (143.0.3650.80)")
    • Supports Chrome, Chromium, Firefox, Edge, Safari, Brave, Opera, Vivaldi
    • Cross-platform detection for Linux, macOS, and Windows
    • Only displays browsers that are actually installed
  • AI Agents: Detected AI coding assistants with versions (e.g., "copilot (0.0.365), claude (2.0.76)")
    • Infrastructure ready for update detection
  • Package Managers:
    • System: System package managers with versions (e.g., "apt (2.8.3), flatpak (1.14.6)")
    • Language: Language version managers with versions (e.g., "nvm (0.40.3), pyenv (2.3.0)")
    • Runtime: Runtime package managers with versions (e.g., "npm (11.6.2 → 11.7.0), pip (24.0)")
    • NEW: Shows available updates with arrow notation where applicable
  • Packages: Summary of installed packages per package manager with update information
    • Shows package counts and available updates (e.g., "apt: 1969 packages (34 want updates)")
    • Supported package managers: apt, flatpak, snap, dnf, yum, pacman, brew, choco, winget, npm, pip, pipx
    • Only displays update counts when updates are available
    • NEW: Parallelized update checks for faster performance
  • Projects: Git repositories in ~/src shown as X total (Y dirty) with:
    • Last 5 recently touched repos in a table format
    • Three aligned columns: path (with * for dirty), remote origin (user/repo), and last modified date/time
  • Computer Setup Status: Dotfiles location, required directories, installed tools, SSH configuration
Supported Browsers

The status command detects the following web browsers:

  • Chrome (google-chrome, chromium)
  • Firefox (firefox)
  • Edge (microsoft-edge)
  • Safari (macOS only, via /Applications/Safari.app)
  • Brave (brave-browser)
  • Opera (opera)
  • Vivaldi (vivaldi)

Browser detection works across all platforms (Linux, macOS, Windows) and only displays browsers that are actually installed on your system.

Supported AI Agents

The status command detects the following AI coding assistants:

  • GitHub Copilot CLI (copilot)
  • Claude Code (claude)
  • Cursor AI (cursor)
  • Aider (aider)
  • Continue.dev (continue)
  • Cody (Sourcegraph) (cody)
  • Tabby (tabby)
  • Ollama (ollama)
  • Amazon CodeWhisperer (codewhisperer)
Supported Language Version Managers

The status command detects the following language version managers:

  • NVM (Node Version Manager) (nvm)
  • pyenv (Python) (pyenv)
  • rbenv (Ruby) (rbenv)
  • jenv (Java) (jenv)
  • rustup (Rust) (rustup)
  • asdf (Universal version manager) (asdf)
  • SDKMAN (Software Development Kit Manager) (sdkman)
Package Management

Multi-platform package detection supporting:

  • Linux: dpkg, rpm, apt, dnf, yum, pacman, snap, flatpak, zypper, apk, nix, homebrew
  • macOS: homebrew, macports, nix
  • Windows: chocolatey, winget, scoop, plus WSL package managers
  • Runtime: npm, pip, pipx, gem, cargo, composer, maven, gradle, go (all platforms)
  • Virtualization: vagrant (cross-platform VM management)
Supported Package Managers
Package Manager Linux macOS Windows Type
apt ✅ ❌ ❌ System
dpkg ✅ ❌ ❌ System
rpm ✅ ❌ ❌ System
dnf ✅ ❌ ❌ System
yum ✅ ❌ ❌ System
pacman ✅ ❌ ❌ System
snap ✅ ❌ ❌ System
flatpak ✅ ❌ ❌ System
brew ✅ ✅ ❌ System
choco ❌ ❌ ✅ System
winget ❌ ❌ ✅ System
scoop ❌ ❌ ✅ System
npm ✅ ✅ ✅ Runtime
pip ✅ ✅ ✅ Runtime
pipx ✅ ✅ ✅ Runtime
gem ✅ ✅ ✅ Runtime
cargo ✅ ✅ ✅ Runtime
go ✅ ✅ ✅ Runtime
vagrant ✅ ✅ ✅ Virtualization

Usage:

  • allbctl list-packages - Summary of all detected package managers
  • allbctl list-packages <manager> - List packages for a specific manager (e.g., apt, npm, flatpak, vagrant)
    • Displays the underlying command for easy copy/paste (e.g., "Command: apt-mark showmanual")
  • allbctl list-packages --detail - Full listing of all packages from all managers
Computer Setup Automation

Fully automate bootstrapping a new development machine with dotfiles and essential tools.

Features:

  • Cross-platform tool installation: Automatically installs git and GitHub CLI using native package managers
    • Linux: apt, dnf, yum, pacman, zypper, apk
    • macOS: Homebrew
    • Windows: winget, chocolatey, scoop
  • SSH key management: Generates SSH keys if missing and automatically registers them with GitHub
  • Creates required directories (~/src, ~/bin)
  • Dotfiles integration: Clones your dotfiles repo to ~/src/dotfiles and runs install script
  • Shell Config Tool Detection: Automatically scans your shell configuration files (.zshrc, .bashrc, .bash_profile, .profile) to find tool dependencies
    • Extracts commands from: $(command), `command`, source <(command), which command, command -v, eval "$(command)"
    • Reports which tools are INSTALLED (green) vs MISSING (red)
    • Groups output by config file with $HOME paths for portability
    • Filters out common shell builtins to focus on external tools
    • OS-agnostic: works on Linux, macOS, and Windows
  • Idempotent operations: Safe to run multiple times, only installs what's missing

Bootstrapping a New Machine

On a fresh machine (Linux, macOS, or Windows), you can bootstrap your dev environment:

# 1. Download the latest release from GitHub
# Visit https://github.com/aallbrig/allbctl/releases/latest
# Download the appropriate binary for your platform:
#   - allbctl-linux-amd64 for Linux
#   - allbctl-darwin-amd64 for macOS (Intel)
#   - allbctl-darwin-arm64 for macOS (Apple Silicon)
#   - allbctl-windows-amd64.exe for Windows
# Make it executable (Linux/macOS): chmod +x allbctl-*
# Move to your PATH (e.g., ~/bin or /usr/local/bin)

# 2. Check your system status
allbctl status

# 3. Check what needs to be set up
allbctl cs status

# 4. Run the automated setup
allbctl cs install

# The tool will automatically:
# - Install git if not present (using your system's package manager)
# - Install GitHub CLI if not present
# - Generate SSH keys if missing
# - Register your SSH keys with GitHub (requires 'gh auth login' first)
# - Create ~/src directory if needed
# - Clone your dotfiles repo to ~/src/dotfiles
# - Run the dotfiles install script (./fresh.sh)
# - All operations are idempotent - safe to run multiple times

Additional Commands

Runtimes Detection

The runtimes command detects programming languages, databases, cloud tools, and gaming platforms installed on your system:

allbctl runtimes

Detects:

  • Programming Languages: Node.js, Go, PHP, Java, Python, Ruby, Rust, Perl, R, Scala, Kotlin, Swift, Elixir, Erlang, Haskell, Lua, Dart, Zig, C#
  • Version Managers: nvm, pyenv, rbenv, jenv, rustup, sdkman, asdf
  • Gaming Platforms: Steam (cross-platform detection for Linux, macOS, and Windows)
  • SQL Databases: MySQL, PostgreSQL, SQLite, MariaDB, SQL Server, Oracle
  • NoSQL Databases: MongoDB, Redis, Cassandra
  • Kubernetes & Cloud: kubectl, AWS CLI, Azure CLI, Google Cloud SDK
  • HashiCorp Tools: Terraform, Vault, Consul, Nomad

Gaming Platform Detection: Steam is detected across platforms by checking:

  • Linux: Command-line steam in PATH, ~/.steam/steam.sh, ~/.local/share/Steam/steam.sh, /usr/bin/steam, /usr/games/steam
  • macOS: /Applications/Steam.app, ~/Applications/Steam.app
  • Windows: Windows Registry (HKCU\Software\Valve\Steam), C:\Program Files (x86)\Steam\steam.exe, C:\Program Files\Steam\steam.exe
Projects Management

The projects command helps you track git repositories in your ~/src directory:

allbctl projects              # Summary: count + last 5 recently touched repos
allbctl projects --all        # Show all repos
allbctl projects --dirty      # Show only repos with uncommitted changes
allbctl projects --clean      # Show only clean repos

Features:

  • Recursive discovery: Finds all git repositories in ~/src, including nested repos
  • Dirty status tracking: Repos with uncommitted changes are marked with *
  • Remote origin display: Shows the user/repo from git remote (e.g., aallbrig/allbctl)
  • Last modified timestamp: Displays when each repo was last touched
  • Recent activity: Sorted by modification time (most recent first)
  • Integrated into status: The allbctl status command includes a Projects section showing:
    • Total repo count and number of dirty repos
    • Last 5 recently touched repos with dirty indicators, remote origin, and timestamps
    • Helps catch uncommitted work that might be forgotten

Example output:

Total repos: 4 (3 dirty)

Last 5 recently touched:
  ~/src/allbctl*           aallbrig/allbctl           2025-12-22 17:09
  ~/src/dice-gnome-redux*  aallbrig/dice-gnome-redux  2025-12-21 11:50
  ~/src/godot-mcp          Coding-Solo/godot-mcp      2025-12-20 11:19
  ~/src/dotfiles*          aallbrig/dotfiles          2025-12-16 21:18

The output is formatted as a table with three aligned columns:

  • Column 1: Repository path with * for uncommitted changes
  • Column 2: Remote origin (user/repo) extracted from git remote URL
  • Column 3: Last modified date and time

The summary shows total repos with dirty count in parentheses: 4 (3 dirty)

This feature is particularly useful for developers juggling multiple projects to quickly see which repos have uncommitted work.

Reset Configuration

The reset command resets your machine configuration:

allbctl reset

This will display system information and reset the computer setup configuration to its initial state.

Testing

Windows VM Testing

To test allbctl on Windows 10 using Vagrant:

# Build Windows binary
make build-windows

# Start Windows 10 VM
vagrant up windows10

# The VM will boot with GUI - log in and open PowerShell
# Test the bootstrap sequence:
cd C:\allbctl-test
.\allbctl.exe bootstrap status    # Check initial state
.\allbctl.exe bootstrap install   # Install components
.\allbctl.exe bootstrap status    # Verify installation

# Cleanup
vagrant halt windows10      # Stop VM
vagrant destroy windows10   # Remove VM

See test/windows-vm-test.md for detailed testing instructions.

Contributing

Please reference the CONTRIBUTING.md file.

Documentation

Overview

Copyright © 2020 Andrew Allbright

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Source Files

View all Source files

Directories

Path Synopsis
pkg
computersetup
computersetup/dotfiles
computersetup/providers
externalapi
externalcmd
model
osagnostic
status

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.