Skip to content
jonhadfieldPublic

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

subnets

IPv4 and IPv6 subnet calculator for the terminal — CIDR details, mask input, prefix cheatsheet, host listings, contains/split/supernet, and cloud reserved addresses for AWS, Azure, and GCP.

ci release license

subnets  ·  192.168.0.3/28

╭───────────────────────────╮
│ Address                   │
│ Address       192.168.0.3 │
│ Version       IPv4        │
│ Type          Private     │
│ Legacy class  C           │
╰───────────────────────────╯

╭───────────────────────────────────────────────────╮
│ Subnet                                            │
│ CIDR          192.168.0.0/28                      │
│ Prefix        /28  (28 network bits, 4 host bits) │
│ Subnet mask   255.255.255.240  (0xFFFFFFF0)       │
│ Wildcard      0.0.0.15                            │
│ Network       192.168.0.0                         │
│ Broadcast     192.168.0.15                        │
│ First host    192.168.0.1                         │
│ Last host     192.168.0.14                        │
│ Addresses     16                                  │
│ Usable hosts  14                                  │
│ This host     index 3 of 16                       │
╰───────────────────────────────────────────────────╯

Contents: install · usage · show · sheet · hosts · contains · split · supernet · cloud · json · development · license

install

Homebrew

brew install --cask jonhadfield/tap/subnets

Preferred on macOS: upgrades come through Homebrew, and the cask clears the Gatekeeper quarantine attribute after install.

curl (Linux and macOS)

curl -sL https://raw.githubusercontent.com/jonhadfield/subnets/main/install | sh

Resolves the latest release, downloads the archive for the machine it is run on, checks it against checksums.txt, and installs to /usr/local/bin. The directory is created if needed, and sudo is used only when the destination is not writable. A download that does not match its checksum is refused. On macOS it also clears the Gatekeeper quarantine attribute.

Optional variables (set on the sh end of the pipe, not on curl):

variable meaning
SUBNETS_VERSION a tag to install, e.g. v0.1.2. Default: the latest release
SUBNETS_INSTALL_DIR where to put the binary. Default: /usr/local/bin
GITHUB_URL for a mirror or an enterprise host
curl -sL https://raw.githubusercontent.com/jonhadfield/subnets/main/install | SUBNETS_INSTALL_DIR=~/.local/bin sh

amd64 and arm64 are built for Linux and macOS; anything else is refused with a message rather than a failed download. On macOS, Homebrew above is still the better route for upgrades.

macOS package

Prefer Homebrew above. Some releases also attach subnets_macos.pkg — a signed, notarized, and stapled installer. A notarization ticket cannot be stapled into a bare Mach-O, so Gatekeeper can refuse a tarball download even after Apple notarized it; the .pkg carries the ticket, and files it installs are never quarantined.

When that asset is listed on the releases page, download it and install with:

sudo installer -pkg subnets_macos.pkg -target /

Go

go install github.com/jonhadfield/subnets/cmd/subnets@latest

Requires Go 1.27 or later.

download

Binaries for macOS, Linux, and Windows are on the releases page:

archive platform
subnets_darwin_arm64.tar.gz macOS Apple silicon
subnets_darwin_amd64.tar.gz macOS Intel
subnets_linux_amd64.tar.gz Linux x86_64
subnets_linux_arm64.tar.gz Linux arm64
subnets_windows_amd64.zip Windows x86_64

Each release also publishes checksums.txt. On Windows, unzip and put subnets.exe somewhere on your PATH.

usage

subnets [addr|cidr] [mask] [flags]
subnets sheet [flags]
subnets hosts <cidr> [flags]
subnets contains <outer> <inner> [flags]
subnets split <cidr> (--prefix N | --count N) [flags]
subnets supernet <cidr> [<cidr>...] [flags]

Pass an address, a CIDR, or an address with a dotted mask (192.168.0.3/255.255.255.240 or as two arguments). A bare IPv4 address is /32; a bare IPv6 address is /128. Bare values are never treated as masks alone (128.0.0.0 is a host, not /1).

command what it does
subnets <addr|cidr> [mask] subnet details for one address or prefix
subnets sheet prefix length / subnet mask cheatsheet
subnets hosts <cidr> list every address in a subnet
subnets contains <outer> <inner> whether a prefix contains an address or prefix
subnets split <cidr> split into equal subnets (--prefix or --count)
subnets supernet <cidr…> aggregate prefixes into supernets where possible
flag where meaning
--aws show, hosts mark addresses reserved by AWS VPC
--azure show, hosts mark addresses reserved by Azure VNet
--gcp show, hosts mark addresses reserved by Google Cloud VPC
--json all commands emit machine-readable JSON
--ipv6 sheet show the IPv6 prefix cheatsheet
--limit N hosts maximum addresses to print (default 256)
--prefix N split new prefix length for each subnet
--count N split number of equal subnets (power of two)
-v, --version root print the build version
-h, --help any help for that command

--aws, --azure, and --gcp are mutually exclusive.

subnets 192.168.0.3/28
subnets 192.168.0.3 255.255.255.240
subnets 192.168.0.0/28 --aws
subnets 10.0.0.0/24 --azure
subnets 10.0.0.0/24 --gcp
subnets 2001:db8::/64
subnets sheet
subnets hosts 192.168.0.0/28 --aws
subnets hosts 10.0.0.0/24 --azure
subnets hosts 10.0.0.0/24 --gcp
subnets contains 10.0.0.0/8 10.1.2.3
subnets split 10.0.0.0/24 --prefix 26
subnets supernet 10.0.0.0/25 10.0.0.128/25

