summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsigoden <sigoden@gmail.com>2023-10-30 14:17:15 +0800
committerGitHub <noreply@github.com>2023-10-30 14:17:15 +0800
commit23e9fb5bbf96cd4a93f4150659a99b4055623b9f (patch)
treee59e4b093516df206afe3242cfffc8762f64050a /README.md
parentba3cc4f15dd4b7457bbcacc64fcdbdbb0362d473 (diff)
downloadaichat-23e9fb5bbf96cd4a93f4150659a99b4055623b9f.tar.gz
feat: deprecate .clear command (#180)
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 22 insertions, 22 deletions
diff --git a/README.md b/README.md
index a6c4a7e..ad4f591 100644
--- a/README.md
+++ b/README.md
@@ -140,20 +140,21 @@ The Chat REPL supports:
```
〉.help
+.help Print this help message
.info Print system-wide information
-.set Modify the configuration temporarily
-.model Choose a model
-.role Select a role
-.clear role Clear the currently selected role
-.session Start a session
-.clear session End current session
-.copy Copy the last output to the clipboard
-.read Read the contents of a file and submit
.edit Multi-line editing (CTRL+S to finish)
-.help Print this help message
+.model Switch LLM model
+.role Use role
+.exit role Leave current role
+.session Start a context-aware chat session
+.exit session End the current session
+.set Modify the configuration parameters
+.copy Copy the last reply to the clipboard
+.read Import from file and submit
.exit Exit the REPL
Press Ctrl+C to abort readline, Ctrl+D to exit the REPL
+
```
### `.info` - view current configuration information
@@ -190,17 +191,7 @@ AIChat also provides `.edit` command for multi-lines editing.
}
```
-> Submit the multi-line text with `Ctrl+S`.
-
-
-### `.set` - modify the configuration temporarily
-
-```
-〉.set dry_run true
-〉.set highlight false
-〉.set save false
-〉.set temperature 1.2
-```
+> Submit with `Ctrl+S`.
### `.model` - choose a model
@@ -233,7 +224,7 @@ emoji〉hello
Clear current selected role:
```
-emoji〉.clear role
+emoji〉.exit role
〉hello
Hello there! How can I assist you today?
@@ -254,7 +245,7 @@ temp)1 to 5, odd only
temp)to 7 4070
1, 3, 5, 7
-temp).clear session
+temp).exit session
〉
```
@@ -269,6 +260,15 @@ aichat -m openai:gpt-4-32k -s # Create a session with a model
aichat -s sh unzip a file # Run session in command mode
```
+### `.set` - modify the configuration temporarily
+
+```
+〉.set temperature 1.2
+〉.set dry_run true
+〉.set highlight false
+〉.set save false
+```
+
## License
Copyright (c) 2023 aichat-developers.