diff --git a/.env.example b/.env.example deleted file mode 100644 index 6f71255..0000000 --- a/.env.example +++ /dev/null @@ -1,41 +0,0 @@ -# XMTP CLI Configuration -# Copy this file to .env and fill in your values - -# ============================================================================= -# XMTP Client Configuration -# ============================================================================= - -# Your wallet private key (with 0x prefix) -# If not provided, a random key will be generated each time -# XMTP_CLIENT_WALLET_KEY=0x... - -# Database encryption key (32-byte hex string) -# If not provided, a random key will be generated each time -# XMTP_CLIENT_DB_ENCRYPTION_KEY=... - -# ============================================================================= -# XMTP Network Configuration -# ============================================================================= - -# XMTP environment (dev or production) -# Default: production -XMTP_ENV=production - -# ============================================================================= -# Auto-Connect Configuration (Optional) -# ============================================================================= - -# If you want to auto-connect to a specific wallet on startup -# Provide the target wallet's private key here -# The CLI will derive the address and connect automatically -# XMTP_WALLET_KEY=0x... - -# ============================================================================= -# Notes -# ============================================================================= - -# - Keys are optional - the CLI will auto-generate them if not provided -# - For persistent identity, save your generated keys to this file -# - Use 'dev' environment for testing, 'production' for real usage -# - Keep your private keys secure and never commit them to git -# - The .gitignore file already excludes .env for safety diff --git a/README.md b/README.md index 123e0f2..a241630 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,35 @@ -# Node Inbox / CLI +# Node inbox The coolest terminal-based chat interface for XMTP protocol! Built with React + Ink for a beautiful TUI experience. ![XMTP CLI](screenshot.png) + +## Getting started + +### Requirements + +- Node.js v20 or higher +- Yarn v4 or higher + +### Environment variables + +To run your XMTP agent, you must create a `.env` file with the following variables: + +```bash +XMTP_CLIENT_WALLET_KEY= # the private key of the wallet +XMTP_CLIENT_DB_ENCRYPTION_KEY= # encryption key for the local database +XMTP_ENV=dev # local, dev, production +``` + +### Run the agent + +```bash +# git clone repo +git clone https://github.com/ephemeraHQ/node-inbox.git +# go to the folder +cd node-inbox +# install packages +yarn +# run the agent +yarn dev +```