Skip to main content

Farcaster CLI Client

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

farcaster_cli-0.1.5.tar.gz (2.8 kB view details)

Uploaded Source

Built Distribution

farcaster_cli-0.1.5-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

Details for the file farcaster_cli-0.1.5.tar.gz.

File metadata

  • Download URL: farcaster_cli-0.1.5.tar.gz
  • Upload date:
  • Size: 2.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.10.9 Darwin/22.3.0

File hashes

Hashes for farcaster_cli-0.1.5.tar.gz
Algorithm Hash digest
SHA256 4b71b54035591249188aae862cf804ba3e46e8695acf9a936e5dde349f2db314
MD5 53ee4090c50a70bb43251da3959f2c45
BLAKE2b-256 01c024834a8e1bc497b892acbd7c0ed38257fda213c30d3e90d46cca71be63a2

See more details on using hashes here.

File details

Details for the file farcaster_cli-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: farcaster_cli-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 3.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.10.9 Darwin/22.3.0

File hashes

Hashes for farcaster_cli-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 932d1aa642997856e532095c35dd2cf495ec3485671e6e7fa877c6631a346f9c
MD5 7ccc6f63f9cb5ec45801744d47c288ac
BLAKE2b-256 8f8eed6c76c973e4ae9dd2cccbbae3990a706c8d9d611fea7606185570f5030d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page