perp/shogo
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

📝 Updated README

Browse Source 
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
1 changed files with 35 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -23,16 +23,18 @@ go install .
``` ```
## ❓ Commands ## ❓ Commands
| Todo | Working | Broken | | Working | Todo |
| ------------ | ------- | ------ | | ------- | ------------ |
| convert | count | search | | count | data (x) |
| data(x) | host | domain | | host | download (x) |
| download (x) | info | | | init | org (x) |
| org (x) | myip | | | info | radar (x) |
| init | stats | | | myip | stream (x) |
| radar (x) | alert | | | stats | domain (x) |
| stream (x) | scan | | | search | |
| | version | | | alert | |
| scan | |
| version | |
##### x = limited key ##### x = limited key
## ⚡️ Usage ## ⚡️ Usage
@ -45,9 +47,9 @@ Usage:
Available Commands: Available Commands:
count Return number of results for a search count Return number of results for a search
domain Return domain information
host Return host information host Return host information
info Return your account information info Return your account information
init Initialize Shogo
myip Return your IP address myip Return your IP address
search Return a search result search Return a search result
stats Return facet stats on a search stats Return facet stats on a search
@ -63,6 +65,26 @@ Flags:
Use "shogo [command] --help" for more information about a command. 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 Return number of results for a search
Usage: Usage:
@ -113,12 +135,12 @@ Use "shogo alert [command] --help" for more information about a command.
### Get key information ### Get key information
``` ```
shogo info -a -p shogo info -p
``` ```
### Get query count ### Get query count
``` ```
shogo count "apache" "nginx" shogo count apache
``` ```
### Get alert list ### Get alert list