create-nilgirisecurity v1.2.1

Before we go to Setup Lets See what are the prerequisites

Prerequisites

1. Node.js: Ensure you have Node.js installed.
2. IDE: This project is written in TypeScript, so you'll need to IDE Which Supports NodeJs, For Example : VScode , Intelli ,Etc.
3. AI API Key and EndPoint: This Project is AI-driven,Hence User are requested to get ready with AI API Auth Key and End Point .

Setup : Install and Run

Install Depencency:

npm install create-nilgirisecurity --save -d

Parameters

Running the Application

To run the runFeroxbusterAnalysis method, you need to import and call the method in your script.

Example: testFile.ts

import { runFeroxbusterAnalysis } from "./src/tests/main";

const aiEndpoint = 'https://api.openai.com/v1/completions';
const aiApiKey = 'sk-xxxxxx12345';
const systemUnderTestUrl = 'https://example.com';

runFeroxbusterAnalysis(aiEndpoint, aiApiKey, systemUnderTestUrl)
  .then(() => console.log('Feroxbuster analysis completed!'))
  .catch(err => console.error('Error during analysis:', err));

Run the File

If you’re using Node.js, you can run the file by executing the following command in your terminal:

node <your-file-name>.js

If you are running your file in Type Script then follow this Step

Prerequisites

1. Ensure you have Node.js and TypeScript installed on your machine.
   • You can download Node.js from here.
   • To install TypeScript globally, run the following command:

     npm install -g typescript

Steps to Run

1. Compile the TypeScript file: In your terminal, navigate to the project folder and run the following command to compile the TypeScript file:

   tsc <your-file-name>.ts
   node <your-file-name>.js
   ts-node <your-file-name>.ts