NonGNU-devel ELPA - gptel

gptel is a simple Large Language Model chat client, with support for multiple
models and backends.

It works in the spirit of Emacs, available at any time and in any buffer.

gptel supports:

- The services ChatGPT, Azure, Gemini, Anthropic AI, Together.ai, Perplexity,
  AI/ML API, Anyscale, OpenRouter, Groq, PrivateGPT, DeepSeek, Cerebras, Github Models,
  GitHub Copilot chat, AWS Bedrock, Novita AI, xAI, Sambanova, Mistral Le
  Chat and Kagi (FastGPT & Summarizer).
- Local models via Ollama, Llama.cpp, Llamafiles or GPT4All

Additionally, any LLM service (local or remote) that provides an
OpenAI-compatible API is supported.

Features:

- Interact with LLMs from anywhere in Emacs (any buffer, shell, minibuffer,
  wherever).
- LLM responses are in Markdown or Org markup.
- Supports conversations and multiple independent sessions.
- Supports tool-use to equip LLMs with agentic capabilities.
- Supports Model Context Protocol (MCP) integration using the mcp.el package.
- Supports multi-modal models (send images, documents).
- Supports "reasoning" content in LLM responses.
- Save chats as regular Markdown/Org/Text files and resume them later.
- You can go back and edit your previous prompts or LLM responses when
  continuing a conversation.  These will be fed back to the model.
- Redirect prompts and responses easily
- Rewrite, refactor or fill in regions in buffers.
- Write your own commands for custom tasks with a simple API.

Requirements for ChatGPT, Azure, Gemini or Kagi:

- You need an appropriate API key.  Set the variable `gptel-api-key' to the
  key or to a function of no arguments that returns the key.  (It tries to
  use `auth-source' by default)

ChatGPT is configured out of the box.  For the other sources:

- For Azure: define a gptel-backend with `gptel-make-azure'.
- For Gemini: define a gptel-backend with `gptel-make-gemini'.
- For Anthropic (Claude): define a gptel-backend with `gptel-make-anthropic'.
- For AI/ML API, Together.ai, Anyscale, Groq, OpenRouter, DeepSeek, Cerebras
  or Github Models: define a gptel-backend with `gptel-make-openai'.
- For PrivateGPT: define a backend with `gptel-make-privategpt'.
- For Perplexity: define a backend with `gptel-make-perplexity'.
- For Deepseek: define a backend with `gptel-make-deepseek'.
- For Kagi: define a gptel-backend with `gptel-make-kagi'.

For local models using Ollama, Llama.cpp or GPT4All:

- The model has to be running on an accessible address (or localhost)
- Define a gptel-backend with `gptel-make-ollama' or `gptel-make-gpt4all'.
- Llama.cpp or Llamafiles: Define a gptel-backend with `gptel-make-openai'.

Consult the package README for examples and more help with configuring
backends.

Usage:

gptel can be used in any buffer or in a dedicated chat buffer.  The
interaction model is simple: Type in a query and the response will be
inserted below.  You can continue the conversation by typing below the
response.

To use this in any buffer:

- Call `gptel-send' to send the buffer's text up to the cursor.  Select a
  region to send only the region.

- You can select previous prompts and responses to continue the conversation.

- Call `gptel-send' with a prefix argument to access a menu where you can set
  your backend, model and other parameters, or to redirect the
  prompt/response.

To use this in a dedicated buffer:

- M-x gptel: Start a chat session.

- In the chat session: Press `C-c RET' (`gptel-send') to send your prompt.
  Use a prefix argument (`C-u C-c RET') to access a menu.  In this menu you
  can set chat parameters like the system directives, active backend or
  model, or choose to redirect the input or output elsewhere (such as to the
  kill ring or the echo area).

- You can save this buffer to a file.  When opening this file, turn on
  `gptel-mode' before editing it to restore the conversation state and
  continue chatting.

- To include media files with your request, you can add them to the context
  (described next), or include them as links in Org or Markdown mode chat
  buffers.  Sending media is disabled by default, you can turn it on globally
  via `gptel-track-media', or locally in a chat buffer via the header line.

Include more context with requests:

If you want to provide the LLM with more context, you can add arbitrary
regions, buffers, files or directories to the query with `gptel-add'.  To add
text or media files, call `gptel-add' in Dired or use the dedicated
`gptel-add-file'.

You can also add context from gptel's menu instead (`gptel-send' with a
prefix arg), as well as examine or modify context.

When context is available, gptel will include it with each LLM query.

LLM Tool use:

gptel supports "tool calling" behavior, where LLMs can specify arguments with
which to call provided "tools" (elisp functions).  The results of running the
tools are fed back to the LLM, giving it capabilities and knowledge beyond
what is available out of the box.  For example, tools can perform web
searches or API lookups, modify files and directories, and so on.

Tools can be specified via `gptel-make-tool', or obtained from other
repositories, or from Model Context Protocol (MCP) servers using the mcp.el
package.  See the README for details.

Tools can be included with LLM queries using gptel's menu, or from
`gptel-tools'.

Rewrite interface

In any buffer: with a region selected, you can rewrite prose, refactor code
or fill in the region.  This is accessible via `gptel-rewrite', and also from
the `gptel-send' menu.

