chatgpt

Use ChatGPT inside Emacs

This Emacs Code extension allows you to use the official OpenAI API to generate code or natural language responses from OpenAI's ChatGPT to your questions, right within the editor.

P.S. This plugin focuses on experience with making conversations with ChatGPT!

💾 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) to your configuration since most 'chatgpt 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 :ensure t)

or with straight.el:

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

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)

🔑 Obtaining API key

To use this extension, you will need an API key from OpenAI. To obtain one, follow these steps:

1. Go to OpenAI's website. If you don't have an account, you will need to create one or sign up using your Google or Microsoft account.
2. Click on the Create new secret key button.
3. Copy the key and paste into the 'API Key' field under the 'openai' custom group settings.

When you create a new account, you receive $18 in free credits for the API which you must use in the first 90 days. You can see pricing information here. 1000 tokens are about 700 words, and you can see the token count for each request at the end of the response in the sidebar.

🔨 Usage

Before you can use this package you will need to set up your API key for openai library.

To start this package:

M-x chatgpt

You will then be asked to insert your response; in this window, you press return to send the message, and Shift+return to insert a newline like a normal browser!

📝 Customization

🧪 Variables

• chatgpt-model - ID of the model to use. (Default: "gpt-3.5-turbo")
• chatgpt-max-tokens - The maximum number of tokens to generate in the completion. (Default: 2000)
• chatgpt-temperature - What sampling temperature to use. If nil the value is not passed down to the OpenAI API. (Default: nil)
• chatgpt-top-p - What nucleus sampling top_p value to use. If nil the value is not passed down to the OpenAI API. (Default: nil)
• chatgpt-reasoning-effort - Constrains effort on reasoning for reasoning models. (Default: nil)
• chatgpt-reasoning-verbosity - Constrains the verbosity of the model's response. (Default: nil)
• chatgpt-service-tier - Specifies the processing type used for serving the request. (Default nil)
• chatgpt-input-method - The method to receive input. (Default: 'window)
• chatgpt-display-method - The method to display buffer. (Default: nil)
• chatgpt-spinner-type - Type of the spinner. (Default: 'moon)
• chatgpt-display-tokens-info - Non-nil we display tokens information for each request. (Default: t)
• chatgpt-animate-text - Display text gradually instead of output it all at once. (Default: t)
• chatgpt-animate-fps - Frame per seconds to display text animation. (Default: 5)

Some of these parametes only apply to reasoning models. For more details on the correct use of the parameters in relation to the model you are using please check the API reference.

🔗 References

• ChatGPT.el
• gptel

🛠️ 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.