1. Install the CLI

You can install the CLI by running the following command:

npm install @free-domains/cli -g

2. Login to the CLI

Run the following command to login to the CLI and follow the steps.

domains login

3. Register a domain

Run the following command and follow the steps to register a subdomain.

domains register

1. Fork this repository.
2. Add a new file called example.domain.dev.json in the /domains folder to register the example subdomain on the domain.dev. - A list of supported domains can be found here.
3. Edit it to meet your needs. - The file listed below is just an example, provide a valid JSON file with your needs. - Make sure to remove any records that aren't needed.

{
    "domain": "is-a-fullstack.dev",
    "subdomain": "example",

    "owner": {
        "email": "hello@example.com"
    },

    "records": {
        "A": ["1.1.1.1", "1.0.0.1"],

        "AAAA": ["2606:4700:4700::1111", "2606:4700:4700::1001"],

        "CNAME": "example.com",

        "MX": [
            {
                "priority": 10,
                "value": "mx.example.com"
            }
        ],

        "TXT": [
            {
                "name": "@",
                "value": "example_verification=1234567890"
            }
        ]
    },

    "proxied": false
}

4. Your pull request will be reviewed and merged. - Do not ignore the pull request checklist, this is required. - Make sure to keep an eye on your pull request in case we need you to make any changes!
5. After the pull request is merged, please allow up to 24 hours for the changes to propagate (in most cases it takes up to 5 minutes)
6. Enjoy your new domain!