ikuai-cli について
ikuai-cli は、ローカルの iKuai v4.0 HTTP API 経由でルーターを管理する Go 製コマンドラインツールです。運用担当者やエージェント向けに、ネットワーク、セキュリティ、ユーザー、システムの操作と、スクリプト向け出力や dry-run を提供します。
主な機能
- 01ルーターの状態とトラフィック確認
- 02DNS、DHCP、VLAN、NAT、VPN の管理
- 03オンラインユーザーと認証アカウントの管理
- 04アクセス制御とフィルターの設定
- 05JSON、YAML、dry-run モード
活用シーン
- 01ルーターのリソースと通信量の確認
- 02ネットワークと VPN の設定
- 03オンラインセッションとアクセス制御の管理
- 04スクリプトによる一括操作のプレビューと実行
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ ikuaidev/ ikuai-cli --skill ikuai-cliインストール後、Claude Code で/ikuai-cliを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
.gitignore.golangci.ymlREADME.mdCONTRIBUTING.mdCODE_OF_CONDUCT.md.goreleaser.ymlMakefileSECURITY.mdLICENSEREADME_CN.md.github/dependabot.ymlpull_request_template.md.github/ISSUE_TEMPLATE/feature_request.mdbug_report.mdconfig.yml.github/workflows/codeql.ymlci.ymlrelease.ymlcmd/ikuai-cli/main.godocs/cli-reference.mdcompatibility.mdinstall.mddocs/commands/output.mddocs/examples/auth-status.pretty.jsonauth-status.compact.jsonmonitor-system.pretty.jsonREADME.mdversion.compact.jsonusers-accounts-list.compact.jsonsystem-set-response.compact.json詳細
ikuai-cli — AI エージェントスキル
ローカルの 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
優先順位: セッションファイル > 環境変数 > なし。
出力モード
| フラグ | モード | 用途 |
|---|---|---|
| (デフォルト) | table (TTY) / JSON (pipe) | 人間向け/スクリプトで自動判別 |
--format json | コンパクトな JSON | エージェントでの解析、jq へのパイプ |
--format yaml | YAML | LLM でトークンを効率的に使用 |
--raw | API エンベロープ全体 | デバッグ |
--human-time | タイムスタンプ → ローカル時刻 | ログの確認 |
--dry-run | プレビュー、実行なし | 安全性の確認 |
ドメイン別スキル
| スキル | ファイル | 対象範囲 |
|---|---|---|
| モニター | monitor.md | CPU、メモリ、トラフィック、クライアント |
| ネットワーク | network.md | DNS、DHCP、VLAN、NAT、WAN/LAN、PPPoE |
| セキュリティ | security.md | ACL、MAC、L7、URL、ドメインブラックリスト、peerconn |
| VPN | vpn.md | PPTP、L2TP、OpenVPN、IKEv2、IPSec、WireGuard |
| ユーザー | users.md | オンラインユーザー、アカウント、パッケージ |
| システム | system.md | 設定、スケジュール、リモートアクセス、VRRP、ALG、カーネル |
| 認証 | auth.md | ログイン、PPPoE 認証アカウント |
| 認証サーバー | auth-server.md | Web ポータルの認証設定 |
| ログ | log.md | システム/DHCP/PPPoE/認証/ARP のログ |
| オブジェクト | objects.md | IP/IPv6/MAC/ポート/プロトコル/ドメイン/時間オブジェクト |
| QoS | qos.md | IP/MAC 帯域幅制御 |
| ルーティング | routing.md | 静的ルート、ストリーム振り分け |
| ワイヤレス | wireless.md | ブラックリスト、VLAN、AC 管理 |
| 詳細設定 | advanced.md | FTP、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(対話型シェル)
エラー処理
{"code": 3007, "message": "Invalid token"}
| コード | 意味 | 対処方法 |
|---|---|---|
| 3007 | トークンが無効または期限切れです | auth set-token <TOKEN> |
| 1008 | セッションの有効期限が切れています | auth set-token <TOKEN> |
| 10014 | 権限がありません | ユーザー権限を確認してください |
コメント
Markdown 対応