Skip to content

README.md

Latest commit

 

History

History
111 lines (77 loc) · 2.61 KB

README.md

File metadata and controls

111 lines (77 loc) · 2.61 KB

Gestalt

Gestalt is an X bot that uses AI to generate tweets that mimic the style of specified Twitter users. It continuously fetches recent tweets, generates new content, and posts the generated tweets.

image (Disclaimer: this is purely an example. We did not/will not deploy @stoolfang)

Table of Contents

Cloud Deployment

A one-click installer to gestalt in the cloud. You must have a paid cloud account on the service (~$5 USD/mo). Once on the cloud the bot will post on your behalf.

Deploy on Railway

Installation

To get started with Gestalt, follow these steps:

  1. Ensure that git and that NodeJS v22 are installed.

  2. Ensure that the yarn package manager is installed

    npm install -g yarn

  3. Clone the repository:

    git clone https://github.com/maidenlabs/gestalt.git
cd gestalt

  4. Install the dependencies:

    yarn install

  5. Create a .env file based on the .env.example file and fill in the required values:

    cp .env.example .env

Usage

To start the application, run:

yarn start

Configuration

The application uses environment variables for configuration. These variables are defined in the .env file. Here is an example of the required configuration:

# Twitter Authentication
TWITTER_USERNAME=your_twitter_username
TWITTER_PASSWORD=your_twitter_password
TWITTER_EMAIL=your_twitter_email

# API Configuration
PROMPT_API_KEY=your_llm_key
PROMPT_SERVICE=DEEPSEEK_or_CHATGPT

# Timing Configuration
MINUTE_DELAY_BETWEEN_TWEETS=integer

# Agent Personality Settings
AGENT_PERSONA_PROMPT=system_prompt_for_ai
AGENT_STYLE_TARGET_USERNAME=target_twitter_username
AGENT_CONTENT_TARGET_USERNAME=target_twitter_username

Development

To build the TypeScript code, run:

yarn build

To run the application in development mode with TypeScript, run:

yarn start

Docker

To build and run the application using Docker, follow these steps:

  1. Build the Docker image:

    docker build -t gestalt-app .

  2. Run the Docker container:

    docker run -it --env-file .env gestalt-app

License

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