Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CurlGPT/CurlGPT
ChatGPT in your favourite terminal
https://github.com/CurlGPT/CurlGPT
chatgpt cli contributions-welcome curl gpt-3 help-wanted homebrew node nodejs open-source openai opensource shell typescript
Last synced: about 1 month ago
JSON representation
ChatGPT in your favourite terminal
- Host: GitHub
- URL: https://github.com/CurlGPT/CurlGPT
- Owner: CurlGPT
- License: mit
- Archived: true
- Created: 2023-04-22T09:48:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-05T15:14:35.000Z (11 months ago)
- Last Synced: 2024-10-30T04:51:18.067Z (about 1 month ago)
- Topics: chatgpt, cli, contributions-welcome, curl, gpt-3, help-wanted, homebrew, node, nodejs, open-source, openai, opensource, shell, typescript
- Language: TypeScript
- Homepage: https://curlgpt.vercel.app/
- Size: 155 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - CurlGPT/CurlGPT - ChatGPT in your favourite terminal (TypeScript)
README
CurlGPT 👋
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
- Support for setting an API key for accessing OpenAI's API 🔑
## Installation 🛠️
1. Make sure you have Node.js installed on your system.
2. Run the following command to install CurlGPT globally:
```shell
npm install -g curlgpt
```
## Usage 🚀
1. Create an [OpenAI's API Key](https://platform.openai.com) if you have not already created it.
2. Set your OpenAI API key using the **--set-apiKey** option:
```shell
curlgpt --set-apiKey
```
3. Test the CurlGPT by giving a prompt:
```shell
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:
```shell
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](https://github.com/CurlGPT/CurlGPT/fork) from Github
2. Clone the forked repository
```shell
git clone https://github.com//CurlGPT.git
```
3. Open the clone repository in your favorite code editor
4. Install the dependencies by running the following command
```shell
yarn
```
5. Test the tool by running the following command to print the CurlGPT version
```shell
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.