Skip to content

Commit

Permalink
Improved examples in readme and moved to local example section
Browse files Browse the repository at this point in the history
  • Loading branch information
craigmayhew committed Jan 29, 2024
1 parent bfb2c5b commit b9cbf7b
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ Pipe your content to gpt directly from the command line. A concept that allows f

## Use cases

### Local command-line usage
- `tail -30 /var/httpd.log | pipe-gpt --p "Is there anything in the http log file I should fix?"`
- `cat main.rs | pipegpt -p "How would you improve this code? Include line numbers in your comments so I can tell where you mean."`
- `cat main.rs | pipegpt -p "Is this code production ready? If yes reply "Yes". If no, then explain why not. Be concise."`
- `cat file.json | pipegpt -p "Convert this JSON to YAML"`
- `cat french.txt | pipegpt -p "Translate this to English please."`
- `git diff -- staged | pipegpt -p "Code review this code change"`

### Pipe | GPT for local dev


Expand Down Expand Up @@ -58,12 +66,6 @@ cat src/main.rs | OPENAI_API_KEY='sk-abc123' ./target/debug/pipe-gpt -p "improv
- Add unit tests
- Add documentation
- Support roles such as "software developer", "data scientist" etc
- Examples of good prompts:
- `cat main.rs | pipegpt -p "How would you improve this code? Include line numbers in your comments so I can tell where you mean."`
- `cat main.rs | pipegpt -p "Is this code production ready? If yes reply "Yes". If no, then explain why not. Be concise."`
- `cat file.json | pipegpt -p "Convert this JSON to YAML"`
- `git diff -- staged | pipegpt -p "Code review this code change"`
- `cat french.txt | pipegpt -p "Translate this to English please."`
- Release crate

## Set the open api key env var in windows powershell
Expand Down

0 comments on commit b9cbf7b

Please sign in to comment.