summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsigoden <sigoden@gmail.com>2023-10-30 13:36:08 +0800
committerGitHub <noreply@github.com>2023-10-30 13:36:08 +0800
commitba3cc4f15dd4b7457bbcacc64fcdbdbb0362d473 (patch)
tree0689264c52b226c9fe88b1fb6730715a74b5a2a0 /README.md
parent2f9121e515150981ac061389656c33eea577c336 (diff)
downloadaichat-ba3cc4f15dd4b7457bbcacc64fcdbdbb0362d473.tar.gz
feat: deprecate history file (#179)
Diffstat (limited to 'README.md')
-rw-r--r--README.md76
1 files changed, 39 insertions, 37 deletions
diff --git a/README.md b/README.md
index 174e719..a6c4a7e 100644
--- a/README.md
+++ b/README.md
@@ -131,33 +131,12 @@ aichat has a powerful Chat REPL.
The Chat REPL supports:
-- Emacs keybinding
+- Emacs/Vi keybinding
- Command autocompletion
-- History search
-- Fish-style history autosuggestion hints
- Edit/paste multiline input
- Undo support
-### Multi-line input
-
-AIChat supports bracketed paste, so you can paste multi-lines text directly.
-
-AIChat also provides `.edit` command for multi-lines editing.
-
-```
-〉.edit convert json below to toml
-{
- "an": [
- "arbitrarily",
- "nested"
- ],
- "data": "structure"
-}
-```
-
-> Submit the multi-line text with `Ctrl+S`.
-
-### `.help` - Print help message
+### `.help` - print help message
```
〉.help
@@ -171,15 +150,13 @@ AIChat also provides `.edit` command for multi-lines editing.
.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)
-.history Print the REPL history
-.clear history Clear the REPL history
.help Print this help message
.exit Exit the REPL
Press Ctrl+C to abort readline, Ctrl+D to exit the REPL
```
-### `.info` - View current configuration information
+### `.info` - view current configuration information
```
〉.info
@@ -196,7 +173,27 @@ dry_run false
vi_keybindings true
```
-### `.set` - Modify the configuration temporarily
+### `.edit` - multiline editing
+
+AIChat supports bracketed paste, so you can paste multi-lines text directly.
+
+AIChat also provides `.edit` command for multi-lines editing.
+
+```
+〉.edit convert json below to toml
+{
+ "an": [
+ "arbitrarily",
+ "nested"
+ ],
+ "data": "structure"
+}
+```
+
+> Submit the multi-line text with `Ctrl+S`.
+
+
+### `.set` - modify the configuration temporarily
```
〉.set dry_run true
@@ -205,14 +202,17 @@ vi_keybindings true
〉.set temperature 1.2
```
-### `.model` - Choose a model
+
+### `.model` - choose a model
```
> .model openai:gpt-4
> .model localai:gpt4all-j
```
-### `.role` - Let the AI play a role
+> You can easily enter enter model name using autocomplete.
+
+### `.role` - let the AI play a role
Select a role:
@@ -239,7 +239,7 @@ emoji〉.clear role
Hello there! How can I assist you today?
```
-## Session - context-aware conversation
+## `.session` - context-aware conversation
By default, aichat behaves in a one-off request/response manner.
@@ -248,10 +248,10 @@ You should run aichat with `-s/--session` or use the `.session` command to start
```
〉.session
-temp)1 to 5, odd only 4089
+temp)1 to 5, odd only 4089
1, 3, 5
-temp)to 7 4070
+temp)to 7 4070
1, 3, 5, 7
temp).clear session
@@ -260,11 +260,13 @@ temp).clear session
```
```sh
-aichat --list-sessions # List sessions.
-aichat -s # Start with a new temp session.
-aichat -s temp # Reuses previous temp session.
-aichat -s rust # Reuses session named rust. If it does not exist, create a new session named rust.
-aichat -s rust --info # Show session details.
+aichat --list-sessions # List sessions.
+aichat -s # Start REPL with a new temp session
+aichat -s temp # Use temp session
+aichat -s temp --info # Show session details
+aichat -r shell -s # Create a session with a role
+aichat -m openai:gpt-4-32k -s # Create a session with a model
+aichat -s sh unzip a file # Run session in command mode
```
## License