Skip to main content

Metalware CLI tool

Project description

metalware

CLI for Metalware, a firmware security analysis platform. Submit ARM Cortex-M firmware ELF binaries for automated fuzzing and security analysis, monitor results, and manage analyses from the command line.

Installation

pip install metalware

Requires Python 3.10 or later.

Quick Start

# Configure server URL and API key
metalware setup

# Submit a firmware binary for analysis
metalware submit firmware.elf

# Check status of all active analyses
metalware status

CLI Reference

metalware setup

Interactive setup. Prompts for server URL and API key, tests connectivity, and saves configuration to ~/.config/metalware/config.json.

metalware submit <firmware.elf>

Submit a firmware ELF binary for analysis.

Option Default Description
--mcu cortexm Target MCU architecture
--workers server default Number of fuzzing workers
--timeout server default Analysis timeout (e.g. 10m, 24h)
--tag, -t Tag to attach (repeatable, up to 16)

metalware status [analysis_id]

Without an ID, lists active and queued analyses. With an ID, shows full detail for that analysis.

Option Description
--watch, -w Poll for updates every 5 seconds
--all, -a Include completed analyses
--tag, -t Filter by tag

metalware stop <analysis_id>

Stop a running analysis.

metalware timeout <seconds>

Set the server-wide analysis timeout. Pass 0 to disable.

Configuration

The CLI reads from ~/.config/metalware/config.json (written by metalware setup). Two environment variables override the config file:

  • METALWARE_URL - Server URL
  • METALWARE_API_KEY - API key

Documentation

Full documentation is available at metalware.com/docs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metalware-2026.3.13.1.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

metalware-2026.3.13.1-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

Details for the file metalware-2026.3.13.1.tar.gz.

File metadata

  • Download URL: metalware-2026.3.13.1.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for metalware-2026.3.13.1.tar.gz
Algorithm Hash digest
SHA256 df01c32031d02586d1db3c8c563e72272af20f4d607dae1a0284151fb88813cf
MD5 f8fbea837fbd31adeaacdb5985cc090c
BLAKE2b-256 3ce402f4ed5a3a42b075947c4b7f52a82584259dc6e2e5afa96f920419a80c6a

See more details on using hashes here.

File details

Details for the file metalware-2026.3.13.1-py3-none-any.whl.

File metadata

File hashes

Hashes for metalware-2026.3.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c0aa2029e13f39200321d6ea9f82ea7a403d8da31d6adc24b1ce5d8a68a7c3a5
MD5 ecb960bc66938fd93e741973afdc1f98
BLAKE2b-256 8784798bff3727b826a086c84edc241a324eb1adefdb1bd648f2f29da67f0f31

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page