Documentation

CurlGPT is a command-line tool that brings the power of OpenAI's ChatGPT to your favorite terminal. It allows you to type prompts, and the command line will output the proper command for you. With CurlGPT, you can easily generate accurate commands based on your prompts and simplify your command-line workflows.

Installation

Before installing CurlGPT, ensure that you have Node.js installed on your system. Then, run the following command to install CurlGPT globally:

shell
npm install -g curlgpt

Usage

To use CurlGPT effectively, follow the steps below:

  1. Obtain your OpenAI's API key.
  2. Set your OpenAI's API key using the --set-apiKey option:
    3. shell
    curlgpt --set-apiKey <apiKey>
  3. Test CurlGPT by providing a prompt:
    4. shell
    curlgpt how to run a PostgreSQL container in local

    The tool will return an appropriate response based on the provided prompt, giving you the corresponding command.

  4. Explore additional options and commands using the built-in help:
    5. shell
    curlgpt --help