Skip to content

README.md

Latest commit

 

History

History
240 lines (181 loc) · 5.65 KB

README.md

File metadata and controls

240 lines (181 loc) · 5.65 KB

AgbCloud CLI Windows Installation Guide

This guide provides instructions for installing AgbCloud CLI on Windows using PowerShell.

Table of Contents

Prerequisites

Before installing AgbCloud CLI, please ensure:

  • Windows 10 or later (Windows Server 2016 or later)
  • PowerShell 5.1 or later (PowerShell 7+ recommended)
  • Internet connection
  • Administrator privileges (recommended for PATH configuration)

Installation

Quick Installation

Install AgbCloud CLI with a single PowerShell command:

powershell -Command "irm https://agbcloud.github.io/agbcloud-cli/windows | iex"

Installation Process

The installation script will:

  1. Detect system architecture (amd64/arm64)
  2. Download the latest version from GitHub Releases
  3. Create installation directory (%LOCALAPPDATA%\agbcloud by default)
  4. Install the binary as agb.exe
  5. Update PATH environment variable (user-level)
  6. Verify installation automatically

Verification

After installation, verify that AgbCloud CLI is installed correctly:

Step 1: Restart PowerShell

# Close current PowerShell window and open a new one
Start-Process powershell -Verb RunAs; exit
# Or refresh the environment variables
$env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User")

Step 2: Check Installation

# Check if agb command is available
agb --version

Expected Output:

AgbCloud CLI version 1.0.0
Git commit: abc1234
Build date: 2025-01-15T10:30:00Z

Step 3: Verify Command Help

# Display help information
agb --help

Expected Output:

Command line interface for AgbCloud services

Usage:
  agb [command]

Available Commands:
  image       Manage images
  login       Log in to AgbCloud
  logout      Log out from AgbCloud
  version     Show version information
  help        Help about any command

Flags:
  -h, --help      help for agb
  -v, --verbose   Enable verbose output

Use "agb [command] --help" for more information about a command.

Step 4: Test Core Functionality

# Test image command
agb image --help

# Test version command
agb version

Usage

Basic Commands

# Show help
agb --help

# Show version
agb version

# Login to AgbCloud
agb login

# List available images
agb image list

# Create a custom image
agb image create myImage --dockerfile ./Dockerfile --imageId agb-code-space-1

# Activate an image
agb image activate img-7a8b9c1d0e

# Deactivate an image
agb image deactivate img-7a8b9c1d0e

Enable Verbose Output

# Use -v flag for detailed output
agb -v image list
agb --verbose login

Troubleshooting

Common Issues

Issue 1: Command Not Found

# Error: 'agb' is not recognized as an internal or external command

Solutions:

  1. Restart PowerShell or refresh environment variables:

    $env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User")

  2. Check installation directory:

    Get-ChildItem "$env:LOCALAPPDATA\agbcloud"

Issue 2: Installation Failed

# Error: Failed to download AgbCloud CLI

Solutions:

  1. Check internet connection
  2. Try running the installation command again
  3. Use manual download from GitHub Releases if needed

Issue 3: Permission Denied

# Error: Access denied or execution policy restriction

Solutions:

  1. Run as Administrator:

    # Right-click PowerShell and select "Run as Administrator"

  2. Check execution policy:

    Get-ExecutionPolicy
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Getting Help

If you encounter issues:

  1. Check the installation log for error messages
  2. Verify system requirements (Windows version, PowerShell version)
  3. Try manual installation from GitHub Releases
  4. Contact support with error details and system information

Uninstallation

To remove AgbCloud CLI:

Step 1: Remove Binary

# Remove installation directory
Remove-Item -Path "$env:LOCALAPPDATA\agbcloud" -Recurse -Force

Step 2: Clean PATH

# Remove from user PATH
$agbPath = "$env:LOCALAPPDATA\agbcloud"
$currentPath = [Environment]::GetEnvironmentVariable("Path", "User")
$newPath = ($currentPath.Split(';') | Where-Object { $_ -ne $agbPath }) -join ';'
[Environment]::SetEnvironmentVariable("Path", $newPath, "User")

Step 3: Verify Removal

# This should return an error
agb --version

Additional Information

System Requirements

  • OS: Windows 10/11, Windows Server 2016+
  • Architecture: x64 (amd64) or ARM64
  • PowerShell: 5.1+ (7+ recommended)
  • Disk Space: ~50MB
  • Network: Internet connection for download

Installation Locations

  • Default: %LOCALAPPDATA%\agbcloud\agb.exe

Links

Note: This installation method downloads the latest stable release. For development versions or specific releases, please visit the GitHub Releases page.