nomiscz/NetBird CLI Connect

Connect your workflow to your NetBird network

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
setup-keyEphemeral, reusable NetBird setup keyyes
management-urlNetBird management URL (cloud or self-hosted)nohttps://api.netbird.io:443
hostnamePeer name shown in the NetBird dashboardno""
versionNetBird release for the official installer (NETBIRD_RELEASE). Defaults to "latest". Pin e.g. "0.73.2" to match your fleet.nolatest
preshared-keyWireGuard preshared key, if your peers require oneno""
allow-sshEnable NetBird SSH access to the runner (default false)nofalse
wait-for-dnsWait until the local NetBird DNS resolver is ready before finishing. Enable when subsequent steps resolve private hostnames via NetBird DNS. Implied when dns-hosts is non-empty.nofalse
dns-hostsComma-separated hostnames or URLs that must resolve to private IPs only (NetBird CGNAT 100.64/10 or RFC1918) before the action finishes. Needed for split-horizon names: if public DNS wins while NetBird DNS is still settling, later steps call the API from outside the mesh (e.g. 403) instead of over NetBird. Implies wait-for-dns.no""
dns-timeoutMax seconds to wait for local DNS (and dns-hosts, when set). Used when wait-for-dns is true or dns-hosts is non-empty.no60
github-tokenPassed to the official installer as GITHUB_TOKEN (avoids API rate limits). Defaults to the workflow token.no${{ github.token }}

no outputs