Skip to main content

npkPy is an unpacker tool for MikroTiks custom npk container format

Project description

Codacy Badge Actions Status codecov


The npkPy package module is an unpacking tool for MikroTiks custom NPK container format. The tool is capable to display the content of any NPK package and to export all container.

"NPK stands for MikroTik RouterOS upgrade package" and since there is no solid unpacking tool for the format available, I want to share my approach of it. The format, in general, is used by MikroTik to install and update the software on MikroTiks routerOs systems.

NPK packages can be found here: MikroTik Archive

The code covers the ability to modify the container payload. Yet, this ability won't be available for cli. Please be aware, that you can't create or modify valid packages since they are signed.

All recent packages are signed with EC-KCDSA signature, 
and there's no way to create a valid npk file unless you know a secret key.


pip install npkPy


$ npkPy is an unpacking tool for MikroTiks custom NPK container format

optional arguments:
  -h, --help            show this help message and exit

  --files FILES         Select one or more files to process
  --srcFolder SRCFOLDER
                        Process all NPK files found recursively in given source folder.
  --glob GLOB           Simple glob. Filter files from --srcFolder which match the given string.

  --dstFolder DSTFOLDER
                        Extract container into given folder

  --showContainer       List all container from selected NPK files
  --exportAll           Export all container from selected NPK files
  --exportSquashFs      Export all SquashFs container from selected NPK files
  --exportZlib          Export all Zlib compressed container from selected NPK files

Common understanding: A file represents an NPK package with multiple containers. Each container 'contains' payloads like descriptions, SquashFs images or Zlib compressed data.

Other unpacking tools

If npkPy does not work for you, check out older approaches of NPK unpacking tools:

Project details

Download files

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

Files for npkPy, version 2020.
Filename, size File type Python version Upload date Hashes
Filename, size npkPy-2020. (49.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size npkPy-2020. (21.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page