https://github.com/iammatthias/fcau
https://github.com/iammatthias/fcau
archive cli farcaster node
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/iammatthias/fcau
- Owner: iammatthias
- Created: 2023-10-17T03:50:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-18T16:03:34.000Z (over 2 years ago)
- Last Synced: 2025-04-12T04:02:39.805Z (about 1 year ago)
- Topics: archive, cli, farcaster, node
- Language: TypeScript
- Homepage: https://fcau.xyz
- Size: 84 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# FCAU - Farcaster Command-line Utility
## Overview
FCAU (Farcaster Archive Utility) is a CLI tool designed to manage and archive messages on the Farcaster protocol effortlessly.
## Features
- Query the Farcaster API using a username
- Save query results to a JSON file
## Installation
Use `npx` to quickly run it:
```bash
npx fcau@latest
```
## Usage
### Available Commands and Options
#### Init Command
Perform an initial archive of a user's messages.
```bash
npx fcau@latest init
```
**Options:**
- `-u, --username [username]`: Specify the username to query. If not provided, you will be prompted.
#### Update Command
Update an existing archive of a user's messages.
```bash
npx fcau@latest update
```
No options required.
#### Help Command
Display help for any command.
```bash
npx fcau@latest help [COMMAND]
```
## Contribution and Issues
Feel free to contribute or report issues via this project's [GitHub repository](https://github.com/iammatthias/fcau).
## License
MIT