create-xmtp-bot

create-xmtp-bot is a command-line interface tool designed to help developers create and manage their custom build configurations easily.

To install it run the following command:

npx create-xmtp-bot@latest bot-name
# enter the recently created folder
cd bot-name

Set the variables

KEY= # 0x... the private key of the bot (with the 0x prefix)
XMTP_ENV=production # or `dev`

⚠️ Bot kit is not compatible with bun yet. Use npm or yarn

# to run with hot-reload
yarn build:watch
yarn start:watch

Examples

By default the create-xmtp-bot starter comes with a conversational bot but without using a DB. Here are other examples you can use:

• Gm: Get started with a simple gm bot.
• Conversational: Drive retention with conversations and subscriptions with redisDb.
• GPT: Relay messages through Open AI APIs.

See more examples in the Awesome XMTP ⭐️ repo