domains-cli/README.md

Check to see if domain names are available using the DNSimple api.

# domains-cli [![NPM version](https://img.shields.io/npm/v/domains-cli.svg?style=flat)](https://www.npmjs.com/package/domains-cli) [![NPM monthly downloads](https://img.shields.io/npm/dm/domains-cli.svg?style=flat)](https://npmjs.org/package/domains-cli)  [![NPM total downloads](https://img.shields.io/npm/dt/domains-cli.svg?style=flat)](https://npmjs.org/package/domains-cli) [![Linux Build Status](https://img.shields.io/travis/doowb/domains-cli.svg?style=flat&label=Travis)](https://travis-ci.org/doowb/domains-cli)

> Check to see if domain names are available using the DNSimple api.

## Install

Install globally with [npm](https://www.npmjs.com/)

```sh
$ npm install --global domains-cli
```

## Usage

When running the first time, provide an authentication token from [dnsimple](https://dnsimple.com). This will be saved for later runs.

```sh
$ domains example --token XXXXXXXXXXXX
```

Specify the hostname of the domains that you want to check. Leave off the tld so the domain can be checked against multiple tlds at once:

```sh
$ domains example
```

By default, `.com` and `.io` are checked. If you want to specify the tlds to check, use the `--tlds` options and a comma separated list of tlds:

```sh
$ domains example --tlds com,io,net
```

You can try multiple domains too:

```sh
$ domains example foo bar baz --tlds com,io,net
```

## About

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

Please read the [contributing guide](contributing.md) for avice on opening issues, pull requests, and coding standards.

### Building docs

_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_

To generate the readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install -g verb verb-generate-readme && verb
```

### Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

### Author

**Brian Woodward**

* [github/doowb](https://github.com/doowb)
* [twitter/doowb](http://twitter.com/doowb)

### License

Copyright © 2017, [Brian Woodward](https://github.com/doowb).
Released under the [MIT license](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.3, on January 12, 2017._