diff options
| author | sigoden <sigoden@gmail.com> | 2023-03-06 13:00:43 +0800 |
|---|---|---|
| committer | sigoden <sigoden@gmail.com> | 2023-03-06 13:00:43 +0800 |
| commit | 0874cecba81150b50e69dc8813e78d1db9864fbc (patch) | |
| tree | d5d5afed5d41151eafbacd7a696d3a11cb1dd550 /README.md | |
| parent | 281e15cbd12f2bb238d6a10ba04233927ea4e958 (diff) | |
| download | aichat-0874cecba81150b50e69dc8813e78d1db9864fbc.tar.gz | |
chore: update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 53 |
1 files changed, 27 insertions, 26 deletions
@@ -22,14 +22,14 @@ Download from [Github Releases](https://github.com/sigoden/aichat/releases), unz ## Features -- [x] Powerful REPL -- [x] Predefine AI roles -- [x] Add GPT prompt -- [x] Markdown highlight -- [x] Stream output -- [x] Multiline input -- [x] Proxy support -- [x] Save chat messages +- Predefine AI [roles](#roles) +- Use GPT prompt easily +- Powerful [Chat REPL](#chat-repl) +- Markdown highlight +- Stream output +- Multiline input +- Proxy support +- Save chat messages ## Config @@ -53,23 +53,7 @@ highlight: true # optional, Set false to turn highlight proxy: "socks5://127.0.0.1:1080" # optional, set proxy server. e.g. http://127.0.0.1:8080 or socks5://127.0.0.1:1080 ``` -> You can customize the configuration directory through `$AICHAT_CONFIG_DIR` - -Use the `.info` command to get current configuration information. - -``` -〉.info -config_file /home/alice/.config/aichat/config.yaml -roles_file /home/alice/.config/aichat/roles.yaml -messages_file /home/alice/.config/aichat/messages.md -role - -api_key sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -temperature - -save true -highlight true -proxy - -dry_run false -``` +> You can specify the configuration directory through `$AICHAT_CONFIG_DIR` ### Roles @@ -122,7 +106,7 @@ aichat calculate 25.6 + 32.5 ``` ```sh -aichat -r bash flip the image horizontally +aichat -r shell flip the image horizontally ``` Enter Chat REPL if no text input. @@ -174,6 +158,23 @@ Type ".help" for more information. Press Ctrl+C to abort session, Ctrl+D to exit the REPL ``` +- View current configuration information. + +``` +〉.info +config_file /home/alice/.config/aichat/config.yaml +roles_file /home/alice/.config/aichat/roles.yaml +messages_file /home/alice/.config/aichat/messages.md +role - +api_key sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +temperature - +save true +highlight true +proxy - +dry_run false +``` + + - Modify the configuration temporarily ``` |