Data

Tools

Indexes

Applications

Experiments

Open Source Science

fcli

FCLI is a versatile command-line tool for interacting with APIs, especially Farcaster hubs. Built with modern C++23, it supports querying data, executing commands, and dynamic hub configuration. Thread-safe and extensible, FCLI ensures high performance, stability, and ease of use for developers and power users.

https://github.com/genyleap/fcli

Science Score: 31.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary

Keywords

command-line-tool cpp23 farcaster farcaster-client farcaster-protocol
Last synced: 4 months ago · JSON representation ·

Repository

FCLI is a versatile command-line tool for interacting with APIs, especially Farcaster hubs. Built with modern C++23, it supports querying data, executing commands, and dynamic hub configuration. Thread-safe and extensible, FCLI ensures high performance, stability, and ease of use for developers and power users.

Basic Info
  • Host: GitHub
  • Owner: genyleap
  • License: mit
  • Language: C++
  • Default Branch: main
  • Homepage: https://genyleap.com
  • Size: 70.3 KB
Statistics
  • Stars: 5
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
command-line-tool cpp23 farcaster farcaster-client farcaster-protocol
Created about 1 year ago · Last pushed 12 months ago
Metadata Files
Readme License Code of conduct Citation Security

README.md

README.md for FCLI

FCLI

forthebadge

FCLI is a powerful, extensible, and thread-safe command-line interface (CLI) tool for interacting with APIs, particularly those following the Farcaster hub protocol. It allows users to query data, execute commands, and dynamically configure hub addresses with ease. Designed with modern C++ standards (C++23), it ensures high performance and stability.

Features

  • Dynamic Hub Configuration: Supports setting custom hub addresses via commands.
  • Thread-Safe Operations: Ensures reliable and safe execution in multi-threaded environments.
  • JSON Pretty-Printing: Parses and formats JSON responses for better readability.
  • Verbose Mode: Enables detailed debugging information for API requests.
  • Extensibility: Built with modular design principles, allowing easy addition of new features.

Getting Started

Prerequisites

  • C++23-compatible compiler (e.g., GCC 12+, Clang 16+)
  • libcurl for HTTP requests
  • jsoncpp for JSON parsing
  • CMake 3.25+ for building the project

Build Instructions

  1. Clone the Repository: bash git clone https://github.com/genyleap/FCLI.git cd FCLI

  2. Configure and Build: bash mkdir build && cd build cmake .. cmake --build .

  3. Run the Executable: bash ./fcli help

Usage

Basic Commands

  1. Fetch Hub Information: bash ./fcli /v1/info dbstats=1

Example Output: plaintext [INFO] Executing command with URL: https://hub.pinata.cloud/v1/info?dbstats=1 [INFO] Response: { "version": "1.0.0", "dbStats": { "collections": 12, "documents": 456789 } }

  1. Set Custom Hub Address: bash ./fcli set-hub https://mycustomhub.com

Example Output: plaintext [INFO] Hub URL updated to: https://mycustomhub.com

  1. Help: bash ./fcli help

Example Output: ```plaintext [INFO] Available Commands: /v1/info - Fetch hub information. /v1/reactions - Fetch reactions for a cast or user. set-hub - Set a custom hub address.

Example: ./fcli /v1/info dbstats=1 ./fcli set-hub https://mycustomhub.com ```

Project Structure

plaintext FCLI/ ├── sources/ │ ├── logger.cpp # Implementation of Logger class │ ├── network.cpp # Implementation of Network class │ ├── fcli.cpp # Implementation of FCLI class │ ├── logger.hpp # Thread-safe logging utilities │ ├── network.hpp # Network request handler │ ├── fcli.hpp # CLI logic ├── CMakeLists.txt # Build configuration ├── README.md # Project documentation

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch: bash git checkout -b feature-name
  3. Commit your changes: bash git commit -m "Add new feature"
  4. Push to the branch: bash git push origin feature-name
  5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

Developed by C O M P Ξ Z (compez.eth) as part of the Genyleap initiative. 🎉

Acknowledgments

  • libcurl for HTTP requests
  • jsoncpp for JSON parsing
  • The Farcaster ecosystem for their open API standards ```

Owner

  • Name: The Genyleap ™
  • Login: genyleap
  • Kind: organization
  • Email: info@genyleap.com
  • Location: Worldwide

Revolution of the software leap.

Citation (CITATION.md) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Asadzadeh"
  given-names: "Kambiz"
  orcid: "https://orcid.org/0009-0009-2065-3977"
title: "PT"
version: 1.1.222
date-released: 2023-04-25
url: "https://kambizasadzadeh.com"
repository-code: "https://github.com/genyleap/Project-Template"

GitHub Events

Total
  • Watch event: 7
  • Push event: 1
  • Create event: 3
Last Year
  • Watch event: 7
  • Push event: 1
  • Create event: 3

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 3
  • Total Committers: 1
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 3
  • Committers: 1
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
C O M P Ξ Z k****o@g****m 3

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/sync-from-template.yml actions
  • actions/checkout v2 composite