[go: up one dir, main page]

curlgpt
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

CurlGPT 👋

Latest Version

CurlGPT is a command-line tool that brings the power of OpenAI's ChatGPT to your favorite terminal. It allows you to type the prompt and the command line will output the proper command. 💬🚀

Your browser does not support the video tag.

Features

  • Get the command for the specified prompt ChatGPT on your terminal.
  • Get accurate command for the prompt
  • Auto Copy the outputted command to clipboard
  • Easy-to-use command-line interface

Installation 🛠️

  1. Make sure you have Node.js installed on your system.

  2. Run the following command to install CurlGPT globally:

    npm install -g curlgpt

Usage 🚀

  1. Sign into CurlGPT's API Key to obtain your API key.

  2. Set your CurlGPT's API key using the --set-apiKey option:

    curlgpt --set-apiKey <your-api-key>
  3. Test the CurlGPT by giving a prompt:

    curlgpt how to run a postgres container in local

    The tool will return appropriate response based on the provided prompt.

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

    curlgpt --help

Contributing 🤝

Contributions are welcome! If you find a bug, have a feature request, or want to contribute code, please open an issue or submit a pull request to the GitHub repository.

Local Development 👨‍💻

  1. Fork the repository from Github

  2. Clone the forked repository

    git clone https://github.com/<your-username>/CurlGPT.git
  3. Open the clone repository in your favorite code editor

  4. Install the dependencies by running the following command

    yarn
  5. Test the tool by running the following command to print the CurlGPT version

        yarn start -v

Note: you will require CurlGPT's API Key to test the prompt in local

License 📝

CurlGPT is open-source software released under the MIT License.

Package Sidebar

Install

npm i curlgpt

Weekly Downloads

0

Version

1.0.1

License

MIT

Unpacked Size

19.3 kB

Total Files

14

Last publish

Collaborators

  • lokeswaran-aj