Skip to content

Commit f0fc453

Browse files
committed
Improve README
1 parent 18e2e03 commit f0fc453

2 files changed

Lines changed: 87 additions & 40 deletions

File tree

.github/images/usage.svg

Lines changed: 86 additions & 0 deletions
Loading

README.md

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -67,46 +67,7 @@ docker run --rm -it ghcr.io/essentialkaos/sslcli:latest mydomain.com
6767

6868
### Usage
6969

70-
```
71-
Usage: sslcli {options} host…
72-
73-
Options
74-
75-
--email, -e email User account email (required)
76-
--format, -f format Output result in different formats (text/json/yaml/xml)
77-
--detailed, -d Show detailed info for each endpoint
78-
--ignore-mismatch, -i Proceed with assessments on certificate mismatch
79-
--avoid-cache, -c Disable cache usage
80-
--public, -p Publish results on sslscan.com
81-
--perfect, -P Return non-zero exit code if not A+
82-
--max-left, -M duration Check expiry date (num + d/w/m/y)
83-
--notify, -n Notify when check is done
84-
--quiet, -q Don't show any output
85-
--pager, -G Use pager for long output
86-
--no-color, -nc Disable colors in output
87-
--help, -h Show this help message
88-
--version, -v Show version
89-
90-
Examples
91-
92-
sslcli --register --email john@domain.com --org 'Some Organization' --name 'John Doe'
93-
Register new user account for scanning
94-
95-
sslcli google.com
96-
Check google.com
97-
98-
sslcli -P google.com
99-
Check google.com and return zero exit code only if result is perfect (A+)
100-
101-
sslcli -p -c google.com
102-
Check google.com, publish results, disable cache usage
103-
104-
sslcli -M 3m -q google.com
105-
Check google.com in quiet mode and return error if cert expire in 3 months
106-
107-
sslcli hosts.txt
108-
Check all hosts defined in hosts.txt file
109-
```
70+
<img src=".github/images/usage.svg" />
11071

11172
### Build Status
11273

0 commit comments

Comments
 (0)