branch: externals/ellama
commit 16c276e78f07364463887088fcf5dc16aed43bb0
Author: Sergey Kostyaev <[email protected]>
Commit: Sergey Kostyaev <[email protected]>
Refresh README introduction
Rewrite the README preface to describe Ellama's current chat, provider,
context, session compaction, agentic workflow, tool, DLP, skill, and blueprint
capabilities. Regenerate the Info manual from the updated README.
---
README.org | 36 ++++++++++----
ellama.info | 158 ++++++++++++++++++++++++++++++++++++++----------------------
2 files changed, 127 insertions(+), 67 deletions(-)
diff --git a/README.org b/README.org
index 47bf7fd6b5..9cb0f22edc 100644
--- a/README.org
+++ b/README.org
@@ -6,15 +6,33 @@
[[https://stable.melpa.org/#/ellama][file:https://stable.melpa.org/packages/ellama-badge.svg]]
[[https://elpa.gnu.org/packages/ellama.html][file:https://elpa.gnu.org/packages/ellama.svg]]
-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.
+Ellama is an Emacs interface for working with large language models. It can be
+used as a chat client, a set of command-oriented writing and coding helpers, or
+an agentic workspace that lets an LLM plan, call tools, inspect context, and
+continue work across turns.
+
+Ellama uses the [[https://elpa.gnu.org/packages/llm.html][llm]] package for
+provider support. Ollama works out of the box when a local model is available,
+and the same interface can be configured for OpenAI-compatible APIs, OpenAI,
+Claude, Gemini, Vertex, GPT4All, LlamaCpp, and other llm providers.
+Provider-specific features such as streaming, model lists, image input, tool
+use, token limits, and model switching are enabled when the selected provider
+supports them.
+
+The package keeps persistent chat sessions, can attach buffers, files,
+directories, Info nodes, selections, and images as context, and automatically
+compacts long conversations before they exceed the provider context window. It
+also includes task-oriented commands for translation, summarization,
+proofreading, code review and editing, extraction, formatting, commit-message
+generation, and interactive provider selection.
+
+For agentic workflows, Ellama provides a plan-and-act loop and task-tool
+subagents. Agents can use configurable tools, project instructions from
+~AGENTS.md~, reusable skills, and blueprint prompts. Tool execution is guarded
+by filesystem policy checks, edit hooks, and DLP scans so projects can decide
+which reads, writes, shell commands, and tool outputs are allowed.
+
+The name "ellama" is derived from "Emacs Large LAnguage Model Assistant".
[[file:imgs/reasoning-models.gif]]
* Installation
diff --git a/ellama.info b/ellama.info
index 785387aaec..f041001a8a 100644
--- a/ellama.info
+++ b/ellama.info
@@ -13,15 +13,36 @@ Copyright (C) 2023-2026 Free Software Foundation, Inc.
(a) The FSF’s Back-Cover Text is: “You have the freedom to copy and
modify this GNU manual.”
-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.
+Ellama is an Emacs interface for working with large language models. It
+can be used as a chat client, a set of command-oriented writing and
+coding helpers, or an agentic workspace that lets an LLM plan, call
+tools, inspect context, and continue work across turns.
+
+Ellama uses the llm (https://elpa.gnu.org/packages/llm.html) package for
+provider support. Ollama works out of the box when a local model is
+available, and the same interface can be configured for
+OpenAI-compatible APIs, OpenAI, Claude, Gemini, Vertex, GPT4All,
+LlamaCpp, and other llm providers. Provider-specific features such as
+streaming, model lists, image input, tool use, token limits, and model
+switching are enabled when the selected provider supports them.
+
+The package keeps persistent chat sessions, can attach buffers, files,
+directories, Info nodes, selections, and images as context, and
+automatically compacts long conversations before they exceed the
+provider context window. It also includes task-oriented commands for
+translation, summarization, proofreading, code review and editing,
+extraction, formatting, commit-message generation, and interactive
+provider selection.
+
+For agentic workflows, Ellama provides a plan-and-act loop and task-tool
+subagents. Agents can use configurable tools, project instructions from
+‘AGENTS.md’, reusable skills, and blueprint prompts. Tool execution is
+guarded by filesystem policy checks, edit hooks, and DLP scans so
+projects can decide which reads, writes, shell commands, and tool
+outputs are allowed.
The name "ellama" is derived from "Emacs Large LAnguage Model
-Assistant". Previous sentence was written by Ellama itself.
+Assistant".
INFO-DIR-SECTION Emacs misc features
START-INFO-DIR-ENTRY
* Ellama: (ellama). Tool for interaction with large language models.
@@ -46,15 +67,36 @@ Copyright (C) 2023-2026 Free Software Foundation, Inc.
(a) The FSF’s Back-Cover Text is: “You have the freedom to copy and
modify this GNU manual.”
-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.
+Ellama is an Emacs interface for working with large language models. It
+can be used as a chat client, a set of command-oriented writing and
+coding helpers, or an agentic workspace that lets an LLM plan, call
+tools, inspect context, and continue work across turns.
+
+Ellama uses the llm (https://elpa.gnu.org/packages/llm.html) package for
+provider support. Ollama works out of the box when a local model is
+available, and the same interface can be configured for
+OpenAI-compatible APIs, OpenAI, Claude, Gemini, Vertex, GPT4All,
+LlamaCpp, and other llm providers. Provider-specific features such as
+streaming, model lists, image input, tool use, token limits, and model
+switching are enabled when the selected provider supports them.
+
+The package keeps persistent chat sessions, can attach buffers, files,
+directories, Info nodes, selections, and images as context, and
+automatically compacts long conversations before they exceed the
+provider context window. It also includes task-oriented commands for
+translation, summarization, proofreading, code review and editing,
+extraction, formatting, commit-message generation, and interactive
+provider selection.
+
+For agentic workflows, Ellama provides a plan-and-act loop and task-tool
+subagents. Agents can use configurable tools, project instructions from
+‘AGENTS.md’, reusable skills, and blueprint prompts. Tool execution is
+guarded by filesystem policy checks, edit hooks, and DLP scans so
+projects can decide which reads, writes, shell commands, and tool
+outputs are allowed.
The name "ellama" is derived from "Emacs Large LAnguage Model
-Assistant". Previous sentence was written by Ellama itself.
+Assistant".
* Menu:
@@ -2650,50 +2692,50 @@ their use in free software.
Tag Table:
-Node: Top1379
-Node: Installation3973
-Node: Commands8987
-Node: Keymap18338
-Node: Configuration21225
-Node: Session Provider Keys37798
-Node: Session Compaction39659
-Node: Image Input41953
-Node: Task Tool Subagents44098
-Node: Plan-and-Act Agent Loop47272
-Node: Edit Tool Shell Hooks49853
-Node: DLP for Tool Input/Output52146
-Node: SRT Filesystem Policy for Tools68145
-Node: Context Management73814
-Node: Transient Menus for Context Management74882
-Node: Managing the Context76561
-Node: Considerations77336
-Node: Minor modes77929
-Node: ellama-context-header-line-mode79917
-Node: ellama-context-header-line-global-mode80742
-Node: ellama-context-mode-line-mode81462
-Node: ellama-context-mode-line-global-mode82310
-Node: Ellama Session Header Line Mode83014
-Node: Enabling and Disabling83583
-Node: Customization84030
-Node: Ellama Session Mode Line Mode84318
-Node: Enabling and Disabling (1)84903
-Node: Customization (1)85350
-Node: Using Blueprints85644
-Node: Key Components of Ellama Blueprints86284
-Node: Creating and Managing Blueprints86891
-Node: Blueprints files87869
-Node: Variable Management88290
-Node: Keymap and Mode88743
-Node: Transient Menus89679
-Node: Running Blueprints programmatically90225
-Node: MCP Integration90812
-Node: Agent Skills92047
-Node: Directory Structure92410
-Node: Creating a Skill93437
-Node: How it works93812
-Node: Acknowledgments94203
-Node: Contributions94914
-Node: GNU Free Documentation License95588
+Node: Top2463
+Node: Installation6141
+Node: Commands11155
+Node: Keymap20506
+Node: Configuration23393
+Node: Session Provider Keys39966
+Node: Session Compaction41827
+Node: Image Input44121
+Node: Task Tool Subagents46266
+Node: Plan-and-Act Agent Loop49440
+Node: Edit Tool Shell Hooks52021
+Node: DLP for Tool Input/Output54314
+Node: SRT Filesystem Policy for Tools70313
+Node: Context Management75982
+Node: Transient Menus for Context Management77050
+Node: Managing the Context78729
+Node: Considerations79504
+Node: Minor modes80097
+Node: ellama-context-header-line-mode82085
+Node: ellama-context-header-line-global-mode82910
+Node: ellama-context-mode-line-mode83630
+Node: ellama-context-mode-line-global-mode84478
+Node: Ellama Session Header Line Mode85182
+Node: Enabling and Disabling85751
+Node: Customization86198
+Node: Ellama Session Mode Line Mode86486
+Node: Enabling and Disabling (1)87071
+Node: Customization (1)87518
+Node: Using Blueprints87812
+Node: Key Components of Ellama Blueprints88452
+Node: Creating and Managing Blueprints89059
+Node: Blueprints files90037
+Node: Variable Management90458
+Node: Keymap and Mode90911
+Node: Transient Menus91847
+Node: Running Blueprints programmatically92393
+Node: MCP Integration92980
+Node: Agent Skills94215
+Node: Directory Structure94578
+Node: Creating a Skill95605
+Node: How it works95980
+Node: Acknowledgments96371
+Node: Contributions97082
+Node: GNU Free Documentation License97756
End Tag Table