Skip to content

Commit

Permalink
GPT-commit: feat: Added GPT Smart Commit & Terminal GPT client settings
Browse files Browse the repository at this point in the history
Introduce GPT Smart Commit feature & OpenAI key setup.
  • Loading branch information
hwixley committed Jul 10, 2024
1 parent 81d0f0e commit 6d95bf8
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,17 +66,24 @@ cd WYX-CLI
chmod +x setup.sh && ./setup.sh
```

4. Reopen your terminal or run `source ~/.bashrc` (`source ~/.zshrc` for unix systems)
4. Reopen your terminal or run `source ~/.bashrc` (`source ~/.zshrc` for ZSH shells)

Type `wyx` to see the list of commands and start developing some magic!

## Extra Feature Setup

1. You can use OpenAI's ChatGPT to write commit messages for you (using `git diff` and `git status` outputs) when using the `wyx push` command. <i>This requires an OpenAI API key.</i>

1. GPT Smart Commit - a feature that uses OpenAI's ChatGPT to write informative commit messages for you (using your `git diff` and `git status` outputs) when using the `wyx push` command (or other wyx commands which use push, ie. `wyx nb`, `wyx bpr` etc.). <i>This requires an OpenAI API key.</i>
```
wyx setup smart_commit
```
2. Terminal GPT client - a feature that allows you to talk to OpenAI's ChatGPT directly in the terminal using the `wyx ask-gpt` command. <i>This requires an OpenAI API key.</i>
```
wyx setup openai_key
```
3. WYX-CLI Auto Update - a feature that allows you to toggle auto-updates on your WYX-CLI installation. When turned on this will perform a git pull to the upstream repository whenever you call `wyx` with no arguments (to prevent slowing down regular command usage).
```
wyx setup auto_update
```

## Factory-reset Installation

Expand All @@ -87,7 +94,7 @@ rm -rf <path-of-installation>
```

2. Remove the wyx-cli script setup in your environment file
- Open the file in an editor: (`~/.bashrc` for linux systems, and `~/.zshrc` for unix systems)
- Open the file in an editor: (`~/.bashrc` or `~/.zshrc` depending on your shell)
```
gedit ~/.bashrc
```
Expand Down

0 comments on commit 6d95bf8

Please sign in to comment.