Skip to content

Commit 6f8025f

Browse files
committed
docs: add installation instructions to USER GUIDE.md
1 parent 2fc8105 commit 6f8025f

1 file changed

Lines changed: 52 additions & 1 deletion

File tree

docs/USER_GUIDE.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# AgbCloud CLI User Guide
22

33
This guide will walk you through how to use the AgbCloud CLI tool for image management operations.
4-
54
## Table of Contents
65

6+
- [Installation](#installation)
7+
- [Windows](#windows)
8+
- [macOS/Linux](#macoslinux)
9+
- [Uninstallation](#uninstallation)
710
- [Prerequisites](#prerequisites)
811
- [1. Login Authentication](#1-login-authentication)
912
- [2. Create Image](#2-create-image)
@@ -12,6 +15,54 @@ This guide will walk you through how to use the AgbCloud CLI tool for image mana
1215
- [5. List Images](#5-list-images)
1316
- [FAQ](#faq)
1417

18+
## Installation
19+
20+
### Windows
21+
22+
Install AgbCloud CLI using PowerShell:
23+
24+
```powershell
25+
powershell -Command "irm https://agbcloud.github.io/agbcloud-cli/windows | iex"
26+
```
27+
28+
For detailed Windows installation instructions, troubleshooting, and system requirements, see WINDOWS_INSTALL.
29+
30+
### macOS/Linux
31+
32+
Install AgbCloud CLI using Homebrew:
33+
34+
```bash
35+
# 1. Add Agb Cloud's Homebrew tap
36+
brew tap agbcloud/agb
37+
38+
# 2. Install agb command-line tool
39+
brew install agb
40+
41+
# 3. Verify installation
42+
agb version
43+
```
44+
45+
For more details about Homebrew installation, visit the LINUX&MAC_INSTALL.
46+
47+
### Uninstallation
48+
49+
#### Windows
50+
```powershell
51+
# Remove installation directory
52+
Remove-Item -Path "$env:LOCALAPPDATA\agbcloud" -Recurse -Force
53+
```
54+
55+
#### macOS/Linux
56+
```bash
57+
# Uninstall agb
58+
brew uninstall agb
59+
60+
# Remove tap (optional)
61+
brew untap aliyun/agb
62+
```
63+
64+
65+
1566
## Prerequisites
1667

1768
Before getting started, please ensure:

0 commit comments

Comments
 (0)