https://github.com/sfttech/emacs-elaiza
Chat interface and library for interacting with different LLMs via Emacs.
https://github.com/sfttech/emacs-elaiza
Last synced: 10 months ago
JSON representation
Chat interface and library for interacting with different LLMs via Emacs.
- Host: GitHub
- URL: https://github.com/sfttech/emacs-elaiza
- Owner: SFTtech
- License: gpl-3.0
- Created: 2024-04-26T14:45:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-19T15:16:56.000Z (over 1 year ago)
- Last Synced: 2025-03-19T15:41:06.059Z (over 1 year ago)
- Language: Emacs Lisp
- Size: 931 KB
- Stars: 12
- Watchers: 8
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.org
- License: LICENSE
Awesome Lists containing this project
README
#+title: ELAIZA
#+LAST_MODIFIED: [2025-03-19 Wed 15:54]
#+HTML: 
An updated Emacs doctor.
This package provides a Large Language Model independent (LLM) backend with
multiple applications. For example, to honor its [[https://en.wikipedia.org/wiki/ELIZA][ancestor]], you can talk to a new
Artificial Intelligence-enhanced (AI) Emacs doctor via =M-x elaiza-doctor=.
For general chatting, you can use =M-x elaiza-chat= directly from the minibuffer.
By default, you can chat with a local Rocket-3B model (see getting started).
You can switch backends by prefixing your commands with =C-u= and selecting an
available LLM (see supported backends).
Similar to OpenAI's GPTs, you can create your own assistants. For example, =M-x
elaiza-editor= is a multilingual editor, giving you suggestions for your current
buffer. With =elaiza-jupyter= you can get org-mode responses that are optimized for
Python code, similar to Jupyter Notebooks.
Using ELAIZA as the backend, you can build all kind of applications, like =elaiza-businesscard=, which parses an image of a business card and returns the annotated, OCR'ed result in org-mode format.
* Installation
** Doom Emacs
Add the following to your =packages.el=
#+begin_src emacs-lisp
(package! elaiza :recipe (:host github :repo "SFTtech/emacs-elaiza" :branch "main"))
#+end_src
* Usage
#+HTML: 
** Getting Started
If you have no prior experience with LLMs and want to try ELAIZA, simply use =M-x elaiza-chat=.
This will download a small model (Rocket-3B, 1.89 GB) to =~/llamafiles= and start the the server automatically.
Afterwards you can start chatting with the model.
Note, due to its size, it will have worse capabilities compared to larger models, such as GPT-4.
You can stop the server with =M-x elaiza-llamafile-stop=.
** Key Bindings
In =elaiza-mode=, you can use =C-c = to continue the conversation (=elaiza-chat-continue=) and =C-c C-k= to interrupt the response (=elaiza-chat-interrupt=).
** Applications
Currently, the following applications are available:
- =M-x elaiza-chat= for direct minibuffer prompts
- =M-x elaiza-doctor= for an AI-enhanced Emacs doctor experience
- =M-x elaiza-editor= as a multilingual editor for suggestions in your current buffer
- =M-x elaiza-jupyter= like =elaiza-chat= but with special Python instructions.
- =M-x elaiza-businesscard= parse an image of a businesscard using GPT-4o mini.
** Specifying a default model
You can specify a default backend using customize.
Alternatively prefix the elaiza commands (=C-u=) or call =M-x elaiza-change-default-model=.
*** GPT-4o
For example, in Doom Emacs, insert the following into your =config.el= to use =GPT-4o= as your default model.
#+begin_src emacs-lisp
(use-package! elaiza
:config (setq elaiza-default-model (make-elaiza-gpt-4o))
#+end_src
*** Llamafile: LLaMA-3 Instruct 8B
If you have downloaded a Llamafile already, for example, from https://github.com/mozilla-Ocho/llamafile, you can select it as default model by specifying its name and location.
#+begin_src emacs-lisp
(use-package! elaiza
:config
(setq elaiza-default-model (make-elaiza-llamafile
:name "Llamafile: LLaMA-3 8B"
:filename "~/llamafiles/llama3.llamafile")))
#+end_src
** API Keys
Some backends, such as ChatGPT and Claude 3, require an API key.
To securely store and retrieve API keys, use auth-source, as documented in the [[https://www.gnu.org/software/emacs/manual/html_mono/auth.html][Emacs Auth Manual]]. Add the following to your =auth-sources= file, for example, =.authinfo.gpg=, to store them:
*** Example: OpenAI
Create a key at https://platform.openai.com/api-keys.
Insert into your =~/.authinfo.gpg=:
#+begin_example
machine api.openai.com port https login elaiza password
#+end_example
Use =GPT-4 Turbo= as your default model by adding the following to your =config.el=:
#+begin_src emacs-lisp
(use-package! elaiza
:config (setq elaiza-default-model (make-elaiza-gpt-4-turbo)))
#+end_src
*** Example: Claude
Create a key at https://console.anthropic.com/settings/keys.
Insert into your =~/.authinfo.gpg=:
#+begin_example
machine api.anthropic.com port https login elaiza password
#+end_example
Use =Claude 3 Opus= as your default model by adding the following to your =config.el=:
#+begin_src emacs-lisp
(use-package! elaiza
:config (setq elaiza-default-model (make-elaiza-claude-opus)))
#+end_src
*** Example: Ollama
#+begin_src emacs-lisp
(use-package! elaiza
:config
(cl-defstruct (elaiza-ollama-qwq (:include elaiza-ollama (name "Qwq")
(port "11434")
(model "qwq"))))
(cl-defstruct (elaiza-ollama-qwen2.5-coder (:include elaiza-ollama (name "Qwen 2.5 coder")
(port "11434")
(model "qwen2.5-coder:32b"))))
(elaiza-backends--add-integration (make-elaiza-ollama-qwq))
(elaiza-backends--add-integration (make-elaiza-ollama-qwen2.5-coder))
;; update the available backends for manual switching `M-x elaiza-change-default-model`
(setq elaiza-available-backends elaiza-backends-integrations-alist)
(setq! elaiza-default-model (make-elaiza-ollama-qwen2.5-coder)))
#+end_src
* Supported Backends
| Model | Provider | Sourcecode |
|-------------------------+-----------+---------------------|
| GPT 4o | OpenAI | =elaiza-openai.el= |
| GPT 4o mini | OpenAI | =elaiza-openai.el= |
| GPT 4 | OpenAI | =elaiza-openai.el= |
| GPT 4 Turbo | OpenAI | =elaiza-openai.el= |
| GPT 3.5 Turbo | OpenAI | =elaiza-openai.el= |
| Claude 3 Opus | Anthropic | =elaiza-claude.el= |
| Claude 3 Sonnet | Anthropic | =elaiza-claude.el= |
| Claude 3 Haiku | Anthropic | =elaiza-claude.el= |
| [[https://github.com/mozilla-Ocho/llamafile?tab=readme-ov-file#other-example-llamafiles][Available Llamafiles]] | [[https://github.com/mozilla-Ocho/llamafile][Llamafile]] | =elaiza-llamafile.el= |
| [[https://ollama.com/library][Available Ollama Models]] | [[https://ollama.com/][Ollama]] | =elaiza-ollama.el= |
* Alternatives
- [[https://github.com/karthink/gptel][karthink/gptel]] GPTel: A simple LLM client for Emacs
- [[https://github.com/ahyatt/llm][ahyatt/llm]]: llm package for emacs
- [[https://github.com/s-kostyaev/ellama][s-kostyaev/ellama]]: Ellama is a tool for interacting with large language models from Emacs.