From 1828fa8f35de8415eef176f51c182d2a2d310d5e Mon Sep 17 00:00:00 2001
From: epi052 <43392618+epi052@users.noreply.github.com>
Date: Sat, 8 Feb 2020 06:27:18 -0600
Subject: [PATCH] added status command; updated install instructions; fixed
 typo (#16)

---
 docs/api/commands.rst          | 14 +++++++--
 docs/overview/installation.rst | 54 ++++++++++++++++++----------------
 recon/__init__.py              |  2 +-
 3 files changed, 42 insertions(+), 28 deletions(-)

diff --git a/docs/api/commands.rst b/docs/api/commands.rst
index b2f97bc..f545f33 100644
--- a/docs/api/commands.rst
+++ b/docs/api/commands.rst
@@ -1,7 +1,7 @@
 Commands
 ========
 
-``recon-pipeline`` provides two commands ``install`` and ``scan``.  All other commands are inherited
+``recon-pipeline`` provides three commands ``install``, ``scan``, and ``status``.  All other commands are inherited
 from `cmd2 <https://github.com/python-cmd2/cmd2>`_.
 
 .. _install_command:
@@ -22,4 +22,14 @@ scan
 .. argparse::
     :module: recon
     :func: scan_parser
-    :prog: install
\ No newline at end of file
+    :prog: scan
+
+.. _status_command:
+
+status
+######
+
+.. argparse::
+    :module: recon
+    :func: status_parser
+    :prog: status
\ No newline at end of file
diff --git a/docs/overview/installation.rst b/docs/overview/installation.rst
index e207a8e..1e5d019 100644
--- a/docs/overview/installation.rst
+++ b/docs/overview/installation.rst
@@ -13,9 +13,29 @@ Manual Steps
 
 First, the manual steps to get cmd2 installed in a virtual environment are as follows (and shown below)
 
+Kali
+----
+
 .. code-block:: console
 
     apt install pipenv
+
+
+Ubuntu 18.04
+------------
+
+.. code-block:: console
+
+    sudo apt install python3-pip
+    pip install --user pipenv
+    echo "PATH=${PATH}:~/.local/bin" >> ~/.bashrc
+    bash
+
+Both OSs After ``pipenv`` Install
+---------------------------------
+
+.. code-block:: console
+
     git clone https://github.com/epi052/recon-pipeline.git
     cd recon-pipeline
     pipenv install cmd2
@@ -31,6 +51,8 @@ Everything Else
 After manual installation of cmd2_ is complete, the recon-pipeline shell provides its own :ref:`install_command` command (seen below).
 A simple ``install all`` will handle all installation steps.  Installation has **only** been tested on **Kali 2019.4**.
 
+    **Ubuntu-18.04 Note**: You may consider running ``sudo -v`` prior to running ``./recon-pipeline.py``. ``sudo -v`` will refresh your creds, and the underlying subprocess calls during installation won't prompt you for your password. It'll work either way though.
+
 Individual tools may be installed by running ``install TOOLNAME`` where ``TOOLNAME`` is one of the known tools that make
 up the pipeline.
 
@@ -45,32 +67,14 @@ like Jon Snow, it knows nothing.
 Alternative Distros
 ###################
 
-If you're using a different distribution (i.e. not Kali), meeting the criteria below should be sufficient
+In v0.8.1, an effort was made to remove OS specific installation steps from the installer.  However, if you're
+using an untested distribution (i.e. not Kali/Ubuntu 18.04), meeting the criteria below **should** be sufficient
 for the auto installer to function:
 
-- systemd-based system (luigid is installed as a systemd service)
-- derivative of debian (some tools are installed using apt)
+- systemd-based system (``luigid`` is installed as a systemd service)
+- python3.6+ installed
+- ``pip`` installed
 
-The alternatives would be to manually install each tool or to modify the distro-specific portions of the commands
-laid out in ``recon.__init__.py``.  For example, on Fedora, you could change the package manager from ``apt-get`` to
-``dnf`` and remove any ``apt-get`` specific options.
+With the above requirements met, following the installation steps above starting with ``pipenv`` install should be sufficient.
 
-Example from ``recon.__init__.py``
-
-.. code-block:: python
-
-    "pipenv": {
-        "installed": False,
-        "dependencies": None,
-        "commands": ["sudo apt-get install -y -q pipenv"],
-    },
-
-would become
-
-.. code-block:: python
-
-    "pipenv": {
-        "installed": False,
-        "dependencies": None,
-        "commands": ["sudo dnf install -y pipenv"],
-    },
+The alternative would be to manually install each tool.
\ No newline at end of file
diff --git a/recon/__init__.py b/recon/__init__.py
index dd94bc4..dc5802e 100644
--- a/recon/__init__.py
+++ b/recon/__init__.py
@@ -217,7 +217,7 @@ scan_parser.add_argument("--extensions", help="list of extensions for gobuster (
 scan_parser.add_argument(
     "--sausage",
     action="store_true",
-    help="ppen a web browser to Luigi's central scheduler's visualization site (see how the sausage is made!)",
+    help="open a web browser to Luigi's central scheduler's visualization site (see how the sausage is made!)",
 )
 scan_parser.add_argument(
     "--local-scheduler", action="store_true", help="use the local scheduler instead of the central scheduler (luigid)"