Installation

3. Installation#

3.1. From Source#

Clone the repository and install dependencies:

git clone https://github.com/ionsec/flareinspect.git
cd flareinspect
npm install

Run the CLI directly:

node src/cli/index.js --version

Or link it globally for convenient access:

npm link
flareinspect --version

3.2. Docker#

Build the Docker image from the included Dockerfile:

docker build -t flareinspect .

Run an assessment with the container, mounting a volume for output files:

docker run -it --rm \
  -e CLOUDFLARE_TOKEN=YOUR_CLOUDFLARE_TOKEN \
  -v $(pwd)/output:/app/output \
  flareinspect assess

Run the web dashboard with the container:

docker run -it --rm \
  -p 3000:3000 \
  -e CLOUDFLARE_TOKEN=YOUR_CLOUDFLARE_TOKEN \
  -v $(pwd)/data:/app/web/data \
  flareinspect node web/server.js

The Dockerfile uses a multi-stage build on node:22-alpine, runs as a non-root user, and includes a health check.

3.3. Verify Installation#

Confirm that FlareInspect is installed and working:

flareinspect --version

Expected output:

2.0.0

You can also run a quick help check:

flareinspect help

This prints the list of available commands and confirms the CLI is functional.