Git Product home page Git Product logo

cli-plugin-repo's Introduction

Cloud Foundry CLI Plugin Repository (CLIPR)Build Status

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.

*If you are looking for information about the Plugin Repo Server, please go here

Submitting Plugins

  1. You need to have git installed
  2. Clone this repo git clone https://github.com/cloudfoundry-incubator/cli-plugin-repo
  3. 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-1-31
  updated: 2015-1-31
  company:
  authors:
  - name: Sample-Author
    homepage: http://github.com/sample-author
    contact: [email protected]
  homepage: http://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.

Field Description
name Name of your plugin, must not conflict with other existing plugins in the repo.
description Describe your plugin in a line or two. This desscription will show up when your plugin is listed on the command line
version Version number of your plugin, in [major].[minor].[build] form
created Date of first submission of the plugin, in year-month-day form
updated Date of last update of the plugin, in year-month-day form
company Optional field detailing company or organization that created the plugin
authors 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 ...
homepage Link to the homepage where the source code is hosted. Currently we only support open source plugins
binaries 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 osx, linux32, linux64, win32, win64
url: Link to the binary file itself
checksum: SHA-1 of the binary file for verification
  1. After making the changes, fork the repository

  2. 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
    
  3. 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.