aboutsummaryrefslogtreecommitdiff
path: root/.config/emacs/lisp/evil-collection/modes/gptel/README.org
diff options
context:
space:
mode:
authorJack Jamison <jackqjamison@gmail.com>2026-07-05 01:19:30 -0400
committerJack Jamison <jackqjamison@gmail.com>2026-07-05 01:19:30 -0400
commitbdf9a71ab7baa2b1de9abcfd5df1a9107a55d141 (patch)
treec4524e6c41aa5107211103401dabfaefc81aa882 /.config/emacs/lisp/evil-collection/modes/gptel/README.org
parentfe3984f541bd32bdfa418afb305b614176b55ca0 (diff)
add a bunch of emacs packages HELP
Diffstat (limited to '.config/emacs/lisp/evil-collection/modes/gptel/README.org')
-rw-r--r--.config/emacs/lisp/evil-collection/modes/gptel/README.org47
1 files changed, 47 insertions, 0 deletions
diff --git a/.config/emacs/lisp/evil-collection/modes/gptel/README.org b/.config/emacs/lisp/evil-collection/modes/gptel/README.org
new file mode 100644
index 0000000..903e622
--- /dev/null
+++ b/.config/emacs/lisp/evil-collection/modes/gptel/README.org
@@ -0,0 +1,47 @@
+* gptel
+
+ Evil bindings for [[https://github.com/karthink/gptel][gptel]].
+
+ =RET= submission follows =evil-collection-repl-submit-state=: in the submit
+ state, =RET= sends; in the other state (insert when submit is normal, normal
+ when submit is insert), =RET= inserts a newline. =S-RET= behavior is
+ controlled by two customs.
+
+** Key bindings
+
+*** gptel-mode-map
+
+ Upstream only binds =C-c RET= to =gptel-send=; =RET= itself is unchanged
+ on the buffer's major mode. Evil-collection layers state-aware =RET= /
+ =S-RET= behavior on top.
+
+ | Command | Original | Evil |
+ |--------------+-----------+------------------------------------------------------------------|
+ | =gptel-send= | =C-c RET= | =C-c RET= |
+ | =gptel-send= | n/a | =RET=, =<return>= in submit state |
+ | =newline= | n/a | =S-RET=, =S-<return>= in submit state; all four in newline state |
+ | =gptel-menu= | n/a | =S-RET=, =<S-return>= in normal / visual (default) |
+ | =gptel-send= | =C-c RET= | =S-RET=, =<S-return>= in normal / visual (when menu custom nil) |
+
+*** gptel-context-buffer-mode-map (normal state)
+
+ | Command | Original | Evil |
+ |-------------------------------+-----------+-----------|
+ | =gptel-context-next= | =n= | =j= |
+ | =gptel-context-previous= | =p= | =k= |
+ | =gptel-context-flag-deletion= | =d= | =d= |
+ | =gptel-context-quit= | =C-c C-k= | =q=, =ZQ= |
+ | =gptel-context-confirm= | =C-c C-c= | =ZZ= |
+ | =gptel-context-visit= | =RET= | =RET= |
+
+** Customization
+
+ | Variable | Default | Purpose |
+ |------------------------------------------------+---------+-----------------------------------------------------------------------------|
+ | =evil-collection-gptel-want-shift-ret-to-send= | =t= | Bind =S-RET= in normal / visual to =gptel-send=. |
+ | =evil-collection-gptel-want-shift-ret-menu= | =t= | Bind =S-RET= in normal / visual to =gptel-menu=. Wins over the send custom. |
+
+** Integrations
+
+ =gptel-context=: bindings for the context buffer (above) are wired via
+ =with-eval-after-load 'gptel-context=.