Projects STRLCPY GraphSpy Commits af03cb32
🤬
  • ■ ■ ■ ■ ■
    README.md
    skipped 12 lines
    13 13   
    14 14  # Table of Contents
    15 15   
    16  -- [GraphSpy](#certipy)
     16 +- [GraphSpy](#graphspy)
    17 17  - [Table of Contents](#table-of-contents)
    18 18  - [Quick Start](#quick-start)
     19 + - [Installation](#installation)
     20 + - [Execution](#execution)
    19 21  - [Features](#features)
    20 22  - [Upcoming Features](#upcoming-features)
    21 23  - [Credits](#credits)
    22 24   
    23 25  # Quick Start
    24 26   
    25  -Simply running GraphSpy without any command line arguments will launch GraphSpy and make it available at `http://127.0.0.1:5000` by default.
     27 +## Installation
     28 + 
     29 +The following goes over the recommended installation process using pipx to avoid any dependency conflicts.
     30 + 
     31 +For other installation options and detailed instructions, check the [Installation page](https://github.com/RedByte1337/GraphSpy/wiki/Installation) on the wiki.
     32 + 
     33 +```bash
     34 +# Install pipx (skip this if you already have it)
     35 +python3 -m pip install pipx
     36 +python3 -m pipx ensurepath
     37 + 
     38 +# Install the latest version of GraphSpy from pypi
     39 +python3 -m pipx install graphspy
     40 +```
     41 + 
     42 +## Execution
     43 + 
     44 +After installation, the application can be launched using the `graphspy` command from any location on the system.
     45 + 
     46 +Running GraphSpy without any command line arguments will launch GraphSpy and make it available at `http://127.0.0.1:5000` by default.
     47 + 
     48 +```bash
     49 +graphspy
     50 +```
     51 + 
     52 +Now simply open `http://127.0.0.1:5000` in your favorate browser to get started!
    26 53   
    27 54  Use the `-i` and `-p` arguments to modify the interface and port to listen on.
    28 55   
    29 56  ```bash
    30 57  # Run GraphSpy on http://192.168.0.10
    31  -python .\GraphSpy.py -i 192.168.0.10 -p 80
     58 +graphspy -i 192.168.0.10 -p 80
    32 59  # Run GraphSpy on port 8080 on all interfaces
    33  -python .\GraphSpy.py -i 0.0.0.0 -p 8080
     60 +graphspy -i 0.0.0.0 -p 8080
    34 61  ```
     62 + 
     63 +For detailed instructions and other command line arguments, please refer to the [Execution page](https://github.com/RedByte1337/GraphSpy/wiki/Execution) on the wiki.
    35 64   
    36 65  # Features
    37 66   
    skipped 94 lines
Please wait...
Page is in error, reload to recover