shogo/README.md
2024-05-30 05:33:39 +01:00

158 lines
2.9 KiB
Markdown

# Shogo
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
Shogo is a Shodan CLI made in Go
### Features:
+ Prettier printing
+ Faster JSON parsing
+ Faster HTTP requests
+ Multiple command arguments
## Requirements
```
go (1.20+)
```
## Installation
```
git clone https://git.supernets.org/perp/shogo
cd shogo/cmd/shogo
go install .
```
## Commands
| 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
```
Shodan CLI made in Go
Usage:
shogo [flags]
shogo [command]
Available Commands:
count Return number of results for a search
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
version Return shogo version
alert Manage your network alerts
scan Scan an IP/netblock
help Help about any command
Flags:
--no-color Disable color output
-h, --help help for shogo
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:
shogo count [flags]
Flags:
-h, --help help for count
Global Flags:
--no-color Disable color output
```
```
Return your account information
Usage:
shogo info [flags]
Aliases:
info, information
Flags:
-p, --profile Show profile information
-h, --help help for info
Global Flags:
--no-color Disable color output
```
```
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.
```
### Get key information
```
shogo info -p
```
### Get query count
```
shogo count apache
```
### Get alert list
```
shogo alert list
```
### Show alert information
```
shogo alert show <alert-id>
```
## Disclaimer
###### Developers are not responsible for any misuse