Domains CLI reference
Source: @socra/domain-cli@0.0.7.
This reference includes every command, argument, and option declared by this released package. Defaults and accepted values are included where the package declares them. Command-specific validation and permissions also apply; see the API reference for resource contracts.
Use socra domain --help, or append --help to any command, to inspect the locally installed version.
socra domain
Search, own, and connect internet domains
| Command | Purpose |
|---|---|
socra domain search | Search Namecheap availability for an exact domain or expand a name across TLDs |
socra domain pricing | Show cached Namecheap registration, renewal, transfer, or reactivation pricing |
socra domain create | Register an account Domain and print its DNS TXT challenge |
socra domain get | Show a domain and its verification record |
socra domain list | List account Domains |
socra domain verify | Check the DNS TXT challenge |
socra domain disable | Disable a domain |
socra domain reverify | Reset a domain to pending verification |
socra domain delete | Delete a Domain with no claimed Hostnames |
socra domain hostname | Exact globally unique hostnames claimed by projects |
socra domain search
Search Namecheap availability for an exact domain or expand a name across TLDs
socra domain search <query> [options]
Arguments
| Argument | Required | Description |
|---|---|---|
query | Yes | A name, exact domain, or comma-separated domain list |
Options
| Option | Input | Description |
|---|---|---|
--tlds | Value | TLDs for names without an extension (default: com,ai,io,co,app,dev,net,org) |
socra domain pricing
Show cached Namecheap registration, renewal, transfer, or reactivation pricing
socra domain pricing <tlds> [options]
Arguments
| Argument | Required | Description |
|---|---|---|
tlds | Yes | One or more comma-separated TLDs, such as com,ai,co.uk |
Options
| Option | Input | Description |
|---|---|---|
--action | Value | register, renew, transfer, or reactivate (default: register) |
--years | Value | Duration in years (default: 1) |
socra domain create
Register an account Domain and print its DNS TXT challenge
socra domain create <domain>
Arguments
| Argument | Required | Description |
|---|---|---|
domain | Yes | Fully-qualified Domain |
socra domain get
Show a domain and its verification record
socra domain get <id>
Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Domain id |
socra domain list
List account Domains
socra domain list [options]
Options
| Option | Input | Description |
|---|---|---|
--hostname | Value | Domain filter |
--status | Value | pending, verified, or disabled |
--limit | Value | Page size |
--after | Value | Page cursor |
socra domain verify
Check the DNS TXT challenge
socra domain verify <id>
Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Domain id |
socra domain disable
Disable a domain
socra domain disable <id>
Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Domain id |
socra domain reverify
Reset a domain to pending verification
socra domain reverify <id>
Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Domain id |
socra domain delete
Delete a Domain with no claimed Hostnames
socra domain delete <id>
Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Domain id |
socra domain hostname
Exact globally unique hostnames claimed by projects
| Command | Purpose |
|---|---|
socra domain hostname create | Claim a hostname beneath a verified account Domain |
socra domain hostname get | Show a claimed hostname |
socra domain hostname list | List project hostnames |
socra domain hostname enable | Enable a hostname |
socra domain hostname disable | Disable a hostname |
socra domain hostname delete | Release a hostname claim |
socra domain hostname create
Claim a hostname beneath a verified account Domain
socra domain hostname create <hostname> [options]
Arguments
| Argument | Required | Description |
|---|---|---|
hostname | Yes | Fully-qualified hostname |
Options
| Option | Input | Description |
|---|---|---|
--project | Value | Socra project id |
socra domain hostname get
Show a claimed hostname
socra domain hostname get <id>
Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Hostname id |
socra domain hostname list
List project hostnames
socra domain hostname list [options]
Options
| Option | Input | Description |
|---|---|---|
--project | Value | Socra project id |
--hostname | Value | Hostname filter |
--domain | Value | Parent Domain id |
--status | Value | active or disabled |
--limit | Value | Page size |
--after | Value | Page cursor |
socra domain hostname enable
Enable a hostname
socra domain hostname enable <id>
Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Hostname id |
socra domain hostname disable
Disable a hostname
socra domain hostname disable <id>
Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Hostname id |
socra domain hostname delete
Release a hostname claim
socra domain hostname delete <id>
Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Hostname id |
Next step
Return to the Domains overview.