Skip to content

Add a plugins section to the README #1447

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

Merged
merged 3 commits into from
Jul 9, 2025
Merged

Add a plugins section to the README #1447

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e18fcdc
Add a plugins section to the README
maraino Jul 2, 2025
de23b94
Apply suggestions from code review
maraino Jul 2, 2025
12ad189
Fix step-kms-plugin name
maraino Jul 2, 2025
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
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,27 @@ Here's a quick example, combining `step oauth` and `step crypto` to get and veri

![Animated terminal showing step in practice](https://smallstep.com/images/blog/2018-08-07-unfurl.gif)

## Plugins

A plugin is an executable file named using the format `step-<name>-plugin`.
Plugins must be available in your `$PATH` or in the `$STEPPATH/plugins`
directory.

When you run `step <name>`, the CLI will automatically execute the corresponding
plugin if it exists.

Some known plugins include:

- [**step-kms-proxy**](https://github.com/smallstep/step-kms-plugin): Manage
keys and certificates stored in a KMS, including HSMs, TPMs, YubiKeys, the macOS
Keychain, and cloud KMSs.
- [**step-kmsproxy-plugin**](https://github.com/orbit-online/step-kmsproxy-plugin):
Provides an HSM/KMS-backed authenticating proxy for mTLS services. Thanks to
[@andsens](https://github.com/andsens) for creating and maintaining this plugin!

[`step-kms-proxy`] is also integrated directly into `step` to create
certificates, generate CSRs, sign tokens, and more using KMS-backed keys.
Copy link
Member

@hslatman hslatman Jul 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Should this go with the step-kms-plugin bullet? Or should it be step-kmsproxy-plugin?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I tried to do that but in markdown it goes to a new paragraph.

  • step-kms-plugin data ta data da long line .... long line ... long line ... long line ... long line ... long line ... long line ... long line

This plugin is also integrated

  • step-kmsproxy-plugin foo bar zar

Copy link
Collaborator Author

@maraino maraino Jul 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

It's in a new paragraph:
image

Copy link
Member

@hslatman hslatman Jul 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

But can't it be combined in the same bullet as step-kms-plugin, in a new sentence right after, by putting it on the same line? Or do you intentionally want this to be separate, because of the "integrated directly" being a more tight integration between step and the plugin? Even in that case, I think it'd be good to put it with the rest of the bullet, as this list could grow, and it being more out of context in that case.


## Community

* Connect with `step` users on [GitHub Discussions](https://github.com/smallstep/certificates/discussions) or [Discord](https://bit.ly/step-discord)
Expand Down
Loading