domain

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 70 Open GitHub ↗

Check availability of domain names and get WHOIS information.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

cocur/domain
============

> Check availability of domain names and get WHOIS information.

[![Latest Stable Version](http://img.shields.io/packagist/v/cocur/domain.svg)](https://packagist.org/packages/cocur/domain)
[![Build Status](http://img.shields.io/travis/cocur/domain.svg)](https://travis-ci.org/cocur/domain)
[![Code Coverage](http://img.shields.io/coveralls/cocur/domain.svg)](https://coveralls.io/r/cocur/domain)

Features
--------

- Check availability of domains
- Retrieve WHOIS information of domains
- Support for over 350 TLDs, including new generic TLDs like `.coffee` or `.sexy`
- Command line tool and library
- Compatible with PHP >= 5.4 and [HHVM](http://hhvm.com)

Installation
------------

Dependending on how you want to use Domain there exist different installation methods.

### Composer

If you want to use the library as a dependency in your project you should use Composer to do so:

```shell
$ composer require cocur/domain:@dev
```

*Currently there exists no stable release of domain.*

### Download PHAR

If you only want to use the command line tool to retrieve WHOIS information you can download the PHAR.

```shell
$ wget https://github.com/cocur/domain/releases/download/v0.1/whois.phar
$ chmod +x whois.phar
$ mv whois.phar /usr/local/bin/cwhois
```

You can now retrieve WHOIS information using Cocur Domain by executing

```shell
$ cwhois
```

Usage
-----

### Command line WHOIS

You can use the included command line tool to retrieve WHOIS information about a domain:

```shell
$ php whois.phar cocur.co
```

### Library

The library contains two main classes: `Whois\Client` and `Availability\Client` They require information about WHOIS servers and patterns to match available domains stored in `data/tld.json`.

#### Whois

```php
use Cocur\Domain\Connection\ConnectionFactory;
use Cocur\Domain\Data\DataLoader;
use Cocur\Domain\Whois\Client;

$factory = new ConnectionFactory();
$dataLoader = new DataLoader();
$data = $dataLoader->load(__DIR__.'/data/tld.json');

$client = new Client($factory, $data);

echo $client->query($domainName);
```

#### Availability

To check the availability of a domain name the `Availability\Client` requires an instance of `Whois\Client`.

```php
use Cocur\Domain\Connection\ConnectionFactory;
use Cocur\Domain\Data\DataLoader;
use Cocur\Domain\Whois\Client as WhoisClient;
use Cocur\Domain\Availability\Client as AvailabilityClient;

$factory = new ConnectionFactory();
$dataLoader = new DataLoader();
$data = $dataLoader->load(__DIR__.'/data/tld.json');

$whoisClient = new WhoisClient($factory, $data);
$client = new AvailabilityClient($whoisClient, $data);

echo $client->isAvailable($domainName);
```

Changelog
---------

### Verison 0.2 (15 June 2016)

- [#1](https://github.com/cocur/domain/pull/1) Add `.frl` TLD (by [rskuipers](https://github.com/rskuipers))
- [#3](https://github.com/cocur/domain/pull/3) Add `.amsterdam` TLD (by [rskuipers](https://github.com/rskuipers))
- [#4](https://github.com/cocur/domain/pull/4) Fix pattern for `.ee` (by [huglester](https://github.com/huglester))

### Version 0.1 (19 May 2014)

- Initial release

Author
------

### [Florian Eckerstorfer](http://florian.ec) [![Support Florian](http://img.shields.io/gittip/florianeckerstorfer.svg)](https://www.gittip.com/FlorianEckerstorfer/)

- [Twitter](http://twitter.com/Florian_)
- [App.net](http://app.net/florian)

License
-------

The MIT license applies to `cocur/domain`. For the full copyright and license information, please view the LICENSE file distributed with this source code.

domain

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README