Skip to content

Commit 974c7d2

Browse files
committed
docs: document install script usage in all language READMEs
- Add installation instructions for using an install script in English, Simplified Chinese, and Traditional Chinese READMEs - Update documentation outlines to include the new install script section in all languages - Explain install script steps: automatic OS/architecture detection, downloading the latest binary, and adding it to PATH Signed-off-by: appleboy <[email protected]>
1 parent d186027 commit 974c7d2

File tree

3 files changed

+63
-0
lines changed

3 files changed

+63
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ English | [繁體中文](./README.zh-tw.md) | [简体中文](./README.zh-cn.md)
1616
- [Installation](#installation)
1717
- [macOS](#macos)
1818
- [Windows](#windows)
19+
- [Using install script](#using-install-script)
1920
- [Pre-compiled Binaries](#pre-compiled-binaries)
2021
- [From Source](#from-source)
2122
- [Using vscode devcontainer](#using-vscode-devcontainer)
@@ -82,6 +83,26 @@ Install via [Chocolatey](https://chocolatey.org/install):
8283
choco install codegpt
8384
```
8485

86+
### Using install script
87+
88+
```sh
89+
# Download and run the install script
90+
curl -sSL https://raw.githubusercontent.com/appleboy/CodeGPT/main/install.sh | bash
91+
```
92+
93+
Or download and run manually:
94+
95+
```sh
96+
chmod +x install.sh
97+
./install.sh
98+
```
99+
100+
The script will:
101+
102+
1. Detect your OS and architecture
103+
2. Download the latest binary
104+
3. Add the binary to your PATH
105+
85106
### Pre-compiled Binaries
86107

87108
Download the pre-compiled binaries from the [release page](https://github.com/appleboy/CodeGPT/releases). Change the binary permissions to `755` and copy the binary to the system bin directory. Use the `codegpt` command as shown below:

README.zh-cn.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- [目录](#目录)
1515
- [功能](#功能)
1616
- [安装](#安装)
17+
- [使用安装脚本](#使用安装脚本)
1718
- [从源码安装](#从源码安装)
1819
- [使用 VSCode Devcontainer](#使用-vscode-devcontainer)
1920
- [配置](#配置)
@@ -71,6 +72,26 @@ brew install codegpt
7172
choco install codegpt
7273
```
7374

75+
### 使用安装脚本
76+
77+
```sh
78+
# 下载并执行安装脚本
79+
curl -sSL https://raw.githubusercontent.com/appleboy/CodeGPT/main/install.sh | bash
80+
```
81+
82+
或手动下载后执行:
83+
84+
```sh
85+
chmod +x install.sh
86+
./install.sh
87+
```
88+
89+
该脚本会自动:
90+
91+
1. 检测您的操作系统和架构
92+
2. 下载最新版二进制文件
93+
3. 将程序加入 PATH
94+
7495
可以从 [发布页面](https://github.com/appleboy/CodeGPT/releases) 下载预编译的二进制文件。将二进制文件权限更改为 `755` 并将其复制到系统 bin 目录。使用如下所示的 `codegpt` 命令。
7596

7697
```sh

README.zh-tw.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
- [安裝](#安裝)
1717
- [macOS](#macos)
1818
- [Windows](#windows)
19+
- [使用安裝腳本](#使用安裝腳本)
1920
- [預編譯二進制文件](#預編譯二進制文件)
2021
- [從源碼安裝](#從源碼安裝)
2122
- [使用 VSCode Devcontainer](#使用-vscode-devcontainer)
@@ -82,6 +83,26 @@ brew install codegpt
8283
choco install codegpt
8384
```
8485

86+
### 使用安裝腳本
87+
88+
```sh
89+
# 下載並執行安裝腳本
90+
curl -sSL https://raw.githubusercontent.com/appleboy/CodeGPT/main/install.sh | bash
91+
```
92+
93+
或手動下載後執行:
94+
95+
```sh
96+
chmod +x install.sh
97+
./install.sh
98+
```
99+
100+
此腳本會自動:
101+
102+
1. 偵測您的作業系統與架構
103+
2. 下載最新版二進位檔案
104+
3. 將程式加入 PATH
105+
85106
### 預編譯二進制文件
86107

87108
[release 頁面](https://github.com/appleboy/CodeGPT/releases) 下載預編譯的二進制文件。將二進制文件的權限更改為 `755`,並將二進制文件複製到系統 bin 目錄。使用如下所示的 `codegpt` 命令:

0 commit comments

Comments
 (0)