Config

Manage CLI configuration settings. Configuration is stored in a JSON file at an OS-appropriate location.

Available Settings

Key	Values	Description
sandbox	true / false	Use the Namecheap sandbox API for testing
defaultOutput	table / json	Default output format for all commands

list

Display all current configuration values, including credentials (API key is hidden).

Usage:

namecheap config list [options]

Options:

Option	Description
--json	Output as JSON

Example:

$ namecheap config list

Configuration

  Config file: /home/myuser/.config/namecheap-cli/config.json

  sandbox:       false
  defaultOutput: table

Credentials
  apiUser:  myuser
  userName: myuser
  clientIp: 203.0.113.42
  apiKey:   ***hidden***

Example (JSON):

$ namecheap config list --json
{
  "sandbox": false,
  "defaultOutput": "table",
  "configPath": "/home/myuser/.config/namecheap-cli/config.json",
  "credentials": {
    "apiUser": "myuser",
    "userName": "myuser",
    "clientIp": "203.0.113.42",
    "apiKey": "***hidden***"
  }
}

get

Get a single configuration value.

Usage:

namecheap config get <key>

Arguments:

Argument	Description
key	Configuration key (sandbox, defaultOutput)

Example:

$ namecheap config get sandbox
false

$ namecheap config get defaultOutput
table

set

Set a configuration value.

Usage:

namecheap config set <key> <value>

Arguments:

Argument	Description
key	Configuration key (sandbox, defaultOutput)
value	Value to set

Example:

$ namecheap config set sandbox true
✔ Set sandbox = true

$ namecheap config set defaultOutput json
✔ Set defaultOutput = json

path

Display the path to the configuration file on disk.

Usage:

namecheap config path

Example:

$ namecheap config path
/home/myuser/.config/namecheap-cli/config.json

TIP

The config file is stored at ~/.config/namecheap-cli/config.json on all platforms.