/farcaster-cli-client

Primary LanguagePython

farcaster-cli

Python Version Code style: black chat

farcaster-cli is a CLI client for the Farcaster protocol

Installation

pip install farcaster-cli

or install with Poetry:

poetry add farcaster-cli

Usage

This client leverages the Warpcast API. Warpcast is one of many Farcaster clients. As more APIs are created and hosted by different clients, these will be added to the CLI.

To use the Warpcast API you need to have a Farcaster account. We will use the mnemonic or private key of the Farcaster custody account (not your main wallet) to connect to the API.

First, save your Farcaster mnemonic or private key to a $MNEMONIC environment variable. Now you can initialize the client, and automatically connect.

export MNEMONIC = <your custody seed phrase here>
farcaster-cli $MNEMONIC --watch-all

This subscribes to all recent casts. If you want only the casts of people you follow, remove --watch-all. You can also include --skip-existing to only get new casts after the client starts.