maixcode-cli (maix / maixcode)

Agent-friendly CLI for MaixCAM / MaixPy devices. Same control plane as the MaixCode VS Code extension.

| Transport | Port | Use | |-----------|------|-----| | WebSocket binary protocol | 7899 | Auth maixvision, Run / Stop / DeviceInfo / Img / InstallApp | | SSH | 22 | One-shot exec (default root:root, then root:sipeed) | | mDNS | LAN | Discover maixcam* on _ssh._tcp.local |

Also ships an agent skill at skills/maixcode/.

Install

npm install -g maixcode-cli
# or
npx maixcode-cli discover --json
# bins after global install:
maix -h
maixcode -h

From source:

git clone https://github.com/MaixCode/maixcode-cli.git
cd maixcode-cli
yarn install   # or npm install
yarn build
node dist/index.js discover --json

Commands

maix discover [--duration 3000] [--json]
maix info --host <ip> [--json]
maix run --host <ip> -e "print(1)" | -f script.py | script.py
maix stop --host <ip>
maix exec --host <ip> "uname -a"
maix image --host <ip> -o frame.jpg
maix install --host <ip> app.zip
maix doctor [--host <ip>] [--json]

Environment:

• MAIX_HOST / MAIXCODE_HOST — default device IP
• MAIX_SSH_USER — user:pass for exec

Agent skill

After install, skill files live under the package:

# npm global root example
npm root -g
# .../node_modules/maixcode-cli/skills/maixcode/

Install into your agent skills dir (OpenCode / Codex-style):

# from a clone or after npm pack extract
cp -R skills/maixcode ~/.agents/skills/maixcode

Or with the skills CLI when the GitHub repo is public:

npx skills add MaixCode/maixcode-cli@maixcode

See skills/maixcode/SKILL.md.

Protocol

Framing matches MaixCode src/service/websocket_service.ts (magic AC BE CB CA). Keep this package and the extension in sync when changing command IDs (src/protocol.ts here).

License

Apache-2.0