Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zquestz/go-chatgpt-twitter-bot
Twitter bot backed by ChatGPT
https://github.com/zquestz/go-chatgpt-twitter-bot
Last synced: about 2 months ago
JSON representation
Twitter bot backed by ChatGPT
- Host: GitHub
- URL: https://github.com/zquestz/go-chatgpt-twitter-bot
- Owner: zquestz
- License: mit
- Created: 2023-06-10T03:24:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-14T00:06:58.000Z (2 months ago)
- Last Synced: 2024-11-14T01:19:01.429Z (2 months ago)
- Language: Go
- Size: 48.8 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[![License][License-Image]][License-URL]
# go-chatgpt-twitter-bot
Twitter bot backed by ChatGPT.
## Install
```
go get -v github.com/zquestz/go-chatgpt-twitter-bot
cd $GOPATH/src/github.com/zquestz/go-chatgpt-twitter-bot
make
make install
```
## ENV Setup
There are quite a few API keys and ENV vars to setup. You can use a `.env` file if you want. We use the Twitter v2 API, and OpenAI.
```
TWITTER_BEARER_TOKEN=
TWITTER_CONSUMER_API_KEY=
TWITTER_CONSUMER_SECRET=
TWITTER_ACCESS_TOKEN=
TWITTER_ACCESS_SECRET=
OPENAI_API_KEY=
OPENAI_CHARACTER_BACKGROUND=
```
Make sure to setup a character background. This will be the personality that will post tweets!
## Usage
```
Usage:
go-chatgpt-twitter-bot [flags]
Flags:
-b, --bot launch in bot mode
--completion string completion script for bash, zsh, fish or powershell
-d, --dryrun dryrun mode
-h, --help help for go-chatgpt-twitter-bot
-p, --prompt string prompt for the generator (default "Generate a tweet!")
--userid string twitter userid (default "me")
-v, --verbose verbose mode
--version display version
```
## Autocompletion
Autocompletion is supported. To set up autocompletion:
### Bash Linux
```
go-chatgpt-twitter-bot --completion bash > /etc/bash_completion.d/go-chatgpt-twitter-bot
```
### Bash MacOS
```
go-chatgpt-twitter-bot --completion bash > /usr/local/etc/bash_completion.d/go-chatgpt-twitter-bot
```
### Zsh
Generate a `_go-chatgpt-twitter-bot` completion script and put it somewhere in your `$fpath`:
```
go-chatgpt-twitter-bot --completion zsh > /usr/local/share/zsh/site-functions/_go-chatgpt-twitter-bot
```
### Fish
```
go-chatgpt-twitter-bot --completion fish > ~/.config/fish/completions/go-chatgpt-twitter-bot
```
### Powershell
```
(& go-chatgpt-twitter-bot --completion powershell) | Out-String | Invoke-Expression
```
## Configuration
To setup your own default configuration just create `~/.config/go-chatgpt-twitter-bot/config`. The configuration file is in UCL format. JSON is also fully supported as UCL can parse JSON files.
For more information about UCL visit:
[https://github.com/vstakhov/libucl](https://github.com/vstakhov/libucl)
The following keys are supported:
* bot (launch in bot mode) - Unfinished
* character_background (bot personality)
* dryrun (don't post to twitter)
* handle (twitter handle)
* prompt (prompt for the generator)
* userid (twitter userid)
* verbose (verbose mode)
## Contributors
* [Josh Ellithorpe (zquestz)](https://github.com/zquestz/)
## License
go-chatgpt-twitter-bot is released under the MIT license.
[License-URL]: http://opensource.org/licenses/MIT
[License-Image]: https://img.shields.io/npm/l/express.svg