GitXplorerGitXplorer
g

cmdhelp

public
0 stars
0 forks
0 issues

Commits

List of commits on branch main.
Verified
ff0e81dfa94243ee2f66a25a8ea1734eff6957b3

Create README.md

ggogainda committed 8 months ago
Verified
80dbeda3260b26205d03b356f92c05f275d382b1

Update main.yml

ggogainda committed 8 months ago
Verified
a40c0379533885d2d8258799df79153b5222c552

Create main.yml

ggogainda committed 8 months ago
Unverified
d76979ad5ea1b1649836513726e98b4989e81841

Create cmdhelp

ggogainda committed 8 months ago

README

The README file for this repository.

cmdhelp - A Simple ChatGPT Command Line Helper

cmdhelp is a lightweight utility that allows you to ask simple command-line questions to ChatGPT. This tool aims to make the installation and usage as straightforward as possible, providing you with immediate answers to your command-line queries without any external dependencies once built.

Features

  • Ask common command-line questions
  • Easy setup and usage

Installation

Download the executables

Only for Apple M1 Go the the latest run action here and download the zip file from the Artifacts section

Build

Build the Jar

  1. Clone the repository:

    git clone https://github.com/yourusername/cmdhelp.git
    cd cmdhelp
  2. Build the project:

    mvn clean install
  3. Run the jar file with your OpenAI API key:

    API_KEY="_your_api_key_" java -jar target/cmdhelp-1.0-SNAPSHOT-jar-with-dependencies.jar "your question here"

Build Native Executables

Using Local Setup

Follow the instruction from official GraalVM website

Using GitHub Actions

  1. Fork the project
  2. Enable GitHub Actions
  3. Add required OS to the build matrix
  4. Run the job
  5. Once the build completes, download the executable from the GitHub Actions artifacts.

Usage

After building the project or obtaining a native executable, you can use cmdhelp to ask command-line questions:

API_KEY="_your_api_key_" ./cmdhelp "How to find the biggest file in a directory?"

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

Special thanks to the GraalVM team for providing the tools needed to create native images.