Skip to content

Commit

Permalink
Merge pull request #241 from s-kostyaev/improve-readme
Browse files Browse the repository at this point in the history
Add simple configuration example to readme
  • Loading branch information
s-kostyaev authored Feb 23, 2025
2 parents ad88edf + 4bb90fc commit fb01a0c
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,19 @@ You can use ~ellama~ with other model or other llm provider.
Without any configuration, the first available ollama model will be used.
You can customize ellama configuration like this:

#+BEGIN_SRC emacs-lisp
(use-package ellama
:ensure t
:bind ("C-c e" . ellama-transient-main-menu)
:config
;; show ellama context in header line in all buffers
(ellama-context-header-line-global-mode +1)
;; send last message in chat buffer with C-c C-c
(add-hook 'org-ctrl-c-ctrl-c-final-hook #'ellama-chat-send-last-message))
#+END_SRC

More sofisticated configuration example:

#+BEGIN_SRC emacs-lisp
(use-package ellama
:ensure t
Expand Down Expand Up @@ -99,7 +112,7 @@ You can customize ellama configuration like this:
;; show ellama context in header line in all buffers
(ellama-context-header-line-global-mode +1)
;; send last message in chat buffer with C-c C-c
(add-hook 'org-ctrl-c-ctrl-c-hook #'ellama-chat-send-last-message))
(add-hook 'org-ctrl-c-ctrl-c-final-hook #'ellama-chat-send-last-message))
#+END_SRC

** Commands
Expand Down Expand Up @@ -393,8 +406,7 @@ The following variables can be customized for the Ellama client:
- ~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 [[https://ollama.ai/library/zephyr][zephyr]] model.
- ~ellama-provider~: llm provider for ellama.
There are many supported providers: ~ollama~, ~open ai~, ~vertex~,
~GPT4All~. For more information see [[https://elpa.gnu.org/packages/llm.html][llm documentation]].
- ~ellama-providers~: association list of model llm providers with
Expand Down

0 comments on commit fb01a0c

Please sign in to comment.