Add New Tool

Adding a new tool is so easy. You can add any types of tools in Spider.

Create Shell Script

Navigate to the tools/scripts directory, choose a category folder, and within that folder, create the script for your tool. This shell script should contain all the instructions for installing the tool.

Let’s have a look at a Python based tool.

#!/bin/bash

# Tool
export tool_language="python"
export tool_directory="Sublist3r"
export branch_name="master"
export has_dependencies=true
export git_repo="https://github.com/aboul3la/Sublist3r"

# Install
source ./core/scripts/libs/install.sh

References:

Variable	Description
tool_language	Language of the tool. Example: Python, Go.
tool_directory	Folder name of tool. You’ll find it under `et` directory. It Should be same as Git repository name.
branch_name	Branch name of the Git repository.
has_dependencies	`true` or `false`.
git_repo	The URL of Git repository.

Create Fixture

Now, go to tools/fixtures/tools directory. Then select/create a category file, example igt.json and insert the new tool data in the following format at the end of the file:

{
  "model": "tools.tool",
  "pk": null,
  "fields": {
    "name": "Sublist3r",
    "lang": "python",
    "directory": "Sublist3r",
    "run": "sublist3r.py",
    "script": "igt/sublist3r.sh",
    "category_slug": "others",
    "git_repo": "https://github.com/aboul3la/Sublist3r",
    "website": "",
    "short_desc": "Fast subdomains enumeration tool for penetration testers."
  }
}

References:

Variable	Description
name	The name of the tool.
lang	Same language as shell script.
directory	Same directory as shell script.
run	Main run filename or command.
script	Installation script path.
category_slug	Slug of tool category.
git_repo	The URL of Git repository.
website	Website of the tool (optional).
short_desc	Short description of the tool.