Cloudflare-utils is build for Windows, Mac and Linux and the latest release is available to download from GitHub. Download the tar/zip file for your operating system and then extract the executable.
Additional Installation Methods¶
- Chocolatey: cloudflare-utils
The recommended method to authenticate is with an API Token. Each command will list the API permissions needed for it to run.
cloudflare-utils --api-token <Token Here>
You can also pass your API Token via an environment variable of
The legacy API Key method is also supported but is not recommended.
cloudflare-utils --api-email <Email Here> --api-key <API Key Here>
You can pass your API email and key with environment variables of
--account-idYou can pass your account ID with the
--account-idflag or with the environment variable
--api-emailYou can pass your API email with the
--api-emailflag or with the environment variable
CLOUDFLARE_API_EMAIL. This is only needed if you are using the legacy auth method.
--api-keyYou can pass your API key with the
--api-keyflag or with the environment variable
CLOUDFLARE_API_KEY. This is only needed if you are using the legacy auth method.
--api-tokenYou can pass your API token with the
--api-tokenflag or with the environment variable
CLOUDFLARE_API_TOKEN. This is the recommended method of authentication.
--rate-limitYou can pass the rate limit in milliseconds with the
--rate-limitflag. This is useful if you are getting rate limited by Cloudflare or want to speed up the rate of requests.
--zone-nameYou can pass your zone name with the
--zone-nameflag or with the environment variable
CLOUDFLARE_ZONE_NAME. This is useful if you are running a command that only requires a zone name.
--zone-idYou can pass your zone ID with the
--zone-idflag or with the environment variable
CLOUDFLARE_ZONE_ID. This is useful if you are running a command that only requires a zone ID.