← CLI Docs

Installation

Get the onedns CLI running in under a minute.

Quick install

macOS / Linux

curl -fsSL https://onedns.io/static/cli/onedns -o /usr/local/bin/onedns
chmod +x /usr/local/bin/onedns

pip

pip install onedns

pipx (isolated, recommended)

pipx install onedns

Verify

onedns --version
onedns --help

Requirements

  • Python 3.8+ — required
  • requests — installed automatically via pip

The CLI is a self-contained Python script with no other runtime dependencies.

Authenticate

onedns login

You'll be prompted for your API key. Get one at Settings → API Keys.

Or set it as an environment variable (useful for CI/CD):

export ONEDNS_API_KEY=your_api_key_here

Environment variables

Variable Description
ONEDNS_API_KEY API key — overrides saved config
ONEDNS_URL Base URL (default: https://onedns.io) — useful for staging

Config file

Credentials are stored at ~/.config/onedns/config. You can edit it directly or manage it with onedns login / onedns logout.

Quick Start →
Your first zone and record in 5 minutes
Command Reference →
Full list of commands and flags