aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: a06a02a05249a457a8be7bedafe9b7ce63bbd467 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# good_feeder

Dumps and colorizes Jenkins RSS feeds.

## Usage

```
usage: good_feeder [-h] [-a AUTH] [-L] [--insecure] [--html] [-S SEP] [-l] [-f] [-s [SEARCH]] [-n] [-V] [jenkins_url]

good_feeder v{vesion_here}

positional arguments:
  jenkins_url           URL to server, folder, or job

optional arguments:
  -h, --help            show this help message and exit
  -a AUTH, --auth AUTH  Format: "username:token" (or omit "-a" and use JENKINS_AUTH environment variable)
  -L, --localtime       Convert server UTC timestamp to local time
  --insecure            Disable SSL certificate verification
  --html                Output as html (i.e. email)
  -S SEP, --sep SEP     default string: 'ยป', max length: 2
  -l, --latest          Show only latest builds
  -f, --failed          Show only failed builds
  -s [SEARCH], --search [SEARCH]
                        Filter output on sub-string (case-sensitive)
  -n, --negate          Negate search filter
  -V, --version         Show version
```

## Example

```sh
# Anonymous query
good_feeder https://my_jenkins_host

# Authenticated query (via argument)
good_feeder -a "myUser:myPassword" https://my_jenkins_host

# Authenticated query (via environment)
JENKINS_AUTH="myUser:myPassword"
export JENKINS_AUTH
good_feeder https://my_jenkins_host
```