twayback-player/README.md

a simple web interface to analyze html files from the OSINT tool twayback

<div align="center"><h1>twayback-player</h1><div>
<img src="assets/img/latest.svg" style="margin-right: 5px;"> 
<img src="assets/img/os.svg" style="margin-right: 5px;"> 
<img src="assets/img/doc.svg" style="margin-right: 5px;"></div>
<hr>
<b>a simple web interface to analyze html files from the OSINT tool <a href="https://github.com/Mennaruuk/twayback" target="_blank">twayback</a></b>.
<p>(optimized for firefox)</p>
<p align="center">
  <a href="#install">Install</a> |
  <a href="#use">Use</a> |
  <a href="#depends">Depends</a>
</p>
<br>
<img src="assets/img/player.jpg" style="width:80%;"/>
</div>
<br>

## install 

From npm:

```console
user@debian:~$ npm install twayback-player -g
```

From source :

```console
user@debian:~$ tar -xvf twayback-player-master.tar.gz
user@debian:~$ cd twayback-player-master
user@debian:~$ node bin/twayback-player.js
```

## use

```console
Usage: twayback-player [options]

Options:
  -V, --version      output the version number
  -p  --path <path>  full path to twayback folder results
  -h, --help         display help for command
```

## depends

[nodejs and npm](https://nodejs.org/en/)