Skip to content

Commit ca963ea

Browse files
committed
docs(readme): update for /edit, user aliases, and model management changes
1 parent 6832a07 commit ca963ea

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ rullm chat --model claude
2323

2424
# Chat history is saved between sessions.
2525
# Use Alt+Enter for multiline input in chat mode.
26+
# In chat, type /edit to open your $EDITOR and compose a message.
27+
# Press Ctrl+O in chat to open a buffer for editing your prompt directly.
2628

2729
rullm "Tell me a story"
2830
rullm --model gpt4 "Explain quantum computing in detail"
@@ -61,9 +63,12 @@ rullm --system "You are a helpful assistant." "Summarize this text"
6163
### Model Management
6264

6365
```bash
64-
# List available models
66+
# List available models (shows only chat models, with your aliases)
6567
rullm models list
6668

69+
# Update model list for all providers with API keys
70+
rullm models update
71+
6772
# Manage aliases
6873
rullm alias list
6974
rullm alias add my-fast "openai/gpt-3.5-turbo"
@@ -107,18 +112,9 @@ user_prompt = "Please review this code: {{input}}"
107112

108113
- `{{input}}` – Automatically filled with the user's query text.
109114

110-
### Built-in Model Aliases
111-
112-
| Alias | Full Model |
113-
|-------|------------|
114-
| `gpt4` | `openai/gpt-4` |
115-
| `gpt4o` | `openai/gpt-4o` |
116-
| `turbo` | `openai/gpt-3.5-turbo` |
117-
| `claude` | `anthropic/claude-3-5-sonnet-20241022` |
118-
| `sonnet` | `anthropic/claude-3-5-sonnet-20241022` |
119-
| `opus` | `anthropic/claude-3-opus-20240229` |
120-
| `gemini` | `google/gemini-1.5-pro` |
121-
| `gemini-flash` | `google/gemini-1.5-flash` |
115+
### Model Aliases
116+
117+
Model aliases are now user-defined. Use `rullm alias add <alias> <provider/model>` to create your own shortcuts. Use `rullm alias list` to see your aliases.
122118

123119
## Shell Completion
124120

0 commit comments

Comments
 (0)