Skip to content
This repository has been archived by the owner on Jun 8, 2024. It is now read-only.
/ tweet-ai Public archive

๐Ÿฆ Command line tool to automatically generate tweets using OpenAI API

License

Notifications You must be signed in to change notification settings

IgorKowalczyk/tweet-ai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Tweet-ai header


โš ๏ธ Deprecation Notice

Important

This project is no longer maintained and has been deprecated. This means that I will not be providing any further updates, bug fixes, or support. You are welcome to use the code as-is, but I recommend forking the project if you want to make any changes.

๐Ÿ”ฉ Setup

  1. Create an account on OpenAI and get your API key.
  2. Copy .env.example to .env.
  3. Fill the OPENAI_KEY and OPENAI_ORG variables in .env with your API key and organization ID.
  4. Install the dependencies with pnpm install.
  5. Run the script with pnpm start.

๐Ÿง  How it works

graph LR
A[User Input] --> B[OpenAI API]
B --> C[Text Generation]
C --> D[Generated Tweet]

๐Ÿ“ท Example

example.mp4

๐Ÿ—œ๏ธ .env variables

OPENAI_KEY = "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
OPENAI_ORG = "org-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Note

You can find your API key and organization ID on OpenAI.

โ‰๏ธ Issues

If you have any issues with the page please create new issue here

๐Ÿ“ฅ Pull Requests

When submitting a pull request:

  • Clone the repo.
  • Create a branch off of master and give it a meaningful name (e.g. my-awesome-new-feature).
  • Open a pull request on GitHub and describe the feature or fix.

๐Ÿ“‹ License

This project is licensed under the MIT. See the LICENSE file for details