📝 Updated README

Redid command help, added alert command help and shortened examples.
This commit is contained in:
perp 2023-08-12 00:19:33 +01:00
parent 3e6efdb181
commit 92fcb205a3

View File

@ -23,16 +23,18 @@ go install .
```
## ❓ Commands
| Todo | Working | Broken |
| ------------ | ------- | ------ |
| convert | count | search |
| data(x) | host | domain |
| download (x) | info | |
| org (x) | myip | |
| init | stats | |
| radar (x) | alert | |
| stream (x) | scan | |
| | version | |
| Working | Todo |
| ------- | ------------ |
| count | data (x) |
| host | download (x) |
| init | org (x) |
| info | radar (x) |
| myip | stream (x) |
| stats | domain (x) |
| search | |
| alert | |
| scan | |
| version | |
##### x = limited key
## ⚡️ Usage
@ -45,9 +47,9 @@ Usage:
Available Commands:
count Return number of results for a search
domain Return domain information
host Return host information
info Return your account information
init Initialize Shogo
myip Return your IP address
search Return a search result
stats Return facet stats on a search
@ -63,6 +65,26 @@ Flags:
Use "shogo [command] --help" for more information about a command.
```
```
Manage your network alerts
Usage:
shogo alert [flags]
shogo alert [command]
Available Commands:
clear Clear all alerts
create Create an alert
delete Delete an alert
info Return alert information
list Return all the active alerts
Flags:
--no-color Disable color output
-h, --help help for alert
Use "shogo alert [command] --help" for more information about a command.
```
```
Return number of results for a search
Usage:
@ -113,12 +135,12 @@ Use "shogo alert [command] --help" for more information about a command.
### Get key information
```
shogo info -a -p
shogo info -p
```
### Get query count
```
shogo count "apache" "nginx"
shogo count apache
```
### Get alert list