Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/werifu/complish
Generate auto-completion for any CLI via ChatGPT.
https://github.com/werifu/complish
chatgpt cli fish fish-completion fish-shell typescript typescript-library zsh zsh-completion
Last synced: 4 months ago
JSON representation
Generate auto-completion for any CLI via ChatGPT.
- Host: GitHub
- URL: https://github.com/werifu/complish
- Owner: werifu
- License: mit
- Created: 2023-03-06T15:12:07.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-30T13:58:58.000Z (almost 2 years ago)
- Last Synced: 2024-10-03T07:04:41.728Z (4 months ago)
- Topics: chatgpt, cli, fish, fish-completion, fish-shell, typescript, typescript-library, zsh, zsh-completion
- Language: TypeScript
- Homepage:
- Size: 163 KB
- Stars: 29
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README-zh.md
- License: LICENSE
Awesome Lists containing this project
README
# complish
[English](./README.md) | [简体中文](./README-zh.md)
使用ChatGPT自动生成CLI的自动补全文件
Complish是一款用于为任何类型的CLI生成补全文件的工具，现在支持 __zsh__ 和 __fish__ 。
该工具使用chatGPT API解析CLI的帮助页面（执行`cmd --help`时打印出来的文本）并输出关于帮助页面的结构化信息。然后为特定的shell（如zsh或fish）生成补全脚本。
## 安装
```bash
npm i -g complish
```
需要OpenAI的API密钥，你可以通过设置环境变量或使用下面这条命令来设置密钥：
```bash
export OPENAI_API_KEY=your_openai_api_key
```
或者
```bash
complish set-key your_openai_api_key
```
如果没有密钥，你可以在[OpenAI](https://platform.openai.com/account/api-keys)申请一个，并记得保密！
## 使用
```bash
complish [options] [cmd]
```
### 在fish中的实例
生成名为`mycmd`的CLI的fish补全文件
```bash
complish mycmd --shell fish
```
当脚本执行完毕时，你会发现当前目录中存在`mycmd.fish`文件。
> 注意，执行速度受ChatGPT的响应时间限制，因此生成补全文件可能需要10秒到1分钟或更长时间。
将fish脚本复制到fish shell的补全目录中，即可自动加载文件。其他可用的fish补全目录可以在[这里](https://fishshell.com/docs/current/completions.html)找到
```bash
cp ./croc.fish ~/.config/fish/completions/
```
重新打开终端后，当您按下\时，您会发现补全已经生效!
### 在zsh中的实例
生成名为`mycmd`的CLI的zsh补全文件。
```bash
complish mycmd --shell zsh
```
当脚本执行完成时，你会在当前目录发现一个名为`_mycmd`的zsh-completion格式的文件。然后将zsh补全文件复制到环境变量`$fpath`中的目录中。你可以在zsh中运行`echo $fpath`查看所有有效的目录。
```bash
cp ./_mycmd /Users/you/.zsh/functions
```
重新打开终端后，当您按下\时，您会发现补全已经生效！
## 开发
克隆此存储库。
```bash
git clone https://github.com/werifu/complish.git
```
我使用pnpm来管理依赖项:
安装依赖项:
```bash
pnpm i
```
编译TypeScript代码并运行已编译的JavaScript:
```bash
pnpm build
./dist/index.js
```
或者你可以直接使用ts-node运行它:
```bash
pnpm dev
```
## 贡献
欢迎Pull requests / issues! 请给我您的建议或其他反馈！😊
## TODO
* [ ] 支持bash补全（规划中）
* [ ] 减少API调用次数（此工具的瓶颈）
* [ ] 更详细的参数补全