mcpField
I
ikuai-cli

ikuai-cli

github.com/ikuaidev云与 DevOps141283 次安装10 周前更新
代码仓库

关于 ikuai-cli

ikuai-cli 是一个 Go 命令行工具，可通过本地 iKuai v4.0 HTTP API 管理路由器，适用于运维人员和 Agent。它覆盖网络、安全、用户及系统操作，并提供适合脚本和 Agent 解析的输出格式与 dry-run 预览。

主要功能

  1. 01查看路由器状态与流量
  2. 02管理 DNS、DHCP、VLAN、NAT 和 VPN
  3. 03管理在线用户与认证账户
  4. 04配置访问控制及过滤规则
  5. 05支持 JSON、YAML 与 dry-run

适用场景

  1. 01检查路由器资源和网络流量
  2. 02配置网络及 VPN 设置
  3. 03管理在线会话和访问控制
  4. 04通过脚本预览或执行批量操作

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/ikuaidev/ikuai-cli --skill ikuai-cli

安装后在 Claude Code 中输入/ikuai-cli确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

.gitignore
.golangci.yml
README.md
CONTRIBUTING.md
CODE_OF_CONDUCT.md
.goreleaser.yml
Makefile
SECURITY.md
LICENSE
README_CN.md
.github/
dependabot.yml
pull_request_template.md
.github/ISSUE_TEMPLATE/
feature_request.md
bug_report.md
config.yml
.github/workflows/
codeql.yml
ci.yml
release.yml
cmd/ikuai-cli/
main.go
docs/
cli-reference.md
compatibility.md
install.md
docs/commands/
output.md
docs/examples/
auth-status.pretty.json
auth-status.compact.json
monitor-system.pretty.json
README.md
version.compact.json
users-accounts-list.compact.json
system-set-response.compact.json

详细介绍

ikuai-cli — AI Agent 技能

通过本地 v4.0 HTTP API 管理 iKuai 路由器的 Go CLI。

使用场景

  • 路由器状态、CPU、内存、运行时间、流量
  • 网络：DNS、DHCP、VLAN、NAT、PPPoE、VPN
  • 用户：在线会话、踢下线、认证账户
  • 安全：ACL、MAC 过滤、URL 过滤、域名黑名单
  • 系统：日志、计划任务、远程访问、VRRP

前置条件

# Session (persistent)
ikuai-cli auth set-url https://192.168.1.1
ikuai-cli auth set-token <TOKEN>

# OR environment variables (ephemeral)
export IKUAI_CLI_BASE_URL=https://192.168.1.1
export IKUAI_CLI_TOKEN=<TOKEN>

# Verify
ikuai-cli auth status --format json

**优先级：**会话文件 > 环境变量 > 无。

输出模式

标志模式用途
(default)table (TTY) / JSON (pipe)自动检测人类 / 脚本
--format json紧凑 JSONAgent 解析、通过管道传给 jq
--format yamlYAML节省大模型 token
--raw完整 API 信封调试
--human-time时间戳 → 本地时间阅读日志
--dry-run预览，不执行安全检查

领域技能

技能文件范围
监控monitor.mdCPU、内存、流量、客户端
网络network.mdDNS、DHCP、VLAN、NAT、WAN/LAN、PPPoE
安全security.mdACL、MAC、L7、URL、域名黑名单、peerconn
VPNvpn.mdPPTP、L2TP、OpenVPN、IKEv2、IPSec、WireGuard
用户users.md在线用户、账户、套餐
系统system.md配置、计划任务、远程访问、VRRP、ALG、内核
认证auth.md登录、PPPoE 认证账户
认证服务器auth-server.mdWeb 门户认证配置
日志log.md系统/DHCP/PPPoE/认证/ARP 日志
对象objects.mdIP/IPv6/MAC/端口/协议/域名/时间对象
QoSqos.mdIP/MAC 带宽控制
路由routing.md静态路由、流量分流
无线网络wireless.md黑名单、VLAN、AC 管理
高级advanced.mdFTP、HTTP、Samba、SNMPD
批处理batch.md多命令工作流

命令格式

ikuai-cli <resource> <action> [args] [flags]
  • 读取：ikuai-cli monitor system --format json
  • 列表：ikuai-cli network dhcp list --page 1 --page-size 50
  • 写入：ikuai-cli network dhcp create --name "Office" --interface lan1 --addr-pool 192.168.1.100-200
  • 写入（备用方式）：ikuai-cli network dns set --data '{"key":"value"}'
  • REPL：ikuai-cli（交互式 Shell）

错误处理

{"code": 3007, "message": "Invalid token"}
代码含义解决方法
3007令牌无效或已过期auth set-token <TOKEN>
1008会话已过期auth set-token <TOKEN>
10014权限被拒绝检查用户权限

评论

支持 Markdown