# aoi

**Repository Path**: github_syn/aoi

## Basic Information

- **Project Name**: aoi
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-01
- **Last Updated**: 2025-11-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Aoi (葵)

由 OpenAI 驱动的 Ghost in the Shell

使用 Aoi，可以在终端中与 AI 进行自然语言对话，它能够理解您的查询并执行适当的命令。

## 功能
 Aoi 可以用作 ChatGPT 的终端版本，此外，Aoi 还带有几个内置功能提高使用效率：

- `/code` - 生成代码片段并复制到剪贴板，例如 `/code go generate random numbers`
- `/db` - 自动导入数据库表结构，生成 SQL 并在数据库上执行，例如 `/db postgres://user:passwd@host/db list tables`
- `/shell` - 生成 shell 命令并执行，例如 `/shell view listening ports`
- `/ssh` - 生成远程 shell 命令并执行，例如 `/ssh {host} view listening tcp ports`\
- `/summary` - 对URL内容进行总结，在指定语音的情况下翻译输出的内容`/summary {url}` `/summary cn {url}`
- `/tldr` - 获取命令的 tl;dr 格式的解释
- `/trans` - 将文本翻译为指定语言
- `/copy` - 复制上一条回复

## 入门指南
可以从 GitHub 的[发布页面](https://github.com/shellfly/aoi/releases)下载 Aoi。或者，可以使用 Go 在系统上安装 Aoi：

```bash
go install github.com/shellfly/aoi@latest
```
### OpenAI API Key
将 OpenAI API 密钥设置为环境变量，然后运行 aoi 命令。

```bash

export OPENAI_API_KEY=<your_api_key>

aoi
```

### OpenAI API Base URL
如有需要，也可自定义 OpenAI API BASE URL 为环境变量。

```bash
export OPENAI_API_BASE_URL=<your_custom_api_base_url>
```

### Azure OpenAI
使用Azure的环境变量，并且传递`azure.deployment`参数来使用Azure OpenAI 服务

```
export OPENAI_API_KEY={azure openai secret}
export OPENAI_API_BASE_URL={azure openai endpoint}

aoi -azure.deployment {model deployment name}
```

## 演示
### shell
[![shell](/doc/shell.gif)](https://asciinema.org/a/XjCGaMNf8Qp2nQ1UDlehjm5AN)

### database
[![pg](/doc/pg.gif)](https://asciinema.org/a/568712)

## 贡献
如果在使用 Aoi 时发现任何问题或有新功能的建议，请在 GitHub 存储库上创建问题或提交拉取请求。