Skip to main content

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.

Metadata

Release files for farcaster-cli 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for farcaster-cli 0.1.5
File Size Uploaded
farcaster_cli-0.1.5.tar.gz 2.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for farcaster-cli 0.1.5
File Interpreter ABI Platform
farcaster_cli-0.1.5-py3-none-any.whl Python 3 none any Details

Total release size: 5.9 kB

Release files / farcaster_cli-0.1.5.tar.gz

Download URL farcaster_cli-0.1.5.tar.gz
Size 2.8 kB
Tags Source
SHA-256 checksum
How to use checksums
4b71b54035591249188aae862cf804ba3e46e8695acf9a936e5dde349f2db314
BLAKE2b-256 checksum
How to use checksums
01c024834a8e1bc497b892acbd7c0ed38257fda213c30d3e90d46cca71be63a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.3.2 CPython/3.10.9 Darwin/22.3.0

Release files / farcaster_cli-0.1.5-py3-none-any.whl

Download URL farcaster_cli-0.1.5-py3-none-any.whl
Size 3.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
932d1aa642997856e532095c35dd2cf495ec3485671e6e7fa877c6631a346f9c
BLAKE2b-256 checksum
How to use checksums
8f8eed6c76c973e4ae9dd2cccbbae3990a706c8d9d611fea7606185570f5030d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.3.2 CPython/3.10.9 Darwin/22.3.0

Release history Release notifications | RSS feed

This release

0.1.5 This release

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page