[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/gptel 1b47235e25 071/273: README: Add section on gptel-req
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/gptel 1b47235e25 071/273: README: Add section on gptel-request |
Date: |
Wed, 1 May 2024 10:01:44 -0400 (EDT) |
branch: elpa/gptel
commit 1b47235e25c186061bf50b734a8d96396409734c
Author: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
Commit: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
README: Add section on gptel-request
* README.org (** Using it your way): New section describing
gptel-request.
---
README.org | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/README.org b/README.org
index 1138613bc7..e43111ae22 100644
--- a/README.org
+++ b/README.org
@@ -84,6 +84,17 @@ 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.
+** Using it your way
+
+GPTel's default usage pattern is simple, and will stay this way: Read input in
any buffer and insert the response below it.
+
+If you want custom behavior, such as
+- reading input from or output to the echo area,
+- or in pop-up windows,
+- sending the current line only, etc,
+
+GPTel provides a general =gptel-request= function that accepts a custom prompt
and a callback to act on the response. You can use this to build custom
workflows not supported by =gptel-send=. See the documentation of
=gptel-request=, and the [[https://github.com/karthink/gptel/wiki][wiki]] for
examples.
+
** 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.
- [nongnu] elpa/gptel d5b10c3d6d 169/273: gptel: gptel-model can be an arbitrary string, (continued)
- [nongnu] elpa/gptel d5b10c3d6d 169/273: gptel: gptel-model can be an arbitrary string, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel d6ef79f621 177/273: gptel-transient: Show descriptions of directives, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 0690c8b6a9 161/273: gptel-transient: Exit transient when writing directive, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 149261ee79 211/273: gptel-transient: Avoid clashes with the custom directive key (#219), ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel dd5833eef3 023/273: gptel: Improve gptel-mode setup, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 3d0df72bd3 027/273: gptel-transient: linting for MELPA, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 2982ede17d 255/273: gptel-org: Add gptel-org, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 9bc54bed9c 244/273: gptel-transient: Remove "-ts" suffix from major mode (#259), ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 9a5a4a60d5 248/273: README: Mention wiki entry on saving transient flags, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 8dbcbbb908 256/273: gptel-org: Move session save/restore code for Org, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 1b47235e25 071/273: README: Add section on gptel-request,
ELPA Syncer <=
- [nongnu] elpa/gptel bb8b37d8c0 100/273: gptel, gptel-curl: Fix byte-compile warnings, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 219e163dc7 091/273: gptel-curl: Add gptel-abort, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel a660e13a8b 106/273: gptel, gptel-transient: Fix read temperature from minibuffer (#85), ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel c0ffce0849 110/273: gptel: Fix reading bounds in org files (#98), ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 648fa228a1 115/273: gptel: Fix check for markdown-mode (#109), ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 63027083cd 125/273: README: Update additional customization section, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 57a70c23cb 131/273: gptel: Skip to end of word before sending, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 1434bbac7b 122/273: gptel-ollama, gptel-openai: Add example of backend creation, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 8973498378 151/273: gptel: Add minimal status indicator via mode-line-process, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 3dd00a7457 145/273: gptel-gemini: Add streaming responses, simplify configuration, ELPA Syncer, 2024/05/01