Ellama is a tool for interacting with large language models from Emacs. It allows you to ask questions and receive responses from the LLMs. Ellama can perform various tasks such as translation, code review, summarization, enhancing grammar/spelling or wording and more through the Emacs interface. Ellama natively supports streaming output, making it effortless to use with your preferred text editor.
The name “ellama” is derived from “Emacs Large LAnguage Model Assistant”. Previous sentence was written by Ellama itself.
Just M-x package-install Enter ellama
Enter. By default it uses
ollama provider and
zephyr model. If you ok with it,
you need to install ollama
and pull zephyr like this:
ollama pull zephyrYou can use ellama with other model or other llm provider.
In that case you should customize ellama configuration like this:
;; YOU DON'T NEED NONE OF THIS CODE FOR SIMPLE INSTALL
;; IT IS AN EXAMPLE OF CUSTOMIZATION.
(use-package ellama
:init
;; setup key bindings
(setopt ellama-keymap-prefix "C-c e")
;; language you want ellama to translate to
(setopt ellama-language "German")
;; could be llm-openai for example
(require 'llm-ollama)
(setopt ellama-provider
(make-llm-ollama
;; this model should be pulled to use it
;; value should be the same as you print in terminal during pull
:chat-model "mistral:7b-instruct-v0.2-q6_K"
:embedding-model "mistral:7b-instruct-v0.2-q6_K"))
;; Predefined llm providers for interactive switching.
;; You shouldn't add ollama providers here - it can be selected interactively
;; without it. It is just example.
(setopt ellama-providers
'(("zephyr" . (make-llm-ollama
:chat-model "zephyr:7b-beta-q6_K"
:embedding-model "zephyr:7b-beta-q6_K"))
("mistral" . (make-llm-ollama
:chat-model "mistral:7b-instruct-v0.2-q6_K"
:embedding-model "mistral:7b-instruct-v0.2-q6_K"))
("mixtral" . (make-llm-ollama
:chat-model "mixtral:8x7b-instruct-v0.1-q3_K_M-4k"
:embedding-model "mixtral:8x7b-instruct-v0.1-q3_K_M-4k"))))
;; Naming new sessions with llm
(setopt ellama-naming-provider
(make-llm-ollama
:chat-model "mistral:7b-instruct-v0.2-q6_K"
:embedding-model "mistral:7b-instruct-v0.2-q6_K"))
(setopt ellama-naming-scheme 'ellama-generate-name-by-llm)
;; Translation llm provider
(setopt ellama-translation-provider (make-llm-ollama
:chat-model "sskostyaev/openchat:8k"
:embedding-model "nomic-embed-text")))Ask Ellama about something by entering a prompt in an interactive
buffer and continue conversation. If called with universal argument
(C-u) will start new session with llm model interactive selection.
Ask Ellama about a selected region or the current buffer.
Send selected region or current buffer to ellama chat.
Send current line to ellama chat.
Complete text in current buffer with ellama.
Ask Ellama to translate a selected region or word at the point.
Translate current buffer.
Find the definition of the current word using Ellama.
Summarize a selected region or the current buffer using Ellama.
Summarize text from the kill ring.
Review code in a selected region or the current buffer using Ellama.
Change text in a selected region or the current buffer according to a provided change.
Create a markdown list from the active region or the current buffer using Ellama.
Create a markdown table from the active region or the current buffer using Ellama.
Summarize a webpage fetched from a URL using Ellama.
Select ellama provider.
Complete selected code or code in the current buffer according to a provided change using Ellama.
Add new code according to a description, generating it with a provided context from the selected region or the current buffer using Ellama.
Change selected code or code in the current buffer according to a provided change using Ellama.
Change selected code or code in the current buffer according to a provided change using Ellama.
Enhance the wording in the currently selected region or buffer using Ellama.
Enhance the grammar and spelling in the currently selected region or
buffer using Ellama.
Make the text of the currently selected region or buffer concise and simple using Ellama.
Render the currently selected text or the text in the current buffer as a specified format using Ellama.
Load ellama session from file.
Remove ellama session.
Change current active session.
Rename current ellama session.
Add file to context.
Add buffer to context.
Add selected region to context.
Add info node to context.
Chat translation enable.
Chat translation disable.
Here is a table of keybindings and their associated functions in
Ellama, using the ellama-keymap-prefix prefix (not set by default):
| Keymap | Function | Description |
|---|---|---|
| “c c” | ellama-code-complete | Code complete |
| “c a” | ellama-code-add | Code add |
| “c e” | ellama-code-edit | Code edit |
| “c i” | ellama-code-improve | Code improve |
| “c r” | ellama-code-review | Code review |
| ”s s” | ellama-summarize | Summarize |
| ”s w” | ellama-summarize-webpage | Summarize webpage |
| ”s c” | ellama-summarize-killring | Summarize killring |
| ”s l” | ellama-load-session | Session Load |
| ”s r” | ellama-session-rename | Session rename |
| ”s d” | ellama-session-remove | Session delete |
| ”s a” | ellama-session-switch | Session activate |
| “i w” | ellama-improve-wording | Improve wording |
| “i g” | ellama-improve-grammar | Improve grammar and spelling |
| “i c” | ellama-improve-conciseness | Improve conciseness |
| “m l” | ellama-make-list | Make list |
| “m t” | ellama-make-table | Make table |
| “m f” | ellama-make-format | Make format |
| “a a” | ellama-ask-about | Ask about |
| “a i” | ellama-chat | Chat (ask interactively) |
| “a l” | ellama-ask-line | Ask current line |
| “a s” | ellama-ask-selection | Ask selection |
| “t t” | ellama-translate | Text translate |
| “t b” | ellama-translate-buffer | Translate buffer |
| “t e” | ellama-chat-translation-enable | Translation enable |
| “t d” | ellama-chat-translation-disable | Translation disable |
| “t c” | ellama-complete | Text complete |
| “d w” | ellama-define-word | Define word |
| “x b” | ellama-context-add-buffer | Context add buffer |
| “x f” | ellama-context-add-file | Context add file |
| “x s” | ellama-context-add-selection | Context add selection |
| “x i” | ellama-context-add-info-node | Context add info node |
| “p s” | ellama-provider-select | Provider select |
The following variables can be customized for the Ellama client:
ellama-enable-keymap: Enable the Ellama keymap.ellama-keymap-prefix: The keymap prefix for Ellama.ellama-user-nick: The user nick in logs.ellama-assistant-nick: The assistant nick in logs.ellama-language: The language for Ollama translation. Default
language is english.
ellama-provider: llm provider for ellama. Default provider is
ollama with zephyr model.
There are many supported providers: ollama, open ai, vertex,
GPT4All. For more information see llm documentation.
ellama-providers: association list of model llm providers with name as key.ellama-spinner-type: Spinner type for ellama. Default type is
progress-bar.
ellama-ollama-binary: Path to ollama binary.ellama-auto-scroll: If enabled ellama buffer will scroll automatically during generation. Disabled by default.ellama-fill-paragraphs: Option to customize ellama paragraphs filling behaviour.ellama-name-prompt-words-count: Count of words in prompt to generate name.- Prompt templates for every command.
ellama-chat-done-callback: Callback that will be called on ellama
chat response generation done. It should be a function with single argument generated text string.
ellama-nick-prefix-depth: User and assistant nick prefix depth. Default value is 2.ellama-sessions-directory: Directory for saved ellama sessions.ellama-major-mode: Major mode for ellama commands. Org mode by default.ellama-long-lines-length: Long lines length for fill paragraph call. Too low value can break generated code by splitting long comment lines. Default value 100.ellama-session-auto-save: Automatically save ellama sessions if set. Enabled by default.ellama-naming-scheme: How to name new sessions.ellama-naming-provider: LLM provider for generating session names by LLM. If not setellama-providerwill be used.ellama-chat-translation-enabled: Enable chat translations if set.ellama-translation-provider: LLM translation provider.ellama-providerwill be used if not set.
Thanks Jeffrey Morgan for excellent project ollama. This project cannot exist without it.
Thanks zweifisch - I got some ideas from ollama.el what ollama client in Emacs can do.
Thanks Dr. David A. Kunz - I got more ideas from gen.nvim.
Thanks Andrew Hyatt for llm library. Without it only ollama would
be supported.
To contribute, submit a pull request or report a bug. This library is part of GNU ELPA; major contributions must be from someone with FSF papers. Alternatively, you can write a module and share it on a different archive like MELPA.
