summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsigoden <sigoden@gmail.com>2023-10-30 19:26:06 +0800
committerGitHub <noreply@github.com>2023-10-30 19:26:06 +0800
commite86ad7dc165ba19fbe01d822a54a9975e4b17862 (patch)
treea9c953d4e48cde477af329fc1434fb7a410213db /README.md
parent42339fac423136fb647c52429d7dd2228144ec98 (diff)
downloadaichat-e86ad7dc165ba19fbe01d822a54a9975e4b17862.tar.gz
feat: add `.info role` and `.info session` (#183)
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 15 insertions, 7 deletions
diff --git a/README.md b/README.md
index 742fe58..48cf2a7 100644
--- a/README.md
+++ b/README.md
@@ -140,12 +140,14 @@ The Chat REPL supports:
```
〉.help
.help Print this help message
-.info Print system-wide information
+.info Print system info
.edit Multi-line editing (CTRL+S to finish)
.model Switch LLM model
.role Use role
+.info role Show role info
.exit role Leave current role
.session Start a context-aware chat session
+.info session Show session info
.exit session End the current session
.set Modify the configuration parameters
.copy Copy the last reply to the clipboard
@@ -156,7 +158,7 @@ Press Ctrl+C to abort readline, Ctrl+D to exit the REPL
```
-### `.info` - view current configuration information
+### `.info` - view information
```
〉.info
@@ -210,19 +212,16 @@ Select a role:
```
〉.role emoji
-name: emoji
-prompt: I want you to translate the sentences I write into emojis. I will write the sentence, and you will express it with emojis. I just want you to express it with emojis. I don't want you to reply with anything but emoji. When I need to tell you something in English, I will do it by wrapping it in curly brackets like {like this}.
-temperature: null
```
-AI takes the role we specified:
+Send message with role:
```
emoji〉hello
👋
```
-Clear current selected role:
+Leave current role:
```
emoji〉.exit role
@@ -231,6 +230,15 @@ emoji〉.exit role
Hello there! How can I assist you today?
```
+Show role info:
+
+```
+emoji〉.info role
+name: emoji
+prompt: I want you to translate the sentences I write into emojis. I will write the sentence, and you will express it with emojis. I just want you to express it with emojis. I don't want you to reply with anything but emoji. When I need to tell you something in English, I will do it by wrapping it in curly brackets like {like this}.
+temperature: null
+```
+
## `.session` - context-aware conversation
By default, aichat behaves in a one-off request/response manner.