<!-- Copyright (c) 2026 defconxt. All rights reserved. -->
<!-- Licensed under AGPL-3.0 — see LICENSE file for details. -->
<!-- NERF is a trademark of defconxt. -->
# analyzing-firmware-images — API Reference

## Agent Script

| Command | Description |
|---------|-------------|
| `extract --target <path>` | Extract filesystem from firmware image. |
| `analyze --target <path>` | Analyze firmware structure and metadata. |
| `audit --target <path>` | Audit extracted firmware for security issues. |

## Usage Examples

```bash
# Extract filesystem from firmware image.
node scripts/agent.js extract --target ./sample

# Analyze firmware structure and metadata.
node scripts/agent.js analyze --target ./sample

# Audit extracted firmware for security issues.
node scripts/agent.js audit --target ./sample
```

## Output Format

All commands return JSON with the following structure:

```json
{
  "action": "<command>",
  "result": {
    "action": "<command>",
    "status": "complete",
    "domain": "<domain>",
    "technique": "analyzing-firmware-images"
  }
}
```
