WingmanGPT 1.0.1

A chatbot that uses ChatGPT to help you find a date

WingmanGPT

Overview

WingmanGPT is a command-line tool that allows you to send text messages that are customly modified by ChatGPT and sent to a specified number.

Notice

This tool currently only works for Mac users.

Install

1. Clone the repository and cd to it.

$ git clone https://github.com/btschwartz12/WingmanGPT.git
$ cd /your/path/to/WingmanGPT
$ pwd
/your/path/to/WingmanGPT

2. Run the install.sh script, using the source command, activating the virtual environment

$ source install.sh
...
Successfully installed WingmanGPT-1.0.0
...
$ echo $VIRTUAL_ENV
/your/path/to/WingmanGPT/env

3. Verify the package exists in the envirnoment

$ which WingmanGPT
/your/path/to/WingmanGPT/env/bin/WingmanGPT

4. Get your API token from OpenAI, and initialize it for the tool. Make sure you are signed in before doing this. You can get your token by accessing the linked url and copying the value for the 'accessToken' key.

$ WingmanGPT make-token [token] # Don't actually put the brackets, just the token 
$ cat token
...
your token
...

5. Optional: make a template message file. This allows you to not have to provide a message as a command-line option.

$ WingmanGPT make-message "My custom message"
$ cat message.txt
...
your message
...

Usage

Please note that when running the program, you will get a warning from your Mac asking you if it can send a message. You must click OK for the tool to work.

Usage: WingmanGPT send [OPTIONS]

REQUIRED:
(-n, --number) [NUMBER]: 
    Phone number to send the message to.

OPTIONAL:
(-t, --token) [TOKEN]: 
    ChatGPT API token. Not required if you make a token file in step 4 of installation.

(-m, --message) [MESSAGE]: 
    Message to be modified. Not required if you make a message file in step 5 of installation.

(--noconfirm): 
    Optional flag that will send the message without confirmation.

(--mode) [MODE]: 
    Modification mode for your message. Check out prompts.json to see the modes the tool actually uses, as well as the default.

Example Usage

$ WingmanGPT send -n 1234567890 --mode=FUN --noconfirm -m "Tell me something about dogs" -t [your API token]
# Make a token file for multiple requests (step 4)
$ WingmanGPT make-token [your API token]
Token file created.
# Make a message file for multiple requests (step 5)
$ WingmanGPT make-message "I want a new dog"
Message file created.
# View available modes
$ WingmanGPT show-modes
...
# Send message
WingmanGPT send -n 1234567890

ChatGPT Functionality

This tool makes use of the revChatGPT open-source project to communicate with ChatGPT. Go check it out!

Everything that is used for the prompt, as well as the different modes, can be found in src/prompts.py.

To see all of the availible modes from the command line, you can run:

$ WingmanGPT show-modes

Contributing

Anybody except Ho Jung Kim is allowed to contribute.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Authors

• Ben Schwartz & Ryan Baxter