ikuai-cli

Category: Testing & Security | Uploader: ikuaidev | Downloads: 0 | Version: v1.0（Latest）

CLI for managing iKuai routers via local v4.0 API. Use when the user asks to check router status, configure network/DNS/DHCP/VPN/firewall, manage users, view logs, or automate any iKuai router operation. --- # 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)

Changelog: Source: GitHub https://github.com/ikuaidev/ikuai-cli

Directory Structure

Current level: tree/main/

📁 .github/
- 📁 ISSUE_TEMPLATE/
  - 📄 bug_report.md 564 B
  - 📄 config.yml 208 B
  - 📄 feature_request.md 508 B
- 📁 workflows/
  - 📄 ci.yml 848 B
  - 📄 codeql.yml 923 B
  - 📄 release.yml 916 B
- 📄 dependabot.yml 363 B
- 📄 pull_request_template.md 277 B
📁 cmd/
- 📁 ikuai-cli/
  - 📄 main.go 98 B
📁 docs/
- 📁 commands/
  - 📄 output.md 1.7 KB
- 📁 examples/
  - 📄 auth-status.compact.json 75 B
  - 📄 auth-status.pretty.json 88 B
  - 📄 monitor-system.pretty.json 20 B
  - 📄 README.md 1.5 KB
  - 📄 system-set-response.compact.json 20 B
  - 📄 users-accounts-list.compact.json 101 B
  - 📄 version.compact.json 88 B
- 📁 images/
  - 📄 token-step1.png 203.5 KB
- 📄 cli-reference.md 16.9 KB
- 📄 compatibility.md 4.3 KB
- 📄 install.md 1.9 KB
- 📄 releasing.md 895 B
📁 examples/
- 📄 quickstart.sh 205 B
- 📄 read-only.sh 220 B
📁 internal/
- 📁 api/
  - 📄 client.go 8.7 KB
  - 📄 client_test.go 10.3 KB
- 📁 buildinfo/
  - 📄 buildinfo.go 83 B
- 📁 cliapp/
  - 📄 confirm.go 895 B
  - 📄 errors.go 708 B
  - 📄 helpers.go 6.8 KB
  - 📄 helpers_test.go 8.2 KB
  - 📄 runtime.go 3.5 KB
  - 📄 runtime_test.go 5.0 KB
- 📁 cmd/
  - 📁 advanced/
    
    📄 behavior_test.go 7.1 KB
    
    📄 command.go 21.7 KB
  - 📁 auth/
    
    📄 command.go 2.5 KB
    
    📄 command_test.go 2.4 KB
  - 📁 authserver/
    
    📄 behavior_test.go 4.6 KB
    
    📄 command.go 912 B
  - 📁 completion/
    
    📄 command.go 1.5 KB
  - 📁 log/
    
    📄 behavior_test.go 6.6 KB
    
    📄 command.go 4.1 KB
  - 📁 monitor/
    
    📄 command.go 22.6 KB
    
    📄 command_test.go 21.1 KB
  - 📁 network/
    
    📄 behavior_test.go 4.6 KB
    
    📄 command.go 63.6 KB
    
    📄 command_test.go 2.2 KB
  - 📁 objects/
    
    📄 behavior_test.go 6.1 KB
    
    📄 command.go 8.1 KB
  - 📁 qos/
    
    📄 behavior_test.go 7.0 KB
    
    📄 command.go 10.6 KB
  - 📁 routing/
    
    📄 behavior_test.go 10.8 KB
    
    📄 command.go 18.7 KB
  - 📁 security/
    
    📄 behavior_test.go 7.5 KB
    
    📄 command.go 27.1 KB
  - 📁 system/
    
    📄 behavior_test.go 7.4 KB
    
    📄 command.go 32.4 KB
    
    📄 command_test.go 3.7 KB
  - 📁 users/
    
    📄 behavior_test.go 8.8 KB
    
    📄 command.go 15.8 KB
  - 📁 version/
    
    📄 command.go 520 B
    
    📄 command_test.go 1.8 KB
  - 📁 vpn/
    
    📄 behavior_test.go 5.3 KB
    
    📄 command.go 31.3 KB
  - 📁 wireless/
    
    📄 behavior_test.go 5.6 KB
    
    📄 command.go 15.1 KB
  - 📄 repl.go 8.7 KB
  - 📄 repl_test.go 6.4 KB
  - 📄 root.go 8.5 KB
  - 📄 root_test.go 6.8 KB
