Search... ⌘ K
Get Started Contact Sales

What Is the DNSimple CLI?

Last updated

Table of Contents

The DNSimple CLI is a command-line interface for the DNSimple API. You can register domains, create and update DNS records, order SSL certificates, and manage most other DNSimple features from your terminal.

What can you do with the DNSimple CLI?

The CLI organizes DNSimple CLI commands into groups that map to DNSimple features:

  • Domains and DNS - List domains, create and update DNS zone records, delete records, activate zones, check zone distribution, enable and disable DNSSEC, configure email forwarding, and push domains to other accounts.
  • Registrar - Check domain availability, register domains, renew registrations, manage transfers, change name server delegation, enable WHOIS privacy, and view pricing.
  • Certificates - List, inspect, and download SSL certificates, and order and renew Let’s Encrypt certificates.
  • Contacts - Create and manage the contact records used for domain registrations.
  • Services and templates - Apply one-click services to domains and manage DNS record templates.
  • Webhooks - Create and manage webhook endpoints for API events.
  • Billing and analytics - View billing charges and query DNS analytics data.
  • Shell completions - Generate tab-completion scripts for bash, zsh, fish, and PowerShell.
  • Vanity name servers - Enable and disable vanity name servers.
  • AI reference - Print a structured reference of every command and common workflows for AI agents and automation tools.

You do not need to use the CLI for write operations only. It works just as well in read-only mode to list domains, collect analytics, or inspect certificates.

Why manage domains from the command line?

Switching to a browser to manage DNS records breaks the flow of terminal-based work and introduces manual error. The DNSimple command-line tool keeps you where your work already is.

For automation, the CLI gives CI pipelines and deployment scripts structured commands with proper error handling - an improvement over raw API calls. The --json flag provides structured output you can pipe into tools like jq.

Teams that manage multiple accounts benefit from the CLI’s context system. Named auth contexts let you switch between production, sandbox, and client accounts in a single command.

How does the DNSimple CLI work with AI agents?

The CLI includes an ai command that prints a structured reference of every CLI command and common workflows. It does not include data from your account. AI agents can run this command to learn how the CLI works, then run commands based on natural-language requests. By default, the output lists only required flags to keep it short; add --full to include every flag.

How does the DNSimple CLI authenticate?

Run dnsimple auth login in a terminal and the CLI opens the DNSimple authorization page in your browser, then completes the login automatically once you approve. There is no token to copy or paste.

To authenticate with an API access token instead, run dnsimple auth login --with-token and paste the token when prompted. Automated environments use the same command: when input is piped or redirected, such as in a CI pipeline, the CLI reads the token from standard input.

Each login is saved as a named context on disk, so you can keep separate logins for production, sandbox, and client accounts. For the full authentication reference, see the CLI documentation on the developer site.

How do you install the DNSimple CLI?

The DNSimple CLI is a cross-platform command-line tool with pre-built binaries for macOS, Linux, and Windows on both amd64 and arm64 architectures. You can install it through Homebrew or a one-line install script. Visit the CLI documentation on the developer site for setup instructions and DNSimple CLI examples.

Have more questions?

If you have any questions about the DNSimple CLI, contact support, and we’ll be happy to help. You can also read more about the DNSimple CLI.