show

subnets 192.168.0.3/28
subnets 192.168.0.3 255.255.255.240
subnets 10.0.0.5/255.255.255.0
subnets 2001:db8::/64

Prints three panels by default:

  • Address — the input, IP version, classification (Private, Public, Loopback, Link-local, Multicast, Shared/CGNAT, Documentation, Unique local, …), and the legacy IPv4 class when relevant
  • Subnet — CIDR, prefix length, mask (with hex), wildcard, network, broadcast (IPv4) or last address (IPv6), first/last host, total and usable counts, and the zero-based index of the input address inside the subnet
  • Binary — dotted/colonic binary of the address and mask (IPv4)

Add --aws, --azure, or --gcp for a fourth panel of cloud reservations; see cloud.

sheet

subnets sheet
subnets sheet --ipv6

A quick reference of prefix lengths to subnet masks, wildcards, address counts, and usable hosts. IPv4 covers /0–/32 with notes for classful sizes, point-to-point (/30, /31 RFC 3021), and single host (/32). IPv6 covers the common allocation sizes (/32, /48, /56, /64, …) through /128.

hosts

subnets hosts 192.168.0.0/28
subnets hosts 192.168.0.0/28 --aws
subnets hosts 10.0.0.0/24 --azure
subnets hosts 10.0.0.0/24 --gcp
subnets hosts 10.0.0.0/24 --limit 32

Lists every address in the subnet as a table: index, address, role, and a ← you mark when the input address is in range.

Without a cloud flag, roles are the classic network/broadcast (IPv4) or subnet-router anycast (IPv6), otherwise usable. With --aws / --azure / --gcp, roles follow that provider’s reservation table.

--limit caps how many rows are printed (default 256). Larger subnets are truncated rather than dumping millions of lines; the JSON form reports "truncated": true when that happens.

contains

subnets contains 10.0.0.0/8 10.1.2.3
subnets contains 10.0.0.0/8 10.1.2.0/24
subnets contains 10.0.0.0/8 192.168.0.0/16 --json

Reports whether the outer prefix fully contains the inner address or prefix. Relation is one of equal, subnet, address, supernet, overlap, or disjoint. Exit status is 0 when contained (or equal), 1 when not — the result is still printed (and --json still emits the object).

split

subnets split 10.0.0.0/24 --prefix 26
subnets split 10.0.0.0/24 --count 4

Divides a network into equal child subnets. --prefix sets the new length; --count asks for N equal pieces (N must be a power of two). Use one or the other, not both.

supernet

subnets supernet 10.0.0.0/25 10.0.0.128/25
subnets supernet 10.0.0.0/26 10.0.0.64/26 10.0.0.128/25 --json

Aggregates the given prefixes into the smallest covering set, combining exact sibling pairs into a parent when both halves are present. Leftovers that cannot pair stay as they are.

cloud

subnets 192.168.0.0/28 --aws
subnets 10.0.0.0/24 --azure
subnets 10.0.0.0/24 --gcp
subnets hosts 10.0.0.0/24 --gcp

AWS

Amazon keeps five addresses in every VPC subnet:

offset role detail
first Network network address
+1 VPC router reserved for the VPC router
+2 Amazon DNS / Reserved Amazon DNS on IPv4; reserved on IPv6
+3 Future use / Reserved future use on IPv4; reserved on IPv6
last Broadcast / Last address broadcast on IPv4; last address on IPv6

Usable range: +4 through last−1. Prefix check: IPv4 /16–/28; IPv6 /44–/64 in steps of /4.

Azure

Azure also reserves five addresses (first four and last):

offset role
first Network
+1 Default gateway
+2, +3 Azure DNS mapping
last Broadcast

Usable range: +4 through last−1. Prefix check: IPv4 /2–/29; IPv6 /64.

GCP

Google Cloud reserves the first two and last two of the primary IPv4 range:

offset role
first Network
+1 Gateway
last−1 Google reserved
last Broadcast

Usable range: +2 through last−2. Prefix check: IPv4 /8–/29; IPv6 /64.

json

subnets 192.168.0.3/28 --json
subnets 192.168.0.0/28 --json --aws
subnets 10.0.0.0/24 --json --azure
subnets 10.0.0.0/24 --json --gcp
subnets sheet --json
subnets hosts 192.168.0.0/28 --json --aws --limit 32
subnets hosts 10.0.0.0/24 --json --azure --limit 32
subnets hosts 10.0.0.0/24 --json --gcp --limit 32
subnets contains 10.0.0.0/8 10.1.2.3 --json
subnets split 10.0.0.0/24 --prefix 26 --json
subnets supernet 10.0.0.0/25 10.0.0.128/25 --json

--json replaces the coloured tables with indented JSON on stdout — suitable for scripts, jq, and CI. Numbers that can exceed a 64-bit integer (IPv6 host counts) are emitted as strings.

Show output includes input, address, version, type, cidr, prefix, mask, wildcard, network, broadcast / last_address, host range, counts, host_index, and (for IPv4) mask_hex plus a binary object. With a cloud flag, a cloud object adds provider, reserved, usable_range, prefix_ok, and input_role (and aws is also set when --aws is used).

Sheet output is { "version": 4|6, "rows": [ … ] }. Hosts output is { "cidr", "addresses", "limit", "truncated", "hosts": [ … ] }. Contains, split, and supernet emit contains / cidrs objects as shown by --json.

development

make build    # writes ./subnets with version from git describe
make test
make install  # go install with the same ldflags

license

Released under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages