Skip to main content

GitHub

The GitHub repository for NexScan contains the complete source code and is the recommended method for developers who want to contribute or customize the tool. This section covers how to clone, set up, and use NexScan directly from the GitHub repository.

Prerequisites​

Before installing NexScan from GitHub, ensure you have the following prerequisites:

  • Git installed on your system
  • Python 3.8+ with pip package manager
  • Required system permissions to install Python packages
  • Basic knowledge of command-line operations
  • Recommended: Virtual environment management tool (venv or conda)

Note: Some features may require root/administrator privileges depending on your operating system and intended use case.

Procedure​

Follow these steps to install NexScan from the GitHub repository:

For Windows​

# Clone the repository
git clone https://github.com/nexeosecurity/NexScan.git

# Navigate to the project directory
cd NexScan

# Create and activate virtual environment (recommended)
python -m venv nexscan
nexscan\Scripts\activate

# Install required dependencies
pip install -r requirements.txt

For MacOS/Unix​

# Clone the repository
git clone https://github.com/nexeosecurity/NexScan.git

# Navigate to the project directory
cd NexScan

# Create and activate virtual environment (recommended)
python3 -m venv nexscan
source nexscan/bin/activate

# Install required dependencies
pip3 install -r requirements.txt

Note: Make sure to set appropriate execute permissions using:

chmod +x NexScan.py

After successful installation, you can run NexScan using the command line interface. The tool will be available as a command-line utility, and you can access all features through the CLI.

To ensure proper functionality, make sure all dependencies are correctly installed and your Python environment is properly configured. If you encounter any issues during installation, check the troubleshooting section or contact our support team.