Skip to content

Commit

Permalink
feat: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yufeikang committed Mar 5, 2023
1 parent 2195cad commit 0951dcd
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 50 deletions.
58 changes: 33 additions & 25 deletions README.ja.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,38 @@
# chatGPTのAIツール

このCLIツールは、コマンドラインでchatGPTを簡単に使用できるようにするためのものです。他の人とチャットすることも、質問に答えてもらうこともできます。また、テキストを翻訳することもできます。さらに、ターミナル
でのマークダウンのレンダリングをサポートしています。

[中文](README.zh.md) | [English](README.md) | [日本語](README.ja.md)
# AIツールfor chatGPT

## 依存関係
このCLIツールは、chatGPTをコマンドラインで簡単に使用できるようにします。チャットすることができ、質問に答えてもらうこともできます。また、テキストの翻訳もサポートしています。そして、端末でのマークダウンのレンダ
リングもサポートしています。

- OPENAI_API_BASE(オプション)
[English](README.md)| [中文](README.zh.md) | [日本語](README.ja.md)

GFWの問題があるため「https://api.openai.com」にアクセスできない場合は、`OPENAI_API_BASE`環境変数で他のAPIのアドレスを指定できます。推奨方法です。これにより、プロキシを使用するよりも安定した状態にすることができます。
dflare Workersを使用してプロキシを構築する方法は、[使用Cloudflare Workers搭建OpenAI API代理](https://github.com/noobnooc/noobnooc/discussions/9)の記事を参照してください。
## 必要なもの

- OPENAI_API_KEY
* OPENAI_API_BASE (オプション)

`OPENAI_API_KEY`環境変数を設定することができます。また、`--api-key`パラメータで指定することもできます。`ai setting`コマンドを使用して設定することもできます。
もしGFWの問題で、`https://api.openai.com`にアクセスできない場合は、他のapiアドレスを`OPENAI_API_BASE`環境変数で指定できます。こちらの方法をお勧めします。プロキシを使うよりも、より安定しています。
Cloudflare workersを使用してプロキシを構築する方法は、この記事を参考にしてください:[使用Cloudflare Workers搭建OpenAI API代理](https://github.com/noobnooc/noobnooc/discussions/9)

* OPENAI_API_KEY

`OPENAI_API_KEY`環境変数を設定するか、`--api-key`パラメータを使用して指定することができます。または、`ai setting`コマンドを使用して設定することもできます。

## インストール

```bash
pip install https://github.com/yufeikang/ai-cli/releases/download/v0.0.1/ai_cli-0.0.1-py3-none-any.whl
pip install py-ai-cli
```

または、最新バージョンをインストールするには

```bash
pip install git+https://github.com/yufeikang/ai-cli.git
```

## 設定

現在、`ai setting`コマンドを使用して、APIキーとAPIベースを設定できます。環境変数とCLIパラメーターもまだ有効です
`ai setting`コマンドを使用してAPIキーとAPIベースを設定できるようになりました。環境変数とCLIパラメータも引き続き有効です

```bash
# settingを確認
Expand All @@ -33,21 +41,21 @@ ai setting
ai setting -e
```

## 使用方法
## 利用

### 質問をする
質問する

```bash
ai ask "こんにちは"
# no stream mode
# no streamモード
ai --no-stream ask "こんにちは"
# help
ai ask --help
```

![](./asset/video/ask.gif)

### 翻訳する
翻訳

```bash
ai translate "こんにちは"
Expand All @@ -57,38 +65,38 @@ echo "こんにちは" | ai translate -t english
cat "file.txt" | ai translate -t english
```

![](./asset/video/translate.gif)
![](./asset/video/translate.gif)

### チャットする
チャットする

```bash
ai chat
```

![](./asset/video/chat.gif)
![](./asset/video/chat.gif)

## プロキシサポート

> OPENAI_API_BASE 正向代理方式更加稳定,推荐使用
> OPENAI_API_BASEを使用する正向きなプロキシ方法がより安定しているため、お勧めします
環境変数`HTTP_PROXY`および`HTTPS_PROXY`または`ALL_PROXY`をサポートしています。また、`--proxy`パラメータを使用してプロキシを指定することもできます
`HTTP_PROXY``HTTPS_PROXY`または`ALL_PROXY`の環境変数をサポートしています。また、`--proxy`パラメーターでプロキシを指定することもできます

例:

```bash
export HTTP_PROXY=http://x.x.x.x:xxxx
# or
# または
export HTTPS_PROXY=https://x.x.x.x:xxxx
```

関数也支持Socks5代理,例如:
また、socks5プロキシもサポートしています。

```bash
export ALL_PROXY=socks5://x.x.x.x:xxxx
```

Socks5プロキシを使用するには`pip install pysocks`をインストールする必要があります。
socks5プロキシを使用するには`pip install pysocks`をインストールする必要があります。

## 追加情報

他のコマンドを確認するには`ai --help`を使用してください。
より多くのコマンドを確認するには`ai --help`を使用してください。
53 changes: 30 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,37 @@

# AI Tools for chatGPT

This CLI tool allows you to conveniently use chatGPT in the command line. You can chat with it, ask it questions, and translate text. It also supports rendering Markdown in the terminal.
This CLI tool allows you to conveniently use chatGPT in the command line. You can chat with it, ask questions, and even have it translate text. It also supports rendering Markdown in the terminal.

[中文](README.zh.md) | [English](README.md) | [日本語](README.ja.md)
[English](README.md) | [中文](README.zh.md) | [日本語](README.ja.md)

## Dependencies

* OPENAI_API_BASE (optional)
* OPENAI_API_BASE (Optional)

If you cannot access `https://api.openai.com` due to the GFW, you can specify an alternative API address using the `OPENAI_API_BASE` environment variable. It is recommended to use this method, which is more reliable
than using proxies. Please refer to this article for how to use Cloudflare Workers to set up a proxy: [使用Cloudflare Workers搭建OpenAI API代理](https://github.com/noobnooc/noobnooc/discussions/9).
If you're unable to access `https://api.openai.com` due to the Great Firewall of China, you can specify an alternate API endpoint using the `OPENAI_API_BASE` environment variable. We recommend using this method as
it is more stable than traditional proxies. Here's an article that explains how to set up a Cloudflare Workers proxy: [Using Cloudflare Workers to Proxy OpenAI
API](https://github.com/noobnooc/noobnooc/discussions/9).

* OPENAI_API_KEY

You can set the `OPENAI_API_KEY` environment variable, or specify it using the `--api-key` parameter. You can also set it using the `ai setting` command.
You can set the `OPENAI_API_KEY` environment variable or specify it using the `--api-key` argument. You can also set it using the `ai setting` command.

## Installation

```bash
pip install https://github.com/yufeikang/ai-cli/releases/download/v0.0.1/ai_cli-0.0.1-py3-none-any.whl
pip install py-ai-cli
```

## Setup
Or install the latest version:

Now you can use the `ai setting` command to set your API key and API base. Environment variables and CLI parameters are still valid.
```bash
pip install git+https://github.com/yufeikang/ai-cli.git
```

## Configuration

You can use the `ai setting` command to set your `api-key` and `api-base`. You can also use environment variables and CLI arguments.

```bash
# view settings
Expand All @@ -36,43 +43,43 @@ ai setting -e

## Usage

Ask questions
Ask a question

```bash
ai ask "你好"
ai ask "Hello"
# no stream mode
ai --no-stream ask "你好"
ai --no-stream ask "Hello"
# help
ai ask --help
```

![](./asset/video/ask.gif)

Translate
Translation

```bash
ai translate "你好"
ai translate "你好" -t japanese
ai translate "Hello"
ai translate "Hello" -t japanese
ai translate -t english -f "file.txt"
echo "你好" | ai translate -t english
echo "Hello" | ai translate -t english
cat "file.txt" | ai translate -t english
```

![](./asset/video/translate.gif)
![](./asset/video/translate.gif)

Chat
Chatting

```bash
ai chat
```

![](./asset/video/chat.gif)
![](./asset/video/chat.gif)

## Proxy Support

> Using a forward proxy for `OPENAI_API_BASE` is more stable, and recommended.
> OPENAI_API_BASE Forward proxy is recommended.
Supports the `HTTP_PROXY` and `HTTPS_PROXY` or `ALL_PROXY` environment variables. You can also specify a proxy using the `--proxy` parameter.
Supports the `HTTP_PROXY` and `HTTPS_PROXY` environment variables, or the `ALL_PROXY` variable. You can also specify a proxy using the `--proxy` argument.

For example:

Expand All @@ -88,8 +95,8 @@ It also supports SOCKS5 proxies, for example:
export ALL_PROXY=socks5://x.x.x.x:xxxx
```

You need to install `pip install pysocks` for SOCKS5 proxies.
SOCKS5 proxies require the installation of `pip install pysocks`

## Additional Information

Please use `ai --help` to see more commands.
Use `ai --help` for more commands.
4 changes: 2 additions & 2 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

这个cli工具可以让你方便的在命令行中使用chatGPT。你可以和他聊天,也可以让他帮你回答问题。也可以帮你翻译文本。并且支持markdown在终端中的渲染。

[中文](README.zh.md) | [English](README.md) | [日本語](README.ja.md)
[English](README.md)| [中文](README.zh.md) | [日本語](README.ja.md)

## 依赖

Expand All @@ -18,7 +18,7 @@
## 安装

```bash
pip install https://github.com/yufeikang/ai-cli/releases/download/v0.0.1/ai_cli-0.0.1-py3-none-any.whl
pip install py-ai-cli
```

或者安装最新版本
Expand Down

0 comments on commit 0951dcd

Please sign in to comment.