Skip to content

0x4007/plz-cli

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Copilot, for your terminal

A CLI tool that generates shell scripts from a human readable description.

This is a modded version of plz-cli that now uses Claude 3.5 Sonnet instead of GPT-3.5 Turbo Instruct.

Installation

cargo build --release
cp ./target/release/plz ~/.bin/plz

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 Claude 3.5 Sonnet. To use it, you'll need to grab an API key from your dashboard, and save it to ANTHROPIC_API_KEY as follows (you can also save it in your bash/zsh profile for persistance between sessions).

export ANTHROPIC_API_KEY='sk-ant-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

$ plz --help
Generates bash scripts from the command line

Usage: plz [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.

Releasing

Releases are automated with v prefixed tags. To create a new release, run something similar to the following:

SEMVER=0.0.0
RELEASE_COMMENT="Default Message. Release 0.0.0"

git tag -s $SEMVER -m "$RELEASE_COMMENT"
git push origin $SEMVER

License

This project is open-sourced under the MIT license. See the License file for more information.

About

Copilot for your terminal

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 77.0%
  • Shell 23.0%