Skip to content

Add example - #1

Draft
geodro wants to merge 6 commits into
mainfrom
add-example
Draft

geodro wants to merge 6 commits into
mainfrom
add-example

Conversation

@geodro

@geodro geodro commented Oct 15, 2026 •

Copy link
Copy Markdown
Member

This adds example, a small plugin that uses every surface Lerd offers so authors can see how each one is wired before writing their own. It is what lerd plugin new generates, with a README and a license added.

It adds lerd example:greet, lerd example:sites and lerd example:notify, a Greet site command, hooks on site.linked and site.unlinked, an example_greet MCP tool with a skill, a greet API endpoint, a dashboard page, a site tab, an Overview card, and a page script that puts a small button on the sites it is switched on for. It also shows what a plugin carries for its own card in the dashboard: an icon, screenshots, and a DOCS.md for its Documentation tab, with pages built from the look Lerd gives every plugin page.

It asks to send notifications, so Lerd asks the user whether to allow it at install, and it sends one only when example:notify is run. It reads only the site name Lerd hands it. The hooks append each event to events.log in the plugin's data folder, example:sites calls Lerd's own API on the machine with the plugin's token, and nothing leaves the machine. It needs curl and Lerd 1.38 or newer.

Repository: https://github.com/lerd-env/plugin-example

The example's dashboard page

The example's site tab

This pull request stays a draft and is never merged. It is here to show what a submission looks like: one file under plugins/, pinned to a full commit, with a description of what the plugin does, reads and sends.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant