Skip to content

Latest commit

 

History

History
81 lines (64 loc) · 2.3 KB

File metadata and controls

81 lines (64 loc) · 2.3 KB

XFetch bannerPlugins

Official plugins for xfetch live in this repository. Each plugin is a standalone executable that communicates with the core binary over stdin/stdout using the JSON plugin protocol.

Keeping plugins outside the core repository allows the plugin ecosystem to evolve independently while preserving the same installation and runtime model.

Install a Plugin

From the default remote repository:

xfetch plugin install animate-logo

By default, xfetch plugin install <name> fetches plugins from https://github.com/xfetch-cli/plugins.git.

Available Plugins

Plugin Description
animate-logo Animated ASCII logos with sweep, wave, rainbow, sparkle, breathing, and frame modes.
docker Displays Docker container statistics using the local Docker CLI.
github-stats Displays GitHub user statistics such as stars, repos, pull requests, and followers.

Developing Locally

This repository is a Cargo workspace, so you can build every plugin together:

cargo test --workspace

Official plugin implementations are grouped under the repository folder plugins/<name>, which keeps the root clean as the ecosystem grows.

The shared wire protocol used by the core and plugins is maintained in xfetch-cli/api.

Installed Binary Directory

  • Linux/macOS: ~/.config/xfetch/plugins/
  • Windows: %APPDATA%/xfetch/plugins/

Authoring Plugins

See docs/README.md for the protocol specification, naming conventions, testing workflow, and contribution guidelines for new plugins.