https://github.com/pivotal-cf/service-instance-logs-cli-plugin
A Cloud Foundry CLI plugin for access service instance logs
https://github.com/pivotal-cf/service-instance-logs-cli-plugin
cli cloudfoundry
Last synced: 4 months ago
JSON representation
A Cloud Foundry CLI plugin for access service instance logs
- Host: GitHub
- URL: https://github.com/pivotal-cf/service-instance-logs-cli-plugin
- Owner: pivotal-cf
- License: apache-2.0
- Created: 2017-05-26T18:14:01.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T01:13:12.000Z (11 months ago)
- Last Synced: 2025-04-14T03:38:47.240Z (10 months ago)
- Topics: cli, cloudfoundry
- Language: Go
- Homepage:
- Size: 5.81 MB
- Stars: 2
- Watchers: 29
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Service Instance Logging CLI Plugin
This repository provides a [Cloud Foundry CLI](https://github.com/cloudfoundry/cli) plugin for
accessing the logs of service instances created by Spring Cloud Dataflow or, in the future, 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/service-instance-logs-cli-plugin
$ cd service-instance-logs-cli-plugin
$ go install -ldflags="-X main.pluginVersion=$(cat version)"
```
This builds the plugin with the current version number in the [version file](version).
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/service-instance-logs-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/service-instance-logs-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 "Service Instance Logging"
```
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 service-instance-logging
```
## Command docs
With the plugin installed in the `cf` CLI, the Service Instance Logs CLI plugin command docs can be generated by running the following commands:
```
$ cd docs
$ ./generate-cli-docs-from-help.sh
```
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 Service Instance Logs 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).