Neptune

neptune analyze

Run the full analysis pipeline on a firmware binary

neptune analyze

The primary command. Runs all seven pipeline stages: extraction, disassembly, scanning, fingerprinting, AI analysis, SBOM generation, and vulnerability correlation.

Usage

neptune analyze <BINARY> [OPTIONS]

Arguments

ArgumentDescription
<BINARY>Path to the firmware binary file

Options

FlagDefaultDescription
-d, --depth <DEPTH>standardAnalysis depth: quick, standard, or deep
-a, --arch <ARCH>auto-detectOverride architecture detection: x86, x86_64, arm, arm64, mips, riscv
-o, --output <DIR>.Output directory for reports
-f, --format <FORMAT>allOutput formats: cyclonedx, spdx, html, json, all
--api-key <KEY>Anthropic API key (or set ANTHROPIC_API_KEY env var)
--sig-db <PATH>neptune-signatures.dbPath to signature database
--no-aiSkip AI analysis stage
--min-confidence <FLOAT>0.3Minimum confidence threshold (0.0–1.0)
--jsonOutput results as JSON to stdout (for CI/CD)
-v, --verboseEnable debug logging
-q, --quietSuppress all output except errors and final result

Examples

# Full pipeline with defaults
neptune analyze firmware.bin

# Deep analysis on ARM64 binary
neptune analyze firmware.bin --depth deep --arch arm64

# No AI, higher confidence threshold
neptune analyze firmware.bin --no-ai --min-confidence 0.5

# CycloneDX only, specific output directory
neptune analyze firmware.bin --format cyclonedx --output ./reports

# JSON output for CI pipelines
neptune analyze firmware.bin --json --quiet

Pipeline stages

StageDescriptionSkippable
ExtractionParse binary format, extract sections, compute metadataNo
DisassemblyDisassemble code, detect function boundariesNo
Quick scanString matching, constant detection, compiler IDNo
FingerprintingMatch functions against signature databaseNo
AI analysisClaude analyzes disassembly patterns--no-ai
SBOM generationProduce CycloneDX, SPDX, VEX, HTML, JSONNo
Vulnerability correlationCheck NVD and OSVNo

Analysis depth

  • quick — Strings and constants only (equivalent to neptune scan)
  • standard — All stages with balanced function sampling
  • deep — Exhaustive analysis with maximum function coverage

On this page