- 📁 output/
  - 📄 printer.go 5.0 KB
  - 📄 printer_test.go 26.4 KB
  - 📄 table.go 15.9 KB
- 📁 session/
  - 📄 session.go 2.4 KB
  - 📄 session_test.go 2.5 KB
- 📁 ssh/
  - 📄 console.go 4.0 KB
📁 scripts/
- 📄 install.sh 3.2 KB
- 📄 smoke.sh 126 B
📁 skills/
- 📄 advanced.md 1.8 KB
- 📄 auth-server.md 260 B
- 📄 auth.md 220 B
- 📄 batch.md 2.1 KB
- 📄 completion.md 587 B
- 📄 log.md 805 B
- 📄 monitor.md 5.9 KB
- 📄 network.md 4.8 KB
- 📄 objects.md 1.6 KB
- 📄 qos.md 1.1 KB
- 📄 routing.md 3.2 KB
- 📄 security.md 6.6 KB
- 📄 system.md 3.5 KB
- 📄 users.md 1.3 KB
- 📄 vpn.md 4.5 KB
- 📄 wireless.md 1.3 KB
📄 .gitignore 170 B
📄 .golangci.yml 219 B
📄 .goreleaser.yml 889 B
📄 CODE_OF_CONDUCT.md 2.5 KB
📄 CONTRIBUTING.md 819 B
📄 go.mod 428 B
📄 go.sum 1.8 KB
📄 LICENSE 1.1 KB
📄 Makefile 1.5 KB
📄 README.md 7.8 KB
📄 README_CN.md 7.8 KB
📄 SECURITY.md 612 B
📄 SKILL.md 3.3 KB

SKILL.md

---
name: ikuai-cli
description: |
  CLI for managing iKuai routers via local v4.0 API.
  Use when the user asks to check router status, configure network/DNS/DHCP/VPN/firewall,
  manage users, view logs, or automate any iKuai router operation.
---

# 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

| Flag | Mode | Use case |
|------|------|----------|
| (default) | table (TTY) / JSON (pipe) | human / script auto-detect |
| `--format json` | compact JSON | agent parsing, pipe to `jq` |
| `--format yaml` | YAML | token-efficient for LLM |
| `--raw` | full API envelope | debug |
| `--human-time` | timestamp → local time | log reading |
| `--dry-run` | preview, no execute | safety check |

## Domain Skills

| Skill | File | Scope |
|-------|------|-------|
| Monitor | [monitor.md](skills/monitor.md) | CPU, memory, traffic, clients |
| Network | [network.md](skills/network.md) | DNS, DHCP, VLAN, NAT, WAN/LAN, PPPoE |
| Security | [security.md](skills/security.md) | ACL, MAC, L7, URL, domain blacklist, peerconn |
| VPN | [vpn.md](skills/vpn.md) | PPTP, L2TP, OpenVPN, IKEv2, IPSec, WireGuard |
| Users | [users.md](skills/users.md) | Online users, accounts, packages |
| System | [system.md](skills/system.md) | Config, schedules, remote access, VRRP, ALG, kernel |
| Auth | [auth.md](skills/auth.md) | Login, PPPoE auth accounts |
| Auth Server | [auth-server.md](skills/auth-server.md) | Web portal auth config |
| Log | [log.md](skills/log.md) | System/DHCP/PPPoE/auth/ARP logs |
| Objects | [objects.md](skills/objects.md) | IP/IPv6/MAC/port/protocol/domain/time objects |
| QoS | [qos.md](skills/qos.md) | IP/MAC bandwidth control |
| Routing | [routing.md](skills/routing.md) | Static routes, stream shunting |
| Wireless | [wireless.md](skills/wireless.md) | Blacklist, VLAN, AC management |
| Advanced | [advanced.md](skills/advanced.md) | FTP, HTTP, Samba, SNMPD |
| Batch | [batch.md](skills/batch.md) | Multi-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"}
```

| Code | Meaning | Fix |
|------|---------|-----|
| 3007 | Invalid/expired token | `auth set-token <TOKEN>` |
| 1008 | Session expired | `auth set-token <TOKEN>` |
| 10014 | Permission denied | Check user permissions |

Comments 0

Latest | Hot

Please login before commenting.

Loading comments...

ikuai-cli

Directory Structure

SKILL.md

Report

Notice