begin domains
Interact with your Begin domains
begin domains <action> <parameters> [options]npx begin domains <action> <parameters> [options]begin domains list
List domains associated with your Begin account
begin domains list [options]npx begin domains list [options]Examples
List all domains with the verbose flag
begin domains list --verbosenpx begin domains list --verbosebegin domains add
Check a domain’s availability and start the subscription process
begin domains add <parameters> [options]npx begin domains add <parameters> [options]If the domain is available, you will get a link to checkout and complete the subscription process.
If the domain is unavailable, some suggestions will be provided.
This command will not charge a card you might have on file. Similarly, it will not hold the domain for you. You will need to complete the subscription process at the provided checkout URL to claim the domain.
Parameters
-
--domain - The desired domain name
Examples
Add the domain your-name.dev
begin domains add --domain your-name.devnpx begin domains add --domain your-name.devbegin domains link
Link a subscribed domain to an environment
begin domains link <parameters> [options]npx begin domains link <parameters> [options]Begin systems will handle DNS and SSL certificate provisioning. It can take up to 30 minutes for a domain to be fully linked to an environment.
Parameters
-
-a,--app - Application ID, not required if working from Begin project directory
-
--domain - Your subscribed domain name
-
-e,--env - Environment name or ID
Examples
Link the domain your-name.dev to the “production” environment of the application XXXXXXXX
begin domains link --domain your-name.dev --env production --app XXXXXXXXnpx begin domains link --domain your-name.dev --env production --app XXXXXXXXbegin domains unlink
Disconnect a domain from an environment, making it available to re-link
begin domains unlink <parameters> [options]npx begin domains unlink <parameters> [options]Unlinking a domain is fairly quick, but if you plan to re-link the domain to a different environment, it can take some time for the DNS and SSL certificate provisioning to complete for the new environment.
Parameters
-
--domain - Your subscribed domain name
Examples
Unlink the domain your-name.dev
begin domains unlink --domain your-name.devnpx begin domains unlink --domain your-name.dev