getting-started.md

Getting Started

The current public crate in this repository is xfetch-plugin-api.

Git Dependency

[dependencies]
serde = { version = "1", features = ["derive"] }
xfetch-plugin-api = { git = "https://github.com/xfetch-cli/api", package = "xfetch-plugin-api" }

Local Development

During multi-repo development, you can use a standard Cargo path dependency instead.

[dependencies]
serde = { version = "1", features = ["derive"] }
xfetch-plugin-api = { path = "../api/crates/plugin-api" }

Runtime Model

Plugins are standalone executables. The core writes one JSON request to stdin, the plugin reads it, and the plugin writes one JSON response to stdout.

Next Step

• See Plugin SDK for the public API.
• See Protocol Reference for the wire format.
• See Examples for minimal plugin implementations.