@eliware/cf-admin

A dependency-injected Cloudflare administration CLI for scripting and inspecting zones, DNS, rulesets, settings, lists, and list items.

Features

• Zone list, inspect, create, update, and delete
• DNS record list, inspect, create, update, and delete
• Zone setting read/update support
• Ruleset list, inspect, create, and update
• Cloudflare list and list-item management
• JSON or human-readable output
• Dry-run support for writes
• Force confirmation for destructive operations
• Testable dependency-injected architecture

Requirements

• Node.js 26+ required
• Cloudflare API credentials
• Cloudflare account ID for account-scoped resources when not supplied on the command
• Cloudflare zone ID for zone-scoped resources supplied on the command

Installation

git clone [email protected]:eliware/cf-admin.git
cd cf-admin
npm install
npm test
npm run lint
npm run test:gaps
npm run pack
npm install -g .

The global install provides:

cf-admin --help
cf-admin --version

Configuration

Set credentials in the environment, a .env file in the current directory, or ~/.cf-admin:

[email protected]       # required secret; API email
CLOUDFLARE_API_KEY=your_api_key        # required secret; API key
CLOUDFLARE_ACCOUNT_ID=your_account_id  # optional default for account resources

CLOUDFLARE_EMAIL and CLOUDFLARE_API_KEY have no defaults and are required before API access. The account ID is an optional identifier, not a secret; command-line IDs take precedence where supported. The CLI loads ~/.cf-admin first, then .env from the current directory; existing environment variables take precedence. Both files use dotenv syntax. Keep credentials private and never commit .env, .cf-admin, credentials, tokens, or generated state.

Usage

cf-admin zones list
cf-admin zones get --zone-id <zone_id>
cf-admin dns-records list --zone-id <zone_id>
cf-admin dns-records create --zone-id <zone_id> \
  --data '{"type":"A","name":"www","content":"1.2.3.4"}'
cf-admin rulesets list --zone-id <zone_id> --json
cf-admin zone-settings get --zone-id <zone_id> --setting development_mode

Use JSON output for automation:

cf-admin zones list --json
cf-admin dns-records get --zone-id <zone_id> --id <record_id> --output json

Preview supported writes:

cf-admin dns-records create --zone-id <zone_id> \
  --data '{"type":"A","name":"test","content":"192.0.2.1"}' \
  --dry-run

Destructive operations require --force:

cf-admin dns-records delete --zone-id <zone_id> --id <record_id> --force

Resources

• zones
• zone-settings
• dns-records
• rulesets
• lists
• list-items

Run <resource> --help for action-specific help.

Security

CLOUDFLARE_EMAIL and CLOUDFLARE_API_KEY are required secrets. Credentials may be stored in ~/.cf-admin or the current directory's .env file. The account ID is an optional default; zone and account scope can also be supplied on commands. Never log or commit credentials.

Development

npm test
npm run lint
npm run test:gaps
npm run pack

The test suite uses injected Cloudflare clients, filesystem adapters, environment loaders, printers, handlers, and process exits. Current source coverage is 100%.

Project Structure

• bin/ - CLI entry point
• src/cli.mjs - dependency-injected command runtime
• src/handlers/ - resource handlers
• src/ - argument, environment, API, help, and output utilities
• tests/ - Jest test suite
• dream.md - long-term product vision
• dream_sprints.md - staged roadmap

Support

For help or questions, join the community:

eliware.org on Discord

License

ISC © 2026 Eli Sterling, eliware.org

Links

• Home Page
• GitHub Repo
• GitHub Org
• GitHub Personal
• Discord