WELCOME.md

Welcome to OpenAI Forge!

Getting Started

1. Install OpenAI Forge Browser Extension

• Brave
• Chrome
• Firefox

2. Configure the Evaluator

What the heck is an Evaluator?

It's a combination of files extension with a command able to generate error when compiling or linting those files.

OpenAI Forge use this command to detect errors in your code and send them to ChatGPT, along with the documents you selected, to automatically prompt for a fixed version of your code.

This command is called: OpenAI Forge: Evaluate errors and send them with the current document or stack (ALT/OPTION + F, E).

Example:

⚠️ IMPORTANT: You need to split ALL the command subcommand and arguments in commandArgs.

.vscode/settings.json

{
  'openai-forge.customEvaluators': [
    {
      command: 'npm',
      commandArgs: ['run', 'build'],
      extensions: ['.js', '.jsx', '.ts', '.tsx'],
    },
  ],
}

3. Open a ChatGPT chat in your browser

4. Add a few documents to your stack (or not)

Run the command OpenAI Forge: Add/Remove current document to/from the stack (ALT/OPTION + F, A) to select/unselect your currently edited document.

You can see them in the status bar:

Or don't, if you just want to send your currently edited document alone.

5. Send them to ChatGPT

Run the command OpenAI Forge: Send current document or stack (ALT/OPTION + F, S).

6. Useful Key Bindings

All OpenAI Forge default key bindings start with ALT/OPTION + F (F for Forge):

• ALT/OPTION + F, A: OpenAI Forge: Add/Remove current document to/from the stack
• ALT/OPTION + F, E: OpenAI Forge: Evaluate errors and send them with the current document or stack
• ALT/OPTION + F, S: OpenAI Forge: Send current document or stack

7. Star my repo if you like it 🥰

8. May the Forge be with you 🔨

• Post your ideas and questions there.
• Post your issues there.
• If there is an internal error, you should be able to find it in Output > OpenAI Forge.