This guide explains how to validate one router repository and compare a high availability pair.
Use Node.js 26 or later and install the package in each router configuration repository.
Install Bash when the repository contains shell scripts. Preflight runs bash -n on those scripts.
| Command | Purpose |
|---|---|
core-cli |
Print help. |
core-cli --help |
Print help. |
core-cli --version |
Print the package version. |
core-cli preflight |
Validate the current router repository. |
core-cli compare <partner repo> |
Validate two partner repositories. |
Run core-cli preflight from the root of a router configuration repository.
Run core-cli compare ../partner from each repository.
The compare command accepts a filesystem path to the partner repository.
The commands do not call router-native validators, reload services, or change router configuration.
Use --help or --version only as the sole argument.
The compare command requires exactly one non-empty partner path.
Preflight checks formatting, package metadata, required files, syntax, and supported configuration files.
It verifies that package.json and package-lock.json identify the same supported package and version.
The package name and version must match the package lock file.
It parses JSON, JSONC, YAML, and Kea configuration files.
It runs node --check on JavaScript module files and bash -n on shell scripts.
It validates supported files under etc/, var/, and scripts/ with the bundled Node.js validators.
It accepts the system-managed includes /etc/crypto-policies/back-ends/bind.config and /etc/named.root.key without repository copies.
The repository must contain these paths:
etc/chrony.confetc/named.confetc/frr/daemonsetc/frr/frr.confetc/haproxy/haproxy.cfgetc/kea/kea-dhcp4.confetc/kea/kea-dhcp6.confetc/kea/kea-dhcp-ddns.confetc/kea/kea-ctrl-agent.confetc/keepalived/keepalived.confetc/conntrackd/conntrackd.confetc/sysconfig/iptablesetc/sysconfig/ip6tablesetc/wireguard/wg0.conf
Preflight can create ignored test coverage or log files. It does not reload services.
Compare checks that both repositories have different package names.
It compares the file inventory and contents under etc/, var/, and scripts/.
It permits only documented HA-specific differences and checks that paired values agree or use reciprocal partner values.
Pair checks include FRR peer addresses, autonomous system numbers, and neighbor sets. Compare checks reciprocal rankings for external neighbors with changed weights. Neighbors with equal weights in both repositories do not change the ranking check.
They include Kea DHCPv4 HA roles and URLs, Keepalived VRRP IDs and virtual addresses, and reciprocal priorities. They also include conntrackd peer identifiers and FRR connected prefix identifiers. Other unexpected file or content differences fail the compare command. The compare command reads files and does not invoke router-native tools.
| Code | Meaning |
|---|---|
0 |
The command completed successfully. |
1 |
Repository or pair validation failed. |
2 |
The command received invalid syntax or an unsupported option. |
If preflight reports a missing required file, add the path to the router repository.
If shell validation cannot start, install Bash and make bash available on PATH.
If preflight reports formatting errors, run npm run format and inspect the changes.
If compare reports a difference, inspect both files and correct the unexpected value.
If compare reports a peer mismatch, check reciprocal addresses and HA roles in both repositories.
If compare reports an FRR ranking mismatch, inspect changed neighbor rankings on both routers.
Read the web application guide for webhook deployment and dashboard operations. Read the release notes for version history.