Presets

Define a bundle of configuration (model, backend, system message, tools etc)
as a "preset" that can be applied together, making it easy to switch between
tasks in gptel.  Presets can be saved and applied from gptel's transient
menu.  You can also include a cookie of the form "@preset-name" in the prompt
to send a request with a preset applied.  This feature works everywhere, but
preset cookies are also fontified in chat buffers.

gptel in Org mode:

gptel offers a few extra conveniences in Org mode:

- You can limit the conversation context to an Org heading with
  `gptel-org-set-topic'.
  
- You can have branching conversations in Org mode, where each hierarchical
  outline path through the document is a separate conversation branch.
  See the variable `gptel-org-branching-context'.
  
- You can declare the gptel model, backend, temperature, system message and
  other parameters as Org properties with the command
  `gptel-org-set-properties'.  gptel queries under the corresponding heading
  will always use these settings, allowing you to create mostly reproducible
  LLM chat notebooks.

Finally, gptel offers a general purpose API for writing LLM ineractions that
suit your workflow.  See `gptel-request', and `gptel-fsm' for more advanced
usage.

# -*- mode: org; -*-

* 0.9.9.5-pre

** Breaking changes

- gptel's default ChatGPT backend has been removed. ~gptel-backend~ and
  ~gptel-model~ now default to =nil=, and there are no registered
  backends out of the box.  However gptel remains usable without
  configuration: if ~gptel-send~ is called without a backend set, the
  ChatGPT backend is created on the fly and used.

- The models =gpt-41-copilot=, =gpt-5= and =claude-opus-41= have been
  removed from the default list of GitHub Copilot models.  These models
  are no longer available in the GitHub Copilot API.

** New models and backends

- xAI backend: Add support for =grok-4-1-fast-reasoning=,
  =grok-4-1-fast-non-reasoning=, =grok-4-fast-reasoning=, and
  =grok-4-fast-non-reasoning=.

- - GitHub Copilot backend: Add support for =gpt-5.1-codex-,
  =gpt-5.1-codex-mini, =claude-sonnet-4.6= and =gemini-3.1-pro-preview=.

- Gemini backend: add support for =gemini-3.1-flash-lite-preview=;
  add deprecation notice for =gemini-3-pro-preview=.

- OpenAI backend: add support for =gpt-5.3-chat-latest= and =gpt-5.4=.

** New features and UI changes

- When using ~setopt~ or the customize interface, ~gptel-backend~ can
  now be specified as a list instead of an opaque object.  See its
  documentation for details.

- When using ~gptel-send~, tool calls that require confirmation can now
  be examined in full in a dedicated inspection buffer, where they are
  displayed as Elisp forms.

  The tool name and tool call arguments can also be modified in-place
  now.  These modifications /must/ be in-place; deleting tool calls or
  adding new ones to the inspection buffer is not supported.

- New hooks ~gptel-pre-tool-call-functions~ and
  ~gptel-post-tool-call-functions~ run before and after each tool call,
  respectively.  These hooks receive details of the (planned or
  finished) tool call and provide fine-grained control over them.  These
  hooks work with ~gptel-send~, including when invoked from gptel's
  Transient menu or from Elisp.

  ~gptel-pre-tool-call-functions~ can be used to modify tool call
  arguments, short-circuit the call and provide the results, block the
  tool call but continue the request with a message for the LLM, or stop
  the request entirely.

  ~gptel-post-tool-call-functions~ can be used to modify tool call
  results, block the tool call but continue the request, or stop the
  request entirely.

- New variable ~gptel-bedrock-aws-cli-command~ to set the path to the
  AWS CLI command for the Bedrock backend.  Defaults to "ews".

** Notable bug fixes

- ~gptel-backend~ can now be set from customize buffers.  These are
  produced by, for example, =M-x customize-group ⮐ gptel=.  Previously
  ~gptel-backend~ was displayed in a read-only way, and could even break
  the display of the customize buffer depending on its value.

- Breaking change to the ~gptel-request~ API: Tool call arguments are
  passed to ~gptel-request~ callbacks as a plist, not a list.  The plist
  keys are the function argument names as specified in the tool
  definition.  /This does not affect ~gptel-send~ or (to my best
  knowledge) any of the packages using gptel./

  Example: The previous behavior was

  : (funcall callback `(tool-call ,web-search ("emacs" 10) ,tool-cb))

  where =web-search= is a ~gptel-tool~, and =callback= and =tool-cb= are
  the ~gptel-request~ and tool callback respectively.  The new behavior
  is:

  : (funcall callback
  :          `(tool-call ,web-search (:query "emacs" :count 10) ,tool,cb))

  where =:query= and =:count= correspond to arguments =query= and
  =count= in the definition of =web-search=.

  Note that this is a bug fix. It's how the API has been documented and
  was supposed to work in the first place.

* 0.9.9.4

** Breaking changes

- The models =gpt-5-codex=, =o3=, =o3-mini=, =o4-mini=,
  =claude-3.5-sonnet=, =claude-3.7-sonnet=, =claude-3.7-sonnet-thought=,
  =claude-opus-4= and =gemini-2.0-flash-001= have been removed from the
  default list of GitHub Copilot models.  These models are no longer
...
...