Installing KFtui

Follow these instructions to install KFtui on your system.

Quick Installation

Unix-like Systems (Linux, macOS, WSL)

Using curl:

bash <(curl -s https://raw.githubusercontent.com/hcavarsan/kftray/main/hacks/kftui_installer.sh)

Using wget:

bash <(wget -qO- https://raw.githubusercontent.com/hcavarsan/kftray/main/hacks/kftui_installer.sh)

Windows Systems

Using PowerShell:

Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/hcavarsan/kftray/main/hacks/kftui_installer.ps1'))

Manual Installation

Direct Downloads

Download the appropriate binary for your system:

Manual Setup Steps

  1. Linux/macOS
    # Make binary executable
    chmod +x kftui_*
    
    # Move to system path
    sudo mv kftui_* /usr/local/bin/kftui
    
  2. Windows
    • Download appropriate .exe
    • Move to desired location
    • Add to system PATH (optional)

Verifying Installation

Run the following command:

kftui --version

Expected output:

KFtui version X.Y.Z

Prerequisites

System Requirements

  • Modern terminal emulator
  • UTF-8 support
  • Minimum terminal size: 80x24
  • Valid kubeconfig setup

Terminal Configuration

  1. Color Support
    • Ensure terminal supports 256 colors
    • Set TERM environment variable:
      export TERM=xterm-256color
      
  2. Font Requirements
    • Monospace font recommended
    • Unicode support required
    • Powerline fonts optional

Environment Setup

Kubernetes Configuration

  1. Kubeconfig
    # Set custom kubeconfig path (optional)
    export KUBECONFIG=~/.kube/config
    
  2. Permissions
    • Verify cluster access
    • Check namespace permissions
    • Test basic kubectl commands

Troubleshooting

Common Issues

  1. Command Not Found
    # Add to PATH manually
    export PATH=$PATH:/usr/local/bin
    
  2. Permission Denied
    # Fix permissions
    chmod +x /usr/local/bin/kftui
    
  3. Terminal Issues
    • Check terminal size
    • Verify color support
    • Update terminal emulator

Installation Logs

Check installation logs:

# Unix-like systems
cat ~/.kftui/install.log

# Windows
type %USERPROFILE%\.kftui\install.log

Updating KFtui

Automatic Update

Run the installer script again:

bash <(curl -s https://raw.githubusercontent.com/hcavarsan/kftray/main/hacks/kftui_installer.sh)

Manual Update

  1. Download new version
  2. Replace existing binary
  3. Verify version number

Uninstallation

Unix-like Systems

# Remove binary
sudo rm /usr/local/bin/kftui

# Remove configuration (optional)
rm -rf ~/.kftui

Windows

  1. Delete executable
  2. Remove from PATH
  3. Delete configuration folder (optional):
    Remove-Item -Recurse -Force $env:USERPROFILE\.kftui
    

Next Steps