tristan/gptel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Forked from github.com/karthink/gptel
24 commits 1 branch 5 tags 855 KiB
Emacs Lisp 100%
Find a file
Karthik Chikmagalur a673f54a3e gptel, gptel-curl: Handle missing API key 
gptel.el (gptel--url-get-response): When `gptel-send' is called
directly, the API key is assumed to exist. Ensure that it is read.

gptel-curl.el (gptel-curl--get-args): Ditto.
2023-03-10 23:00:41 -08:00
img Add gptel.el and a README. 2023-03-05 18:13:32 -08:00
gptel-curl.el gptel, gptel-curl: Handle missing API key 2023-03-10 23:00:41 -08:00
gptel-transient.el gptel-transient: Commands to act on region 2023-03-10 06:14:46 -08:00
gptel.el gptel, gptel-curl: Handle missing API key 2023-03-10 23:00:41 -08:00
README.org gptel: Add org-mode support and update README 2023-03-10 05:13:29 -08:00

README.org

GPTel: A simple ChatGPT client for Emacs

GPTel is a simple, no-frills ChatGPT client for Emacs.

/tristan/gptel/media/commit/a673f54a3ed6a47a964fa8173f958ce9feefdc34/img/gptel.png

  • Requires an OpenAI API key.
  • No external dependencies, only Emacs. Also, it's async.
  • Interaction is in a Markdown, Org or text buffer.
  • Supports conversations (not just one-off queries) and multiple independent sessions.
  • You can go back and edit your previous prompts, or even ChatGPT's previous responses when continuing a conversation. These will be fed back to ChatGPT.

Installation

Package.el

Clone this repository and run M-x package-install-file.

Installing the markdown-mode package is optional.

Straight 

  (straight-use-package '(gptel :host github :repo "karthink/gptel"))

Installing the markdown-mode package is optional.

Manual

Install emacs-aio, (M-x package-install⏎ emacs-aio⏎), then clone this repository and load this file:

(add-to-list 'load-path "/path/to/gptel/")
(require 'gptel)

Installing the markdown-mode package is optional.

Usage

Procure an OpenAI API key.

Optional: Set gptel-api-key to the key or to a function that returns the key (more secure).

In a dedicated buffer:

Run M-x gptel to start or switch to the ChatGPT buffer. It will ask you for the key if you skipped the previous step.

Run it with a prefix-arg (C-u M-x gptel) to start a new session.

In the gptel buffer, send your prompt with M-x gptel-send, bound to C-c RET.

That's it. You can go back and edit previous prompts and responses if you want.

The default mode is markdown-mode if available, else text-mode. You can set gptel-default-mode to org-mode if desired.

In any buffer:

Select a region of text, call M-x gptel-send.

The response will be inserted below your region. You can select both the original prompt and the resposne and call M-x gptel-send again to continue the conversation.

Why another ChatGPT client?

Existing Emacs clients don't reliably let me use it the simple way I can in the browser. They will get better, but I wanted something for now.

Also, AI-assisted work is a new way to use Emacs. It's not yet clear what the best Emacs interface to tools like it is.

  • Should it be part of CAPF (completions-at-point-functions)?
  • A dispatch menu from anywhere that can act on selected regions?
  • A comint/shell-style REPL?
  • One-off queries in the minibuffer (like shell-command)?
  • A refactoring tool in code buffers?
  • An org-babel interface?

Maybe all of these, I don't know yet. As a start, I wanted to replicate the web browser usage pattern so I can build from there – and don't need to switch to the browser every time. The code is fairly simple right now.

Will you add feature X?

Maybe, I'd like to experiment a bit first.