Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 0 additions & 41 deletions .env.example

This file was deleted.

32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
```
Loading