Skip to content

Commit 8367c0e

Browse files
committed
README: Mention scope option in FAQ (#866)
* README.org (FAQ): Explain how to set gptel options buffer-locally or for a single request with the scope option.
1 parent 22f7432 commit 8367c0e

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.org

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ gptel uses Curl if available, but falls back to the built-in url-retrieve to wor
140140
- [[#i-want-to-change-the-formatting-of-the-prompt-and-llm-response][I want to change the formatting of the prompt and LLM response]]
141141
- [[#how-does-gptel-distinguish-between-user-prompts-and-llm-responses][How does gptel distinguish between user prompts and LLM responses?]]
142142
- [[#transient-menu-behavior][Transient menu behavior]]
143+
- [[#i-want-to-set-gptel-options-but-only-for-this-buffer][I want to set gptel options, but only for this buffer]]
143144
- [[#i-want-the-transient-menu-options-to-be-saved-so-i-only-need-to-set-them-once][I want the transient menu options to be saved so I only need to set them once]]
144145
- [[#using-the-transient-menu-leaves-behind-extra-windows][Using the transient menu leaves behind extra windows]]
145146
- [[#can-i-change-the-transient-menu-key-bindings][Can I change the transient menu key bindings?]]
@@ -1335,6 +1336,21 @@ gptel does /not/ use any prefix or semantic/syntax element in the buffer (such a
13351336
#+html: </details>
13361337
*** Transient menu behavior
13371338
#+html: <details><summary>
1339+
**** I want to set gptel options, but only for this buffer
1340+
#+html: </summary>
1341+
1342+
In every menu used to set options, gptel provides a "scope" option, bound to the ~=~ key:
1343+
1344+
#+html: <img src="https://github.com/user-attachments/assets/f9904134-2905-4b1d-ad37-b64c777af8ac" align="center" />
1345+
1346+
#+html: <img src="https://github.com/user-attachments/assets/c0950035-bf65-43ae-b649-8e3b651ce3f1" align="center" />
1347+
1348+
#+html: <img src="https://github.com/user-attachments/assets/fa3b1246-e00f-4c5e-88c7-46557b3507ef" align="center" />
1349+
1350+
You can flip this switch before setting the option to =buffer= or =oneshot=. You only need to flip this switch once, it's a persistent setting. =buffer= sets the option buffer-locally, =oneshot= will set it for the next gptel request only. The default scope is global.
1351+
1352+
#+html: </details>
1353+
#+html: <details><summary>
13381354
**** I want the transient menu options to be saved so I only need to set them once
13391355
#+html: </summary>
13401356

0 commit comments

Comments
 (0)