Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ agb image --help
agb -v image create myapp -f ./Dockerfile -i agb-code-space-1
```

For detailed usage instructions and examples, see the [User Guide](docs/USER_GUIDE.md).
For detailed installation steps, usage instructions and examples, see the [User Guide](docs/USER_GUIDE.md).

## License

Expand Down
50 changes: 49 additions & 1 deletion docs/USER_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# AgbCloud CLI User Guide

This guide will walk you through how to use the AgbCloud CLI tool for image management operations.

## Table of Contents

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

## Installation

### Windows

Install AgbCloud CLI using PowerShell:

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

### macOS/Linux

Install AgbCloud CLI using Homebrew:

```bash
# 1. Add Agb Cloud's Homebrew tap
brew tap agbcloud/agb

# 2. Install agb command-line tool
brew install agb

# 3. Verify installation
agb version
```


### Uninstallation

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

#### macOS/Linux
```bash
# Uninstall agb
brew uninstall agb

# Remove tap (optional)
brew untap aliyun/agb
```



## Prerequisites

Before getting started, please ensure:
Expand Down
Loading