ikuaidev/ikuai-cli

ikuai-cli

CLI for managing iKuai routers via local v4.0 API.

View source

How to use

  1. Copy the installation command and review the source package before installing it in your own agent environment.
  2. Check the source document for required tools, credentials and supported hosts.
  3. Describe your input and desired deliverable; review the output against the source material.
npx skills add https://github.com/ikuaidev/ikuai-cli --skill ikuai-cli

Before you start

  • Installation does not include a model subscription, API allowance or permission to access your files.
  • Repository stars and installation counts describe activity, not an independent quality or security test.
Original skill document

Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.

ikuai-cli — AI Agent Skill

Go CLI for managing iKuai routers through the local v4.0 HTTP API.

When to Use

  • Router status, CPU, memory, uptime, traffic
  • Network: DNS, DHCP, VLAN, NAT, PPPoE, VPN
  • Users: online sessions, kick, auth accounts
  • Security: ACL, MAC filter, URL filter, domain blacklist
  • System: logs, schedules, remote access, VRRP

Prerequisites

bash
# 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
Priority: Session file > Environment variables > None.

Output Modes

FlagModeUse case
(default)table (TTY) / JSON (pipe)human / script auto-detect
--format jsoncompact JSONagent parsing, pipe to jq
--format yamlYAMLtoken-efficient for LLM
--rawfull API envelopedebug
--human-timetimestamp → local timelog reading
--dry-runpreview, no executesafety check

Domain Skills

SkillFileScope
Monitormonitor.mdCPU, memory, traffic, clients
Networknetwork.mdDNS, DHCP, VLAN, NAT, WAN/LAN, PPPoE
Securitysecurity.mdACL, MAC, L7, URL, domain blacklist, peerconn
VPNvpn.mdPPTP, L2TP, OpenVPN, IKEv2, IPSec, WireGuard
Usersusers.mdOnline users, accounts, packages
Systemsystem.mdConfig, schedules, remote access, VRRP, ALG, kernel
Authauth.mdLogin, PPPoE auth accounts
Auth Serverauth-server.mdWeb portal auth config
Loglog.mdSystem/DHCP/PPPoE/auth/ARP logs
Objectsobjects.mdIP/IPv6/MAC/port/protocol/domain/time objects
QoSqos.mdIP/MAC bandwidth control
Routingrouting.mdStatic routes, stream shunting
Wirelesswireless.mdBlacklist, VLAN, AC management
Advancedadvanced.mdFTP, HTTP, Samba, SNMPD
Batchbatch.mdMulti-command workflows

Command Shape

ikuai-cli <resource> <action> [args] [flags]
  • Read: ikuai-cli monitor system --format json
  • List: ikuai-cli network dhcp list --page 1 --page-size 50
  • Write: ikuai-cli network dhcp create --name "Office" --interface lan1 --addr-pool 192.168.1.100-200
  • Write (escape hatch): ikuai-cli network dns set --data '{"key":"value"}'
  • REPL: ikuai-cli (interactive shell)

Error Handling

json
{"code": 3007, "message": "Invalid token"}
CodeMeaningFix
3007Invalid/expired tokenauth set-token <TOKEN>
1008Session expiredauth set-token <TOKEN>
10014Permission deniedCheck user permissions