nomiscz/NetBird CLI Connect
Connect your workflow to your NetBird network
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| setup-key | Ephemeral, reusable NetBird setup key | yes | — |
| management-url | NetBird management URL (cloud or self-hosted) | no | https://api.netbird.io:443 |
| hostname | Peer name shown in the NetBird dashboard | no | "" |
| version | NetBird release for the official installer (NETBIRD_RELEASE). Defaults to "latest". Pin e.g. "0.73.2" to match your fleet. | no | latest |
| preshared-key | WireGuard preshared key, if your peers require one | no | "" |
| allow-ssh | Enable NetBird SSH access to the runner (default false) | no | false |
| wait-for-dns | Wait 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. | no | false |
| dns-hosts | Comma-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-timeout | Max seconds to wait for local DNS (and dns-hosts, when set). Used when wait-for-dns is true or dns-hosts is non-empty. | no | 60 |
| github-token | Passed to the official installer as GITHUB_TOKEN (avoids API rate limits). Defaults to the workflow token. | no | ${{ github.token }} |
Outputs
no outputs