Tools#
Five programs live outside the agent. Two of them ship on the router; three are laboratory and build tooling that never leave a workstation or a runner. All five are Python 3 standard library or POSIX shell — the project has no build dependencies and CI will not grow a toolchain.
| Tool | Ships on the router | For |
|---|---|---|
opnsense-import.py | yes, as /usr/bin/wheelhouse-opnsense-import | Turning an OPNsense config.xml into router commands plus a report, and checking a live router against it afterwards. |
wheelhouse-seed.py | no | Building an unattended-install seed image or directory. |
install.sh | no | The laboratory installer: put an agent on a host that can reach a router's API. |
sign.sh | no | Building and verifying a manifest of a binary and its UI assets, and signing checksums. |
check-images.py | no | Checking, and pinning, the catalogue's container images. |
Two more programs ship on the router but belong to the installer rather than to this
list: wheelhouse-install and wheelhouse-autoinstall. They are documented under
Answer-file keys and
Where the installer looks for a seed.
Two helpers ship under /usr/lib/wheelhouse/ and are called by those two, never by hand:
seed-to-answers.py (Seed cloud-config keys) and
install-driver.py, which drives the base installer through a pseudo-terminal and stops
rather than guessing at an unknown prompt.
Which one you want#
| If you are | Use |
|---|---|
| Migrating from OPNsense | opnsense-import.py, then wheelhouse-seed.py |
| Installing a machine with nobody at the keyboard | wheelhouse-seed.py |
| Running the agent against a router from another box | install.sh |
| Checking what you downloaded | sign.sh |
| Auditing what the app catalogue would pull | check-images.py |
See also#
- Files and directories — where each of these lands.
- The
.deb— which of them the package carries. - Answer-file keys
- Where the installer looks for a seed
- Migrate from OPNsense
Checked against#
tools/opnsense-import.py,
tools/wheelhouse-seed.py,
install/install.sh,
install/sign.sh,
scripts/check-images.py,
packaging/build-deb.py,
packaging/install-driver.py,
packaging/seed-to-answers.py.