gptel 
- Description
- Interact with ChatGPT or other LLMs
- Latest
- gptel-0.9.9.0.20251015.232904.tar (.sig), 2025-Oct-16, 750 KiB
- Maintainer
- Karthik Chikmagalur <karthik.chikmagalur@gmail.com>
- Website
- https://github.com/karthink/gptel
- Browse ELPA's repository
- CGit or Gitweb
- Badge
To install this package from Emacs, use package-install
or list-packages
.
Full description
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', which see. - For Gemini: define a gptel-backend with `gptel-make-gemini', which see. - For Anthropic (Claude): define a gptel-backend with `gptel-make-anthropic', which see. - For AI/ML API, Together.ai, Anyscale, Groq, OpenRouter, DeepSeek, Cerebras or Github Models: define a gptel-backend with `gptel-make-openai', which see. - For PrivateGPT: define a backend with `gptel-make-privategpt', which see. - For Perplexity: define a backend with `gptel-make-perplexity', which see. - For Deepseek: define a backend with `gptel-make-deepseek', which see. - For Kagi: define a gptel-backend with `gptel-make-kagi', which see. 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', which see. - 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.
Old versions
gptel-0.9.9.0.20251015.114036.tar.lz | 2025-Oct-15 | 138 KiB |
gptel-0.9.9.0.20251014.152520.tar.lz | 2025-Oct-15 | 138 KiB |
gptel-0.9.9.0.20251009.220742.tar.lz | 2025-Oct-10 | 137 KiB |
gptel-0.9.9.0.20250927.132404.tar.lz | 2025-Sep-28 | 136 KiB |
gptel-0.9.9.0.20250918.154703.tar.lz | 2025-Sep-19 | 135 KiB |
gptel-0.9.8.5.0.20250901.153006.tar.lz | 2025-Sep-02 | 133 KiB |
gptel-0.9.7.0.20250313.122929.tar.lz | 2025-Mar-13 | 103 KiB |
gptel-0.9.0.0.20241010.94430.tar.lz | 2024-Oct-10 | 61.4 KiB |
gptel-0.8.6.0.20240623.113847.tar.lz | 2024-Jun-23 | 57.2 KiB |
gptel-0.8.5.0.20240429.130547.tar.lz | 2024-May-01 | 49.1 KiB |
News
# -*- mode: org; -*- * 0.9.9.3-pre ** Breaking changes - Link handling in gptel chat buffers has changed, hopefully for the better. When ~gptel-track-media~ is non-nil, gptel follows links in the prompt and includes their contents with queries. Previously, links to files had to be placed "standalone", surrounded by blank lines, for the files to be included in the prompt. This limitation has been removed -- all supported links in the prompt will be followed now. The "standalone" limitation was imposed to make included links stand out visually and avoid accidental inclusions, but in practice users were often confused about whether a link would be sent. gptel now prominently annotates links that will be followed and sent (see below), so it should be visually obvious when links will be followed. You can revert to the old behavior by customizing gptel, see below. - The model =claude-3-sonnet-20240229= has been removed from the default list of Anthropic models. This model is no longer available in the Anthropic API. - The models =gemini-1.5-flash-8b=, =gemini-1.5-flash=, =gemini-1.5-pro-latest=, =gemini-2.0-flash-thinking-exp-01-21=, =gemini-2.0-flash-lite-preview-02-05=, =gemini-2.5-flash-lite-preview-06-17=, =gemini-2.5-pro-preview-06-05=, =gemini-2.5-pro-preview-05-06=, =gemini-2.5-flash-preview-05-20=, =gemini-2.5-pro-preview-03-25= and =gemini-2.5-pro-exp-03-25= have been removed from the default list of Gemini models. These models are either no longer available, or they have been superseded by their stable, non-preview versions. If required, you can add these models back to the Gemini backend in your personal configuration: #+begin_src emacs-lisp (push 'gemini-2.5-pro-preview-05-06 (gptel-backend-models (gptel-get-backend "Gemini"))) #+end_src ** New models and backends - GitHub Copilot backend: Add support for =gpt-5-codex= and =claude-sonnet-4.5=. - Add support for =claude-sonnet-4-5-20250929= and =claude-haiku-4-5-20251001=. - Add support for =gemini-pro-latest=, =gemini-flash-latest= and =gemini-flash-lite-latest=. These models point to the latest Gemini models of the corresponding type. - Add support for =gemini-2.5-flash-preview-09-2025= and =gemini-2.5-flash-lite-preview-09-2025=. ** New features and UI changes - Link annotations: When ~gptel-track-media~ is enabled in gptel chat buffers, gptel follows (Markdown/Org) links to files in the prompt and includes these files with queries. However, it was not clear if a link type was supported and would be included, making this feature unreliable and difficult to use. Now all links in the prompt are explicitly annotated in real-time in gptel buffers. Links that will not be sent are marked as such, and the link tooltip explains why. Links that will be sent are explicitly indicated as well. - New user options ~gptel-markdown-validate-link~ and ~gptel-org-validate-link~: These control whether links in Markdown/Org buffers are followed and their sources included in gptel's prompt. Their value should be a function that determines if a link is to be considered valid for inclusion with the gptel query. By default they allow all links, but they can be customized to require "standalone" link placement, which is gptel's past behavior. - gptel preset specifications can now modify the current values of gptel options instead of replacing them, allowing better composition of presets with your Emacs environment and with each other. For example, it is common to want to add more LLM tools via a preset to an existing set in gptel-tools. To this end, add a small, declarative DSL for use in gptel preset definitions. For example, you can now do the following: #+begin_src emacs-lisp (gptel-make-preset 'websearch :tools '(:append ("search_web" "read_url"))) #+end_src to add to the current list in ~gptel-tools~ instead of replacing it. See the documentation of ~gptel-make-preset~ for more details. ... ...