Skip to content

README.en.md

Latest commit

 

History

History
91 lines (58 loc) · 2.72 KB

README.en.md

File metadata and controls

91 lines (58 loc) · 2.72 KB

weixin-agent-bot

简体中文

WeChat iLink + DeepSeek CLI: connects to the DeepSeek API through the Vercel AI SDK. Scan QR to bind WeChat, then auto-reply with your chosen model and keep multi-turn context per WeChat user.

No OpenClaw deployment: this runs as a normal Node CLI on your machine (or any server with Node). You do not need to set up or host WeChat OpenClaw — configure DEEPSEEK_API_KEY via .env or prompts.

License: MIT

Quick start (community)

Requires Node.js ≥ 22.

Option A: npx (no global install) — type the package name each time; good for occasional use.

# Run the latest release without cloning (downloads on first run; -y skips install prompt)
npx -y weixin-agent-bot@latest

Option B: global install — install once, then run weixin-agent-bot from any directory.

npm install -g weixin-agent-bot@latest
weixin-agent-bot

Upgrade the global install:

npm install -g weixin-agent-bot@latest

Then follow the prompts. Optional: create a .env in the current directory (see .env.example in the repo) so the CLI can skip questions — copy from .env.example.

Common flags (copy-paste)

Examples below use npx. If you used Option B, replace npx -y weixin-agent-bot@latest … with weixin-agent-bot … (same flags).

--help — print all options and environment variables:

npx -y weixin-agent-bot@latest --help

--version — print the CLI version:

npx -y weixin-agent-bot@latest --version

--force-login — ignore cached session and show the WeChat QR login again:

npx -y weixin-agent-bot@latest --force-login

--reauth — enter DeepSeek API key / model settings again:

npx -y weixin-agent-bot@latest --reauth

You can combine flags, e.g. fresh WeChat login and DeepSeek re-auth:

npx -y weixin-agent-bot@latest --force-login --reauth

WeChat chat commands

Send /new in WeChat to clear your current per-user context and start a new chat.

Develop from source

git clone https://github.com/luckfunc/weixin-agent-bot.git
cd weixin-agent-bot
npm install
npm run dev
# or: npm run build && node dist/cli.js

WeChat SDK

Uses @pinixai/weixin-bot (sources: epiral/weixin-bot). postinstall runs a local build of that package because the npm tarball ships TypeScript only.

Thanks

weixin-bot by @epiral — thank you for the Node.js SDK and protocol work.