Skip to main content

AntAPI CLI

Your APIs, from the terminal.

Use AntAPI from a shell or script. The CLI is a separate way to call your APIs; Skills work without it.

1. Install the CLI

Install the CLI once from the official repository. Add Go’s executable directory to your PATH, then verify the installation.

Available

Install from the repository
git clone https://github.com/xiaopozhu/antapi-cli.git
cd antapi-cli
go install ./cmd/antapi

Source installation requires Git and Go 1.27.2 or later. Private repositories use your configured Git credentials. Add Go’s executable directory to your PATH, then check the installed version.

Official repository ↗

Check the installed version:

CLI
antapi version --json

2. Configure your project locally

Create a project key in Console and provide it privately through your terminal environment or secret manager.

First-use guide
antapi setup
Create an API key ↗
ANTAPI_API_KEY
Your project API key. The CLI reads ANTAPI_API_KEY; HTTP API calls and standalone Skills use ANTAPI_KEY.

The CLI uses https://api.antapi.dev automatically. No configuration file or Gateway setting is required.

Check local configuration
antapi doctor

Follow setup’s hidden-input instructions to provide your key, then run doctor. This local check hides the key and makes no API request; it does not validate the remote service or key permissions.

Advanced: use another Gateway

For a test environment, use --gateway-url with its HTTPS origin before the whois command. Local HTTP requires an explicit development profile.

Keep your real key out of chat and shared commands.

3. Run a command

For example, check WHOIS TLD coverage or look up one domain. Domain lookups use your project’s Credits and limits; review the current price before running them.

TLD coverage
antapi whois tlds --json
Domain lookup
antapi whois lookup example.com --json
View WHOIS pricing ↗

Prefer working with an agent? Explore Skills ↗