Skip to content

feat: Add instructions community plugins #1379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
michielmulders wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: Add instructions community plugins #1379

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d0b67b
Add instructions community plugins
michielmulders Feb 5, 2026
22ec1cd
Merge branch 'main' into feat/add-community-plugin-docs
michielmulders Feb 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Copy link
Member

@rbarker-dev rbarker-dev Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are we doing to ensure the community plugin is vetted prior to incorporation? There should be a process defined for this.

@hiero-ledger/sec-ops @hiero-ledger/tsc @hendrikebbers @jwagantall

Copy link
Contributor Author

@michielmulders michielmulders Feb 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rbarker-dev community plugins won't be incorporated. They need to be hosted on the creator's repository. We only add our own developed plugins. But I do want to keep a list in the readme of community plugins if that makes sense. Let me know if that works? Thanks!

Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,20 @@ The Hiero CLI is built on a plugin architecture. The following default plugins a

Each plugin has its own README with detailed documentation about available commands, usage examples, and architecture details. Click on the plugin name above to learn more.

## Community Plugins

Community plugins can be found in their respective owners repositories. Make sure to **clone a plugin repository** and **add the plugin** using the [`hcli plugin-management add` command](src/plugins/plugin-management/README.md). You can clone the repository anywhere on your local machine and add it to the CLI if you use the globally installed Hiero CLI version.

**Note:** Community plugins are not officially supported by the Hiero team. Use them at your own risk.

### List of Community Plugins

None at the moment. Want to contribute a plugin?

### Template for Creating Your Own Plugin

A template for creating your own plugin and documenting it can be found in the [`src/plugins/test` plugin](src/plugins/test) directory.

# Configuration & State Storage

The CLI externalizes both its immutable base configuration and mutable runtime state. No editable JSON lives in `src/state/` anymore.
Expand Down