INSTALL

npm install -g flarectl-node

RUN

export CLOUDFLARE_API_KEY={your-cloudflare-api-key}

export CLOUDFLARE_EMAIL={your-cloudflare-email}

export CLOUDFLARE_API_TOKEN={your-cloudflare-api-token}

flarectl-node -h

Accounts Command

Command accounts được sử dụng để thực hiện các hành động liên quan đến tài khoản Cloudflare, cụ thể là liệt kê danh sách các tài khoản.

Cách sử dụng:

flarectl-node accounts <action> [options]

Tham số:

• <action>: Hành động cần thực hiện. Các lựa chọn:
  • list: Liệt kê danh sách các tài khoản Cloudflare.

Options:

• -ak, --api-key <string>: Cloudflare API Key (mặc định lấy từ biến môi trường CLOUDFLARE_API_KEY nếu không chỉ định).
• -at, --api-token <string>: Cloudflare API Token (mặc định lấy từ biến môi trường CLOUDFLARE_API_TOKEN nếu không chỉ định).
• -ae, --email <string>: Email tài khoản Cloudflare (mặc định lấy từ biến môi trường CLOUDFLARE_EMAIL nếu không chỉ định).

Ví dụ:

1. Liệt kê danh sách tài khoản sử dụng API Token và Email:

   flarectl-node accounts list -at your_api_token -ae your_email

2. Liệt kê danh sách tài khoản sử dụng API Key và Email từ biến môi trường:

   flarectl-node accounts list

Analytics Command

Command analytics được sử dụng để lấy dữ liệu thống kê từ Cloudflare, bao gồm các loại dữ liệu như số lượng request, dung lượng byte truyền, và dữ liệu cache.

Cách sử dụng:

flarectl-node analytics <action> [options]

Tham số:

• <action>: Loại thống kê cần lấy. Các lựa chọn:
  • requests: Số lượng request.
  • bytes: Dung lượng byte được truyền.
  • cached_bytes: Dung lượng byte được cache.
  • metric: Tổng hợp nhiều loại dữ liệu thống kê bao gồm: request, bytes, cachedBytes, threats.

Options:

• -ak, --api-key <string>: Cloudflare API Key (mặc định lấy từ biến môi trường CLOUDFLARE_API_KEY nếu không chỉ định).
• -at, --api-token <string>: Cloudflare API Token (mặc định lấy từ biến môi trường CLOUDFLARE_API_TOKEN nếu không chỉ định).
• -ae, --email <string>: Email tài khoản Cloudflare (mặc định lấy từ biến môi trường CLOUDFLARE_EMAIL nếu không chỉ định).
• -a, --account <string...>: ID tài khoản Cloudflare (có thể chỉ định nhiều tài khoản).
• -d, --domain <string...>: Tên miền để lấy dữ liệu thống kê (có thể chỉ định nhiều tên miền).
• -o, --output <string>: Thư mục để xuất dữ liệu thành file CSV.
• -p, --period <number>: Số ngày lấy dữ liệu thống kê (ví dụ: -p 7 để lấy dữ liệu trong 7 ngày, mặc định là 30 ngày).

Ví dụ:

1. Lấy thống kê số lượng request cho một domain:

   flarectl-node analytics requests -d example.com -at your_api_token -ae your_email

2. Lấy thống kê tổng hợp (request, bytes, cachedBytes, threats) cho một account:

   flarectl-node analytics metric -a your_account_id -ak your_api_key -ae your_email

3. Lấy dữ liệu thống kê trong 7 ngày và xuất ra file CSV:

   flarectl-node analytics bytes -d example.com -p 7 -o ./output_directory

DNS Command

Command dns được sử dụng để quản lý các bản ghi DNS của Cloudflare, bao gồm thêm, xóa, cập nhật, và liệt kê các bản ghi DNS.

Cách sử dụng:

flarectl-node dns <action> [options]

Tham số:

• <action>: Hành động cần thực hiện. Các lựa chọn:
  • add: Thêm một bản ghi DNS.
  • delete: Xóa một bản ghi DNS (chưa được triển khai).
  • update: Cập nhật một bản ghi DNS (chưa được triển khai).
  • list: Liệt kê các bản ghi DNS (chưa được triển khai).

Options:

• -ak, --api-key <string>: Cloudflare API Key (mặc định lấy từ biến môi trường CLOUDFLARE_API_KEY nếu không chỉ định).
• -at, --api-token <string>: Cloudflare API Token (mặc định lấy từ biến môi trường CLOUDFLARE_API_TOKEN nếu không chỉ định).
• -ae, --email <string>: Email tài khoản Cloudflare (mặc định lấy từ biến môi trường CLOUDFLARE_EMAIL nếu không chỉ định).
• -d, --domain <string>: Tên miền (zone name).
• -ip, --ip <string>: Địa chỉ IP cho bản ghi DNS.
• -t, --type <string>: Loại bản ghi DNS (mặc định là A).
• -n, --name <string>: Tên bản ghi DNS (sử dụng @ cho bản ghi gốc).
• -p, --proxy <string>: Trạng thái proxy của Cloudflare (mặc định là true).

Ví dụ:

1. Thêm một bản ghi DNS loại A cho tên miền:

   flarectl-node dns add -d example.com -ip 192.168.1.1 -n www -t A -at your_api_token -ae your_email

2. Thêm bản ghi gốc (@) cho tên miền:

   flarectl-node dns add -d example.com -ip 192.168.1.1 -n @ -t A -at your_api_token -ae your_email

Zones Command

Command zones được sử dụng để quản lý các vùng (zones) của Cloudflare, bao gồm thêm, xóa, liệt kê và thêm cùng với bản ghi DNS.

Cách sử dụng:

flarectl-node zones <action> [options]

Tham số:

• <action>: Hành động cần thực hiện. Các lựa chọn:
  • add: Thêm một zone mới.
  • delete: Xóa một zone (tính năng đang phát triển).
  • add_with_dns: Thêm một zone mới kèm bản ghi DNS.
  • list: Liệt kê các zone của tài khoản.

Options:

• -ak, --api-key <string>: Cloudflare API Key (mặc định lấy từ biến môi trường CLOUDFLARE_API_KEY nếu không chỉ định).
• -at, --api-token <string>: Cloudflare API Token (mặc định lấy từ biến môi trường CLOUDFLARE_API_TOKEN nếu không chỉ định).
• -ae, --email <string>: Email tài khoản Cloudflare (mặc định lấy từ biến môi trường CLOUDFLARE_EMAIL nếu không chỉ định).
• -a, --account <string>: ID tài khoản Cloudflare.
• -d, --domain <string>: Tên miền (zone name).
• -ip, --ip <string>: Địa chỉ IP cho bản ghi DNS (chỉ dùng cho hành động add_with_dns).

Ví dụ:

1. Thêm một zone mới:

   flarectl-node zones add -a your_account_id -d example.com -at your_api_token -ae your_email

2. Thêm một zone mới kèm theo bản ghi DNS loại A:

   flarectl-node zones add_with_dns -a your_account_id -d example.com -ip 192.168.1.1 -at your_api_token -ae your_email

3. Liệt kê các zone của tài khoản:

   flarectl-node zones list -a your_account_id -at your_api_token -ae your_email