Skip to content

CLI Installation

The wx CLI lets you manage the agent-wechat container and interact with WeChat from your terminal.

Install

Terminal window
npm install -g @agent-wechat/cli

This installs the wx command globally.

Prerequisites

  • Node.js >= 22
  • Docker installed and running

Verify installation

Terminal window
wx --version

Configuration

The CLI reads configuration from:

SourceDescription
AGENT_WECHAT_URLServer URL (default: http://localhost:6174)
AGENT_WECHAT_TOKENAuth token (overrides token file)
~/.config/agent-wechat/tokenAuto-generated auth token (created on first wx up)

The auth token is generated automatically on first run and shared with the container via a read-only volume mount.

Global options

OptionDescription
-V, --versionShow version
-h, --helpShow help