CF CLI Plugin Development: How to get started


Jeffrey Pak
 

Hello!

The CF CLI team has recently been asked about where to find any information regarding CF CLI plugin development. Here are a few pointers to help you along:

1. If you'd like an example on HOW TO WRITE A PLUGIN, visit https://github.com/cloudfoundry/cli/tree/master/plugin_examples
The README extensively details writing a plugin, the standards involved, and the overall structure regarding plugin development. You can also find example/template plugins in this repo, specifically:
- basic_plugin.go
- echo.go
- interactive.go
- multiple_commands.go

2. You can find all official Cloud Foundry supported plugins on the Cloud Foundry CLI Plugin Repository. https://plugins.cloudfoundry.org/

3. To SUBMIT A PLUGIN to the CF-CLI Plugin Repo, please follow the instructions on the github page.
https://github.com/cloudfoundry-incubator/cli-plugin-repo
If you'd like to make your plugin publicly accessible and open-source, we recommend you submit it to our plugin repository!

If any developer would like to chime in with more tips, please feel free to do so! Also let us know if you have any questions.

Best Regards,
CF CLI Team

Join cf-dev@lists.cloudfoundry.org to automatically receive all group messages.