Skip to main content

CLI tool for Gandi.net API

Project description

gandi-v5

CLI tool for Gandi.net API v5.

  • Manage domains, DNS records, email, SSL certificates, and organizations
  • Multiple output formats: table, JSON, plain text
  • Sandbox mode for safe testing
  • Config file or environment variable authentication

Quick Start

Run directly without installing:

uvx gandi-v5 --help

Install

pip install gandi-v5

Or install from source:

pip install git+https://github.com/lyhcode/gandi-v5

Authentication

Set your Gandi Personal Access Token (PAT):

export GANDI_PAT=your-token-here

Or save it to config:

gandi-v5 auth login
gandi-v5 auth status      # verify authentication
gandi-v5 auth set-org     # set default organization
gandi-v5 auth logout      # remove saved token

Usage

# Domains
gandi-v5 domain list
gandi-v5 domain info example.com
gandi-v5 domain check myname.com

# DNS Records
gandi-v5 dns list example.com
gandi-v5 dns list example.com --type A --name www
gandi-v5 dns get example.com www A
gandi-v5 dns create example.com www A 1.2.3.4
gandi-v5 dns update example.com www A --value 5.6.7.8
gandi-v5 dns delete example.com www A
gandi-v5 dns export example.com

# Email Forwarding
gandi-v5 email forward list example.com
gandi-v5 email forward create example.com info user@gmail.com
gandi-v5 email forward delete example.com info

# Mailboxes
gandi-v5 email mailbox list example.com
gandi-v5 email mailbox info example.com <mailbox-id>

# SSL Certificates
gandi-v5 cert list
gandi-v5 cert info <cert-id>

# Organizations
gandi-v5 org list
gandi-v5 org info <org-id>
gandi-v5 org whoami

# Output formats
gandi-v5 -o json domain list
gandi-v5 -o plain domain list
gandi-v5 -o table domain list   # default

Sandbox

Use --sandbox to test against the Gandi Sandbox API:

gandi-v5 --sandbox domain list

Configuration

Config file: ~/.config/gandi-cli/config.toml

[auth]
pat = "your-token"

[defaults]
output = "table"
sharing_id = "your-org-id"

Claude Code Skills

The skills/ directory contains Claude Code skill files for developing and extending this CLI. They include API endpoint references, command patterns, and business rules for each Gandi API area.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gandi_v5-0.1.0.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gandi_v5-0.1.0-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

Details for the file gandi_v5-0.1.0.tar.gz.

File metadata

  • Download URL: gandi_v5-0.1.0.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for gandi_v5-0.1.0.tar.gz
Algorithm Hash digest
SHA256 35f65ff74b446561df413bf645d43a6b929af3bc3977d586858f3f25bc666ab8
MD5 6533b2ba829776c32e684bb3357382d8
BLAKE2b-256 d7b36723a5bd0f3dd7b642d91a3be58a6154bcc7a4beb1c546b2be45bae3ed5e

See more details on using hashes here.

File details

Details for the file gandi_v5-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: gandi_v5-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for gandi_v5-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef5c05a22c5d8b8a38c24c33d1f9deb3ec93d3ea69df2c6aa205f0816c23d8ee
MD5 cdba733744648457545f4adcfd6e8617
BLAKE2b-256 522943562451b6f52784456057225c13cb7f5c90e0c7d966948936f81bbed2c9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page