[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/gptel c8f87f5554 030/273: Update README with transient men
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/gptel c8f87f5554 030/273: Update README with transient menu details |
Date: |
Wed, 1 May 2024 10:01:30 -0400 (EDT) |
branch: elpa/gptel
commit c8f87f55542b47442f95b8ae0aca62a9c9004d0d
Author: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
Commit: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
Update README with transient menu details
---
README.org | 17 ++++++++++++-----
1 file changed, 12 insertions(+), 5 deletions(-)
diff --git a/README.org b/README.org
index b895e51a9a..9b25e19c77 100644
--- a/README.org
+++ b/README.org
@@ -6,7 +6,8 @@ GPTel is a simple, no-frills ChatGPT client for Emacs.
- Requires an [[https://platform.openai.com/account/api-keys][OpenAI API key]].
- No external dependencies, only Emacs. Also, it's async.
-- Interaction is in a Markdown, Org or text buffer.
+- Interact with ChatGPT from any buffer in Emacs.
+- ChatGPT's responses are in Markdown or Org markup (configurable).
- 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.
@@ -39,13 +40,15 @@ Procure an
[[https://platform.openai.com/account/api-keys][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:
+*** In a dedicated chat 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.
+1. 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.
-Run it with a prefix-arg (=C-u M-x gptel=) to start a new session.
+2. In the gptel buffer, send your prompt with =M-x gptel-send=, bound to =C-c
RET=.
-In the gptel buffer, send your prompt with =M-x gptel-send=, bound to =C-c
RET=.
+3. Set chat parameters by calling =gptel-send= with a prefix argument (=C-u
C-c RET=):
+
+[[https://user-images.githubusercontent.com/8607532/224946059-9b918810-ab8b-46a6-b917-549d50c908f2.png]]
That's it. You can go back and edit previous prompts and responses if you want.
@@ -57,6 +60,10 @@ 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.
+You can select a region and start a dedicated session, or set chat parameters
by calling =M-x gptel-send= with a prefix-arg:
+
+[[https://user-images.githubusercontent.com/8607532/224949877-08c44cb4-7bff-4ffc-963a-16fef7a4271f.png]]
+
** 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 6f951ed690 037/273: Add gptel-api-key-from-auth-source (Fix #13), (continued)
- [nongnu] elpa/gptel 6f951ed690 037/273: Add gptel-api-key-from-auth-source (Fix #13), ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 4f3ca23454 040/273: gptel: Update commentary and README, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 9f8a984729 038/273: gptel: Change how api-key is read, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 9b3db255e8 049/273: gptel: Turn API parameters into defcustoms, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel a5fe30312f 005/273: gptel: Fix spacing issues in response, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 3c10147a72 009/273: gptel: Tweak README, minor linting, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 77d1010fbc 010/273: gptel-curl: Add package version, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 03113afd50 008/273: gptel: Rename internal functions, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel b212c24c4a 018/273: gptel: tweak prompt, rename url functions, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 172059060a 012/273: gptel-curl: Autoload gptel-curl-get-response, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel c8f87f5554 030/273: Update README with transient menu details,
ELPA Syncer <=
- [nongnu] elpa/gptel 9f8fc0e519 021/273: gptel-transient: Commands to act on region, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel f0eba0cf4f 039/273: README: Update README for MELPA, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 87d9090b7a 036/273: gptel-curl: Fix process sentinel, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 552939b2f6 047/273: gptel: Fix free-variable error, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 30161850ad 032/273: gptel-transient: Allow setting num past messages to 0, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel d5ad620555 059/273: gptel-curl: process filter for streaming support, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 5a0deda7fc 065/273: gptel: Turn on streaming replies by default, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 937c754e57 076/273: gptel-transient: Add refactor transient, ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel 3d98ce8eee 099/273: gptel: Add new turbo 0613 models (#77), ELPA Syncer, 2024/05/01
- [nongnu] elpa/gptel b92fc389d7 105/273: gptel: Reduce verbosity of gptel--save-state, ELPA Syncer, 2024/05/01