Skip to content

Commit 0ec2b93

Browse files
committed
Add README
1 parent 459d968 commit 0ec2b93

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
Log Stream CLI Plugin
2+
[![Concourse Badge][ci-badge]][ci-tests]
3+
====================
4+
5+
The Log Stream CLI Plugin is a [CF CLI][cf-cli] plugin to retrieve logs from
6+
a Loggregator V2 stream
7+
8+
### Installing Plugin
9+
10+
#### From CF-Community
11+
12+
```
13+
cf install-plugin -r CF-Community "log-stream"
14+
```
15+
16+
#### From Binary Release
17+
18+
1. Download the binary for the [latest release][latest-release] for your
19+
platform.
20+
1. Install it into the cf cli:
21+
22+
```
23+
cf install-plugin download/path/log-stream-cli
24+
```
25+
26+
#### From Source Code
27+
28+
Make sure to have the [latest Go toolchain][golang-dl] installed.
29+
30+
```
31+
go get code.cloudfoundry.org/log-stream-cli/cmd/log-stream-cli
32+
cf install-plugin $GOPATH/bin/log-stream-cli
33+
```
34+
35+
### Usage
36+
37+
#### Log Stream
38+
```
39+
$ cf log-stream --help
40+
NAME:
41+
log-stream - Stream all messages of all types from Loggregator
42+
43+
USAGE:
44+
log-stream <source-id> [<source-id>] [options]
45+
46+
OPTIONS:
47+
--type, -t Filter the streamed logs. Available: 'log','event','counter','gauge','timer'. Allows multiple.
48+
```
49+
50+
[cf-cli]: https://code.cloudfoundry.org/cli
51+
[ci-badge]: https://loggregator.ci.cf-app.com/api/v1/pipelines/products/jobs/log-stream-cli-tests/badge
52+
[ci-tests]: https://loggregator.ci.cf-app.com/teams/main/pipelines/products/jobs/log-stream-cli-tests
53+
[golang-dl]: https://golang.org/dl/
54+
[latest-release]: https://github.com/cloudfoundry/log-stream-cli/releases/latest
55+

0 commit comments

Comments
 (0)