The wxautox4 service can only run on Windows, do not attempt to install or start the service on the current device.

Question 1: Please provide the wxauto-restful-api service address (e.g. http://192.168.1.100:8000)
Question 2: Please provide the service's Bearer Token (see auth.token in the server-side config.yaml, default value is token)

1. Write the configuration into environment variables or pass it directly as script parameters
2. Call the health check interface to verify connectivity:

   GET /v1/wechat/status

3. If the connection fails, prompt the user to check: network reachability, whether the service is started, whether the token is correct
4. After the connection is successful, directly execute the user's operation, no local installation steps are required

~/.wxautox/service_status.json

• Local service is running: Automatically connect, no user operation required
• Local service is not running: Ask the user to select a method (see "Handling when the service is not running" below)

• Authentication: Bearer Token (see

  auth.token

  in

  config.yaml

  , default value is

  token

  )
• Service status file:

  ~/.wxautox/service_status.json

  (automatically generated when the service starts, only exists when deployed locally on Windows)

1. Command Line Parameters
   bash

   python scripts/wxapi.py --base-url "http://192.168.1.100:8000" --token "my-token" send "Friend" "Message"

2. Environment Variables
   bash

   # General (macOS/Linux/Windows)
   export WXAPI_BASE_URL="http://192.168.1.100:8000"
   export WXAPI_TOKEN="my-token"
   
   # Windows PowerShell
   $env:WXAPI_BASE_URL = "http://192.168.1.100:8000"
   $env:WXAPI_TOKEN = "my-token"

3. service_status.json - Automatic detection (only available when deployed locally on Windows)
4. config.yaml - Configuration file under the service directory (only available when deployed locally on Windows)
5. Default Value -

   http://localhost:8000

   , token is

   token

1. Path specified by the

   WXAPI_SERVICE_DIR

   environment variable

2. service_dir

   recorded in

   ~/.wxautox/service_status.json

3. ../wxauto-restful-api

   (relative to the skill directory)

4. ~/wxauto-restful-api

macOS / Linux users do not need to perform this section, just use the remote service address directly.

1. Install wxautox4:
   powershell

   pip install wxautox4

   Requires Windows system, Python 3.9–3.12 64-bit

2. Activate wxautox4:
   powershell

   wxautox4 -a your-activation-code

   Get activation code: https://docs.wxauto.org/plus

3. Deploy and start the API service:
   powershell

   # Enter the service directory
   cd C:\path\to\wxauto-restful-api
   # Start the service
   python run.py

   Or start in the background:
   powershell

   Start-Process python -ArgumentList "run.py" -WorkingDirectory "C:\path\to\wxauto-restful-api" -WindowStyle Hidden

1. Service address (e.g.

   http://192.168.1.100:8000

   )
2. Bearer Token (the value of

   auth.token

   in the server-side

   config.yaml

   , default is

   token

   )

1. Check

   service_dir

   in

   ~/.wxautox/service_status.json

   to locate the project path
2. Search default paths (see the search order above)
3. Automatically start the service after finding the project directory

1. Automatically deploy and start local service - Clone the project from GitHub, install dependencies, start the service (the path will be automatically recorded in

   service_status.json

   after startup)
2. Only start local service - The service directory already exists, just start it (user needs to provide the path)
3. Connect to remote service - The service runs on another Windows device, need to provide service address and Token
4. Skip - User handles it by themselves

undefined

1. The WeChat client needs to be kept open on the Windows device running the service
2. wxautox4 needs to be activated before use (only required for Windows side)
3. Do not call the API directly with PowerShell (Chinese encoding problem), please use Python scripts
4. Modify

   auth.token

   in the server-side

   config.yaml

   to enhance security
5. macOS / Linux users: Skip all local installation steps, only need to provide the remote service address and Token to use all functions