1. arincli(7)
  2. arincli(7)

NAME

arincli - ARIN Command Line Interface

DESCRIPTION

ARINcli is a set of command line scripts, written in Ruby, that utilize both the Whois-RWS(7) service and the Reg-RWS(7) service. Whois-RWS(7) is ARIN's Whois/NICNAME RESTful web service for exposing IP network and ASN registration data to the public (Note this service pre-dates the IETF WEIRDS/RDAP service and is not yet compatible with that specification). Reg-RWS(7) is ARIN's registration RESTful web service available to customers of ARIN.

At the time of this writing, the ARINcli scripts should be considered beta quality. A lot of functionality is still missing from the scripts, and ARIN has not conducted any degree of quality assurance against them.

COMMANDS

CONFIGURATION

The ARINcli commands all use an application data directory to store configuration files, caches, etc. The arinutil(1) command can be used to manipulate the caches and configuration. This application data directory is $HOME/.ARINcli for Unix and Unix-like systems, and %APPDATA%\ARINcli for Windows. This directory is created automatically the first time an ARINcli command is run.

Configuration is kept in the config.yaml file in the application data directory. This is a YAML file and so YAML syntax is required. YAML is designed to be human friendly yet machine parsable. For users of Reg-RWS(7), the API Key given will likely need be changed to the users real API key. An API Key can be obtained via ARIN Online. An API Key is not needed for Whois-RWS(7).

INSTALLATION

There are two ways to download the ARINcli scripts: 1) via Git from ARIN's source code repository, or 2) downloading a zip file. The ARINcli commands are Ruby programs, and Ruby 1.8.7 and above are needed.

To get the code from Git, clone the repository using the following command: git clone http://anon:anon@stash-projects.arin.net:7990/scm/ARINR/arinr.git. The commands are executables in the bin directory and should be usable straight away.

A zip of the scripts is available at http://projects.arin.net/arinr/arincli.zip.

To verify compatibility and that everything is working, run the tests with the run_all_tests command.

To build the man pages and these documents, you must use ronn. You can install it as a Ruby gem with gem install ronn. Once it is installed, build the man pages with the following command: ronn man/*.ronn.

HELP

Questions and comments regarding this software may be directed to ARIN's Technical Discussion mailing list (arin-tech-discuss@arin.net). Archives and subscription information are available at http://lists.arin.net/pipermail/arin-tech-discuss/.

  1. February 2013
  2. arincli(7)