emacs-openai / chatgpt-sideline

Sideline support for chatgpt

chatgpt-sideline

Sideline support for chatgpt

This Emacs package enhances the experience of another Emacs package, chatgpt.

🏆 Features

• Edit history
• Copy text

💾 Installation

package.el

This package is available from JCS-ELPA. Install from these repositories then you should be good to go!

Normally, you don't need to add (require 'chatgpt-sideline) to your configuration since most chatgpt-sideline commands are autoload and can be called without loading the module!

use-package

If you are using use-package, add the following to your init.el file:

(use-package chatgpt-sideline :ensure t)

or with straight.el:

(use-package chatgpt-sideline
  :straight (chatgpt-sideline :type git :host github :repo "emacs-openai/chatgpt-sideline"))

Manual installation

Copy all .el files in this repository to ~/.emacs.d/lisp and add the following:

(add-to-list 'load-path "~/.emacs.d/lisp/")
(require 'chatgpt-sideline)

💾 Quickstart

(use-package chatgpt-sideline
  :hook (after-init . sideline-mode)
  :init
  (setq sideline-backends-right '(chatgpt-sideline)))

🛠️ Contribute

If you would like to contribute to this project, you may either clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome!

🔬 Development

To run the test locally, you will need the following tools:

• Eask
• Make (optional)

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ eask lint package

📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.

⚜️ License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.