Skip to content

Project for generating shell commands using OpenAI models.

License

Notifications You must be signed in to change notification settings

acrois/shell-craft

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Shell Craft

Project for generating shell commands using OpenAI models.

How to install

  1. pip install openai-shell-craft
  2. Create a file called config.json and put your OpenAI API key in it. (See below)

or

  1. Clone the repository
  2. Install the requirements using pip install -r requirements.txt
  3. pip install .
  4. Create a file called config.json and put your OpenAI API key in it. (See below)

How to use

shell-craft <win:optional> <description> - This will generate a shell command for you based on the description you provide. If you provide the win argument, it will generate a powershell command. Otherwise, it will generate a bash command.

Example

shell-craft This command will print the current date and time
date

Configuration file

config.json

{
    "openai_api_key": "<your secret key>"
}

License

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

Acknowledgments

  • OpenAI for their language models and API.
  • Joel Fourhman for the initial idea, the challenge, and the project name.
  • Chase Montgomery for testing, feedback, and estimated time savings vs manual implementation.

About

Project for generating shell commands using OpenAI models.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%