Skip to content

Commit

Permalink
Added CLI documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gboddin committed Jul 26, 2020
1 parent 07fc274 commit df63568
Showing 1 changed file with 45 additions and 2 deletions.
47 changes: 45 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,52 @@
# LeakIXClient

This is a Go library making queries to LeakIX easier.
This is a Go CLI & library making queries to LeakIX easier.

## Command line usage

## Usage
```sh
$ leakix -h
Usage of leakix:
./leakix -q '*' -l 200

-l int
Limit results output, default to 100 (default 100)
-q string
Specify search query, default to * (default "*")
-s string
Specify scope, default to leak (default "leak")
-t string
Specify output template, default to "{{ .Ip }}:{{ .Port }}" (default "{{ .Ip }}:{{ .Port }}")

$ leakix -l 2 -q "protocol:web AND plugin:GitConfigPlugin" -t "{{ .Ip }}:{{ .Port }} : {{ .Data }}"
178.62.217.44:80 : Found git deployment configuration
[core]
repositoryformatversion = 0
filemode = false
bare = false
logallrefupdates = true
[remote "origin"]
url = https://gitlab.com/lyranalytics/lyra-website.git
fetch = +refs/heads/*:refs/remotes/origin/*
[branch "abdulrahman"]
remote = origin
merge = refs/heads/abdulrahman

2604:a880:800:a1::10f:1001:80 : Found git deployment configuration
[core]
repositoryformatversion = 0
filemode = true
bare = false
logallrefupdates = true
[remote "origin"]
url = https://github.com/mautic/mautic.git
fetch = +refs/heads/*:refs/remotes/origin/*
[branch "staging"]
remote = origin
merge = refs/heads/staging
```

## Library usage

```golang
package main
Expand Down

0 comments on commit df63568

Please sign in to comment.