This is a public repository for community created CF CLI plugins. To submit your plugin approval, please submit a pull request according to the guidelines below.
- You need to have git installed
- Clone this repo
git clone https://github.com/cloudfoundry-incubator/cli-plugin-repo
Include your plugin information in
repo-index.yml, here is an example of a new plugin entry
- name: new_plugin description: new_plugin to be made available for the CF community version: 1.0.0 created: 2015-01-31T00:00:00Z updated: 2015-01-31T00:00:00Z company: authors: - name: Sample-Author homepage: https://github.com/sample-author contact: email@example.com homepage: https://github.com/sample-author/new_plugin binaries: - platform: osx url: https://github.com/sample-author/new_plugin/releases/download/v1.0.0/echo_darwin checksum: 2a087d5cddcfb057fbda91e611c33f46 - platform: win64 url: https://github.com/sample-author/new_plugin/releases/download/v1.0.0/echo_win64.exe checksum: b4550d6594a3358563b9dcb81e40fd66 - platform: linux32 url: https://github.com/sample-author/new_plugin/releases/download/v1.0.0/echo_linux32 checksum: f6540d6594a9684563b9lfa81e23id93
Please make sure the spacing and colons are correct in the entry. The following descibes each field's usage.
Name of your plugin, must not conflict with other existing plugins in the repo.
Describe your plugin in a line or two. This desscription will show up when your plugin is listed on the command line
Version number of your plugin, in [major].[minor].[build] form
Date of first submission of the plugin, in ISO 8601 Combined Date and Time with Timezone Format
Date of last update of the plugin, in ISO 8601 Combined Date and Time with Timezone Format
Optional field detailing company or organization that created the plugin
Fields to detail the authors of the plugin
name: name of author
homepage: Optional link to the homepage of the author
contact: Optional ways to contact author, email, twitter, phone etc ...
Link to the homepage where the source code is hosted. Currently we only support open source plugins
This section has fields detailing the various binary versions of your plugin. To reach as large an audience as possible, we encourage contributors to cross-compile their plugins on as many platforms as possible. Go provides everything you need to cross-compile for different platforms
platform: The os for this binary. Supports
url: HTTPS link to the binary file itself
checksum: SHA-1 of the binary file for verification
After making the changes, fork the repository
Add your fork as a remote
cd $GOPATH/src/github.com/cloudfoundry-incubator/cli-plugin-repo git remote add your_name https://github.com/your_name/cli-plugin-repo
Push the changes to your fork and submit a Pull Request
Running your own Plugin Repo Server
Included as part of this repository is the CLI Plugin Repo (CLIPR), a reference implementation of a repo server. For information on how to run CLIPR or how to write your own, please see the CLIPR documentation here.