CLI tool
********

The netaddr package includes a "netaddr" CLI application.

Note:

  The tool is meant to be used by humans. Its interface should not be
  considered stable. Exercise caution when using it in any kind of
  programmatic context (read: scripting).If you want a stable
  interface use the programmatic API.

To see the usage

   % netaddr --help
                  __            __    __
      ____  ___  / /_____ _____/ /___/ /____
     / __ \/ _ \/ __/ __ `/ __  / __  / ___/
    / / / /  __/ /_/ /_/ / /_/ / /_/ / /
   /_/ /_/\___/\__/\__,_/\__,_/\__,_/_/

   usage: netaddr [-h]

   The netaddr CLI tool

   options:
   -h, --help  show this help message and exit

   Share and enjoy!


Interactive shell
=================

Calling "netaddr" without any arguments will launch an interactive
shell.

The shell uses IPython if available or the built-in Python REPL
otherwise. The IPython REPL has more features and offers nicer
experience overall.

The shell comes with all parts of the netaddr API pre-imported so you
can interact with it right away, with minimal friction:

   % netaddr
                  __            __    __
      ____  ___  / /_____ _____/ /___/ /____
     / __ \/ _ \/ __/ __ `/ __  / __  / ___/
    / / / /  __/ /_/ /_/ / /_/ / /_/ / /
   /_/ /_/\___/\__/\__,_/\__,_/\__,_/_/

   netaddr shell 1.0.0 - an interactive shell for the netaddr library

   In [1]: '10.0.0.2' in IPNetwork('10.0.0.0/24')
   Out[1]: True

   In [2]:

Changed in version 1.2.0: Made IPython an optional dependency.


Network information
===================

Run "netaddr info <network>" to display information about an IP
network:

   % netaddr info 192.2.2.27/24
                  __            __    __
      ____  ___  / /_____ _____/ /___/ /____
     / __ \/ _ \/ __/ __ `/ __  / __  / ___/
    / / / /  __/ /_/ /_/ / /_/ / /_/ / /
   /_/ /_/\___/\__/\__,_/\__,_/\__,_/_/

   IP network information

   CIDR                     192.2.2.0/24
   Network IP               192.2.2.0
   Network IP (binary)      11000000.00000010.00000010.00000000
   Network IP (decimal)     3221357056
   Network IP (hex)         0xc0020200
   Subnet mask              255.255.255.0
   Subnet mask (binary)     11111111.11111111.11111111.00000000
   Broadcast IP             192.2.2.255
   Range                    192.2.2.0-192.2.2.255
   Total addresses          256
   Usable range             192.2.2.1-192.2.2.254
   Usable addresses         254
