1 unstable release
0.1.0 | Dec 27, 2022 |
---|
#112 in #bash
22KB
213 lines
Automatic command line completion, for your terminal
🔴 Work in Progress, do not use it until it comes out from beta 🔴
A CLI tool that generates shell scripts from a human-readable description.
Installation
You can install please
by running the following command in your terminal.
curl -fsSL https://raw.githubusercontent.com/rookasrudzianskas/please-cli/main/install.sh | sh -
You may need to close and reopen your terminal after installation. Alternatively, you can download the binary corresponding to your OS from the latest release.
Usage
plz
uses GPT-3. To use it, you'll need to grab an API key from your dashboard, and save it to OPENAI_API_KEY
as follows (you can also save it in your bash/zsh profile for persistance between sessions).
export OPENAI_API_KEY='sk-XXXXXXXX'
Once you have configured your environment, run plz
followed by whatever it is that you want to do (plz show me all options for the plz cli
).
To get a full overview of all available options, run plz --help
$ please --help
Generates bash scripts from the command line
Usage: please [OPTIONS] <PROMPT>
Arguments:
<PROMPT> Description of the command to execute
Options:
-y, --force Run the generated program without asking for confirmation
-h, --help Print help information
-V, --version Print version information
Develop
Make sure you have the latest version of rust installed (use rustup). Then, you can build the project by running cargo build
, and run it with cargo run
.
License
This project is open-sourced under the MIT license. See the License file for more information.
Dependencies
~20–36MB
~545K SLoC