osintui 0.1.1

Open Source Intelligence Terminal User Interface
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

<div align="center">
  <h1>osintui</h1>
  <p> Open Source Intelligence Terminal User Interface </p>
  <!-- Badges -->
  <p>
    <a href="https://github.com/wssheldon/osintui/graphs/contributors">
      <img src="https://img.shields.io/github/contributors/wssheldon/osintui" alt="contributors" />
    </a>
    <a href="">
      <img src="https://img.shields.io/github/last-commit/wssheldon/osintui" alt="last update" />
    </a>
    <a href="https://github.com/wssheldon/osintui/stargazers">
      <img src="https://img.shields.io/github/stars/wssheldon/osintui" alt="stars" />
    </a>
    <a href="https://github.com/wssheldon/osintui/issues/">
      <img src="https://img.shields.io/github/issues/wssheldon/osintui" alt="open issues" />
    </a>
    <a href="https://github.com/wssheldon/osintui/blob/master/LICENSE">
      <img src="https://img.shields.io/github/license/wssheldon/osintui.svg" alt="license" />
    </a>
  </p>
  <h4>
    <a href="https://github.com/wssheldon/osintui/issues/">Report Bug</a>
    <span> · </span>
    <a href="https://github.com/wssheldon/osintui/issues/">Request Feature</a>
  </h4>
</div>
<br />
<div align="center">
  <img src="assets/demo.gif" alt="screenshot" />
</div>

----

## Installation

First, install [Rust](https://www.rust-lang.org/tools/install) (using the recommended rustup installation method) and then

```
cargo install osintui
```

## Configuration

osintui expects a TOML configuration file stored at `~/.osintui/config/config.toml` that sets the necessary API tokens for each service. The configuration file will be created for you on first run if one was not found.

```toml
[keys]
virustotal = "api_key"
shodan = "api_key"
```

## Hotkeys

| Key         | Description |
| ----------- | ----------- |
| h           | Home        |
| /           | Input       |
| q           | Back        |
| s           | Shodan      |
| v           | VirusTotal   |
| →           | Move Right  |
| ←           | Move Left   |
| ↑           | Move Up     |
| ↓           | Move Down   |

## Credits

⭐ **[spotify-tui](https://github.com/Rigellute/spotify-tui)**

The software architecture is almost entirely modeled after spotify-tui. The codebase was invaluable in learning how to cleanly manage complex TUI state and implement generic handling of TUI components.

⭐ **[wtfis](https://github.com/pirxthepilot/wtfis)**

I needed a good first project to learn rust and wtfis was the primary source of inspiration for osintui.