https://github.com/pivotal-cf/spring-cloud-services-cli-plugin
A Cloud Foundry CLI plugin for Spring Cloud Services
https://github.com/pivotal-cf/spring-cloud-services-cli-plugin
cli cloudfoundry spring-cloud-services
Last synced: 10 months ago
JSON representation
A Cloud Foundry CLI plugin for Spring Cloud Services
- Host: GitHub
- URL: https://github.com/pivotal-cf/spring-cloud-services-cli-plugin
- Owner: pivotal-cf
- License: apache-2.0
- Created: 2016-10-12T14:22:30.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-07-26T14:04:05.000Z (over 1 year ago)
- Last Synced: 2025-03-27T17:21:20.831Z (11 months ago)
- Topics: cli, cloudfoundry, spring-cloud-services
- Language: Go
- Homepage:
- Size: 5.46 MB
- Stars: 10
- Watchers: 25
- Forks: 17
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# Spring Cloud Services CLI Plugin
This repository provides a [Cloud Foundry CLI](https://github.com/cloudfoundry/cli) plugin for
Spring Cloud Services.
For information on plugin development, see
[Developing a plugin](https://github.com/cloudfoundry/cli/tree/master/plugin/plugin_examples).
## Building
To build the plugin, run:
```bash
$ rm $GOPATH/bin/spring-cloud-services-cli-plugin
$ cd spring-cloud-services-cli-plugin
$ go install -ldflags="-X main.pluginVersion=$VERSION"
```
This builds the plugin with the given version number.
Note: if an invalid version number is provided, the build will succeed, but the plugin will fail to install (with exit status code 64).
To print the version number of the built plugin, run it as a stand-alone executable, for example:
```bash
$ $GOPATH/bin/spring-cloud-services-cli-plugin
This program is a plugin which expects to be installed into the cf CLI. It is not intended to be run stand-alone.
Plugin version: 0.0.8
```
## Installing
To install the plugin in the `cf` CLI, first build it and then issue:
```bash
$ cf install-plugin -f $GOPATH/bin/spring-cloud-services-cli-plugin
```
You can also install the plugin from the [Cloud Foundry cf-cli plugins repository](https://plugins.cloudfoundry.org):
```bash
$ cf install-plugin -r CF-Community "spring-cloud-services"
```
The plugin's commands may then be listed by issuing `cf help`.
To update the plugin, uninstall it as follows and then re-install the plugin as above:
```bash
$ cf uninstall-plugin spring-cloud-services
```
## Command docs
The Spring Cloud Services CLI plugin command docs can be generated by running the following commands:
```
$ cd docs
$ ./generate-cli-docs-from-help.bash
```
This needs to be done whenever commands are added, modified, or deleted. Note that the script contains a list of commands which needs to be kept in step with the available commands.
The generated docs may be viewed [here](docs/cli.md).
## Testing
First [install Ginkgo](https://onsi.github.io/ginkgo/).
Run the tests as follows:
```bash
$ cd spring-cloud-services-cli-plugin
$ ginkgo -r
```
## License
The Spring Cloud Services CLI plugin is Open Source software released under the
[Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html).
## Contributing
Contributions are welcomed. Please refer to the [Contributor's Guide](CONTRIBUTING.md).