Skip to content
This repository was archived by the owner on Sep 5, 2024. It is now read-only.

Home

Jump to bottom
Johnathan P. Irvin edited this page Apr 3, 2023 · 3 revisions

Shell Craft is a project that generates shell commands using OpenAI models. The project provides both a Command Line Interface (CLI) and a Python API. The CLI usage follows the format:

$ shell-craft --prompt <prompt> "<request>"

The project supports many prompt types, including Bash, Powershell, and Feature Request. Additionally, the project requires an OpenAI API key to generate the shell commands. The user can pass the API key via command line argument, environment variable, or config file.

The Python API usage is straightforward, and it allows the user to incorporate Shell Craft functionality into their own Python code.

The project is licensed under the MIT License, and the acknowledgments section mentions some of the people who helped the project along the way.

Clone this wiki locally