Skip to content

Commit 27a9378

Browse files
committed
add readme
1 parent c7142ef commit 27a9378

3 files changed

Lines changed: 157 additions & 2 deletions

File tree

README.md

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,52 @@
1-
# gemini-terminal
1+
# Gemini Terminal
2+
[[English]](./README.md) [[中文]](./README_zh.md) [[日本語]](./README_jp.md)
3+
4+
Gemini Terminal is a chat application based on Google AI. You can use it by following the steps below.
5+
6+
![](./628566.gif)
7+
8+
## Installation and Usage
9+
1. Clone this repository
10+
11+
```bash
12+
git clone https://github.com/greycodee/gemini-terminal.git
13+
```
14+
15+
2. Build the project
16+
17+
```bash
18+
cd gemini-terminal && go build .
19+
```
20+
21+
3. Run the project
22+
23+
```bash
24+
./gemini-terminal
25+
```
26+
27+
> Note: You need to set your own Google AI key in the `$HOME/.local/share/gemini/config.ini` file.
28+
29+
## Configuration
30+
The default configuration file is located at `$HOME/.local/share/gemini/config.ini`. You can set your Google AI key and Gemini model name in this file.
31+
```ini
32+
[Gemini]
33+
# set your own google ai key
34+
googleAIKey=
35+
# set gemini model name
36+
model=gemini-pro
37+
[SafetySetting]
38+
# HarmBlockUnspecified HarmBlockThreshold = 0
39+
# HarmBlockLowAndAbove means content with NEGLIGIBLE will be allowed.
40+
# HarmBlockLowAndAbove HarmBlockThreshold = 1
41+
# HarmBlockMediumAndAbove means content with NEGLIGIBLE and LOW will be allowed.
42+
# HarmBlockMediumAndAbove HarmBlockThreshold = 2
43+
# HarmBlockOnlyHigh means content with NEGLIGIBLE, LOW, and MEDIUM will be allowed.
44+
# HarmBlockOnlyHigh HarmBlockThreshold = 3
45+
# HarmBlockNone means all content will be allowed.
46+
# HarmBlockNone HarmBlockThreshold = 4
47+
level=4
48+
```
49+
50+
## Chat History
51+
The default database file is located at `$HOME/.local/share/gemini/gemini.db`. You can view your chat history in this file.
252

3-
![](./628566.gif)

README_ja.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Gemini Terminal
2+
[[English]](./README.md) [[中文]](./README_zh.md) [[日本語]](./README_jp.md)
3+
4+
Gemini TerminalはGoogle AIに基づくチャットアプリケーションです。以下の手順で使用することができます。
5+
6+
![](./628566.gif)
7+
8+
## インストールと使用方法
9+
1. このリポジトリをクローンします
10+
11+
```bash
12+
git clone https://github.com/greycodee/gemini-terminal.git
13+
```
14+
15+
2. プロジェクトをビルドします
16+
17+
```bash
18+
cd gemini-terminal && go build .
19+
```
20+
21+
3. プロジェクトを実行します
22+
23+
```bash
24+
./gemini-terminal
25+
```
26+
27+
> 注意: `$HOME/.local/share/gemini/config.ini` ファイルで自分のGoogle AIキーを設定する必要があります。
28+
29+
## 設定
30+
デフォルトの設定ファイルは `$HOME/.local/share/gemini/config.ini` にあります。このファイルでGoogle AIキーとGeminiモデル名を設定することができます。
31+
```ini
32+
[Gemini]
33+
# 自分のGoogle AIキーを設定します
34+
googleAIKey=
35+
# Geminiモデル名を設定します
36+
model=gemini-pro
37+
[SafetySetting]
38+
# HarmBlockUnspecified HarmBlockThreshold = 0
39+
# HarmBlockLowAndAbove means content with NEGLIGIBLE will be allowed.
40+
# HarmBlockLowAndAbove HarmBlockThreshold = 1
41+
# HarmBlockMediumAndAbove means content with NEGLIGIBLE and LOW will be allowed.
42+
# HarmBlockMediumAndAbove HarmBlockThreshold = 2
43+
# HarmBlockOnlyHigh means content with NEGLIGIBLE, LOW, and MEDIUM will be allowed.
44+
# HarmBlockOnlyHigh HarmBlockThreshold = 3
45+
# HarmBlockNone means all content will be allowed.
46+
# HarmBlockNone HarmBlockThreshold = 4
47+
level=4
48+
```
49+
50+
## チャット履歴
51+
デフォルトのデータベースファイルは `$HOME/.local/share/gemini/gemini.db` にあります。このファイルでチャット履歴を見ることができます。

README_zh.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Gemini Terminal
2+
[[English]](./README.md) [[中文]](./README_zh.md) [[日本語]](./README_jp.md)
3+
4+
Gemini Terminal是一个基于Google AI的终端聊天应用。你可以通过以下步骤来使用它。
5+
6+
![Gemini Terminal](./628566.gif)
7+
8+
## 安装与使用
9+
10+
1. 克隆这个项目
11+
12+
```bash
13+
git clone https://github.com/greycodee/gemini-terminal.git
14+
```
15+
16+
2. 构建项目
17+
18+
```bash
19+
cd gemini-terminal && go build .
20+
```
21+
22+
3. 运行项目
23+
24+
```bash
25+
./gemini-terminal
26+
```
27+
28+
> 注意: 你需要在 `$HOME/.local/share/gemini/config.ini` 文件中设置你自己的Google AI密钥。
29+
30+
## 配置
31+
32+
默认的配置文件位于 `$HOME/.local/share/gemini/config.ini`,你可以在这个文件中设置你的Google AI密钥和Gemini模型名称。
33+
34+
```ini
35+
[Gemini]
36+
# 设置你自己的Google AI密钥
37+
googleAIKey=
38+
# 设置Gemini模型名称
39+
model=gemini-pro
40+
[SafetySetting]
41+
# HarmBlockUnspecified HarmBlockThreshold = 0
42+
# HarmBlockLowAndAbove means content with NEGLIGIBLE will be allowed.
43+
# HarmBlockLowAndAbove HarmBlockThreshold = 1
44+
# HarmBlockMediumAndAbove means content with NEGLIGIBLE and LOW will be allowed.
45+
# HarmBlockMediumAndAbove HarmBlockThreshold = 2
46+
# HarmBlockOnlyHigh means content with NEGLIGIBLE, LOW, and MEDIUM will be allowed.
47+
# HarmBlockOnlyHigh HarmBlockThreshold = 3
48+
# HarmBlockNone means all content will be allowed.
49+
# HarmBlockNone HarmBlockThreshold = 4
50+
level=4
51+
```
52+
53+
## 聊天历史
54+
55+
默认的数据库文件位于 `$HOME/.local/share/gemini/gemini.db`,你可以在这个文件中查看你的聊天历史。

0 commit comments

Comments
 (0)