Skip to content

Commit 93818c2

Browse files
committed
auto-coder: refactor README installation and language links
- Add emoji flags to language links in README.md - Simplify and left-align the main title in README.md - Update installation instructions to prioritize Homebrew installation - Add direct download options for packages and binaries - Include shell completion details for Bash, ZSH, Fish, and PowerShell - Remove redundant installation steps and streamline instructions - Add collapsible sections for shell completion details - Apply consistent changes across all language versions of the README Signed-off-by: codiing-hui <wecoding@yeah.net>
1 parent f4f9d13 commit 93818c2

File tree

3 files changed

+100
-28
lines changed

3 files changed

+100
-28
lines changed

README.md

Lines changed: 36 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
1-
Language : [us](./README.md) | [🇨🇳](./README_zh.md) | [ja](./README_ja.md)
1+
Language : [🇺🇸 us](./README.md) | [🇨🇳 zh](./README_zh.md) | [🇯🇵 ja](./README_ja.md)
22

3-
<h1 align="center">AI-Terminal</h1>
4-
5-
<div align="center">
3+
# AI-Terminal
64

75
AI-Terminal is an advanced AI-powered CLI that enhances terminal workflows through AI-driven automation and
86
optimization. It efficiently manages tasks such as file management, data processing, and system diagnostics.
97

10-
</div>
11-
12-
138
## Key Features
149

1510
- **Contextual Assistance:** Learns from user commands to provide syntax suggestions.
@@ -26,23 +21,50 @@ optimization. It efficiently manages tasks such as file management, data process
2621

2722
### Installation
2823

29-
To install AI-Terminal, follow these steps:
24+
Install using Homebrew:
25+
26+
```bash
27+
brew install coding-hui/tap/ai-terminal
28+
```
3029

31-
1. Ensure you have Go version v1.22.0 or higher installed.
32-
2. Build and install the Go binary:
30+
Or, download it:
31+
32+
- [Packages][releases] are available in Debian and RPM formats
33+
- [Binaries][releases] are available for Linux, macOS, and Windows
34+
35+
[releases]: https://github.com/coding-hui/ai-terminal/releases
36+
37+
Or, build from source (requires Go 1.22+):
3338

3439
```sh
3540
make build
3641
```
3742

38-
This command will generate the binary file at `./bin/ai` for Unix-based systems or `./bin/ai.exe` for Windows.
39-
40-
3. Initialize the AI model configuration:
41-
43+
Then initialize configuration:
4244
```sh
4345
ai configure
4446
```
4547

48+
<details>
49+
<summary>Shell Completions</summary>
50+
51+
All packages and archives come with pre-generated completion files for Bash,
52+
ZSH, Fish, and PowerShell.
53+
54+
If you built it from source, you can generate them with:
55+
56+
```bash
57+
ai completion bash -h
58+
ai completion zsh -h
59+
ai completion fish -h
60+
ai completion powershell -h
61+
```
62+
63+
If you use a package (like Homebrew, Debs, etc), the completions should be set
64+
up automatically, given your shell is configured properly.
65+
66+
</details>
67+
4668
### Usage
4769

4870
Here are some examples of how to use AI-Terminal, grouped by functionality:

README_ja.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,48 @@ AI-ターミナルは、AI駆動の自動化と最適化を通じてターミナ
1818

1919
### インストール
2020

21-
AI-ターミナルをインストールするには、以下の手順に従ってください
21+
Homebrewを使用してインストール
2222

23-
1. Goバージョンv1.22.0以上がインストールされていることを確認します。
24-
2. Goバイナリをビルドしてインストールします:
23+
```bash
24+
brew install coding-hui/tap/ai-terminal
25+
```
26+
27+
または直接ダウンロード:
28+
29+
- [パッケージ][releases] Debian および RPM 形式で提供
30+
- [バイナリ][releases] Linux、macOS、Windows 用
31+
32+
[releases]: https://github.com/coding-hui/ai-terminal/releases
33+
34+
またはソースからビルド(Go 1.22+ が必要):
2535

2636
```sh
2737
make build
2838
```
2939

30-
このコマンドは、Unixベースのシステムでは`./bin/ai`、Windowsでは`./bin/ai.exe`にバイナリファイルを生成します。
31-
32-
3. AIモデルの設定を初期化します:
33-
40+
設定を初期化:
3441
```sh
3542
ai configure
3643
```
3744

45+
<details>
46+
<summary>シェル補完</summary>
47+
48+
すべてのパッケージとアーカイブには、Bash、ZSH、Fish、PowerShell 用の事前生成された補完ファイルが含まれています。
49+
50+
ソースからビルドした場合、以下のコマンドで生成できます:
51+
52+
```bash
53+
ai completion bash -h
54+
ai completion zsh -h
55+
ai completion fish -h
56+
ai completion powershell -h
57+
```
58+
59+
パッケージ(Homebrew、Debs など)を使用する場合、シェルの設定が正しければ補完は自動的に設定されます。
60+
61+
</details>
62+
3863
### 使用方法
3964

4065
AI-ターミナルの使用例を機能別に紹介します:

README_zh.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,48 @@ AI-终端是一个先进的AI驱动的CLI,通过AI驱动的自动化和优化
1818

1919
### 安装
2020

21-
要安装AI-终端,请按照以下步骤操作
21+
使用 Homebrew 安装
2222

23-
1. 确保您已安装Go版本v1.22.0或更高版本。
24-
2. 构建并安装Go二进制文件:
23+
```bash
24+
brew install coding-hui/tap/ai-terminal
25+
```
26+
27+
或者直接下载:
28+
29+
- [软件包][releases] 提供 Debian 和 RPM 格式
30+
- [二进制文件][releases] 适用于 Linux、macOS 和 Windows
31+
32+
[releases]: https://github.com/coding-hui/ai-terminal/releases
33+
34+
或者从源码编译(需要 Go 1.22+):
2535

2636
```sh
2737
make build
2838
```
2939

30-
此命令将在 `./bin/ai` 路径下生成二进制文件,如果是Windows系统,则路径为 `./bin/ai.exe`
31-
32-
3. 初始化AI模型配置:
33-
40+
然后初始化配置:
3441
```sh
3542
ai configure
3643
```
3744

45+
<details>
46+
<summary>Shell 自动补全</summary>
47+
48+
所有软件包和压缩包都包含预生成的 Bash、ZSH、Fish 和 PowerShell 的自动补全文件。
49+
50+
如果从源码构建,可以使用以下命令生成:
51+
52+
```bash
53+
ai completion bash -h
54+
ai completion zsh -h
55+
ai completion fish -h
56+
ai completion powershell -h
57+
```
58+
59+
如果使用软件包(如 Homebrew、Debs 等),只要 shell 配置正确,自动补全应该会自动设置。
60+
61+
</details>
62+
3863
### 使用
3964

4065
以下是一些使用AI-终端的示例,按功能分组:

0 commit comments

Comments
 (0)