Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 1.32 KB

README.md

File metadata and controls

53 lines (36 loc) · 1.32 KB
Raw

OpenAddresses CLI & Lib

Javascript Library and CLI for the OpenAddresses API

General Usage

Installation

JS Library

npm add '@openaddresses/lib'

CLI

npm add --global @openaddresses/lib

Instantiation

Note: if the username & password is not explicitly set, OA will fallback to checking for a OA_USERNAME & OA_PASSWORD environment variable. For the url parameter, be sure to include the protocol and (if necessary) port number.

Alternatively an API token can be provided via a OA_TOKEN environment variable, or the server secret via the OA_SECRET variable.

JS Library

import OA from '@openaddresses/lib';

const oa = new OA({
    username: 'ingalls',
    password: 'yeaheh',
    url: 'http://example.openaddresses.io',
});

CLI

The CLI tool must be provided the URL to connect to for each subcommand. This can be accomplished by providing the URL to a local or remote OA server. Be sure to include the protocol and, for local connections, the port number.

# Connecting to a remote oa server
./cli.js --url 'https://example.openaddresses.io'
# Connecting to a local oa dev server
./cli.js --url 'http://localhost:5000'