https://github.com/node-webot/webot-cli

command line interface for weixin-robot
https://github.com/node-webot/webot-cli

Last synced: 5 days ago
JSON representation

command line interface for weixin-robot

• Host: GitHub
• URL: https://github.com/node-webot/webot-cli
• Owner: node-webot
• Created: 2013-04-11T05:25:57.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2016-10-21T10:38:56.000Z (about 8 years ago)
• Last Synced: 2024-04-27T07:32:27.361Z (7 months ago)
• Language: JavaScript
• Size: 36.1 KB
• Stars: 97
• Watchers: 12
• Forks: 28
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# webot-cli

Command line interface for [weixin-robot](https://github.com/node-webot/weixin-robot).

    npm install webot-cli -g

## Commands

```man

  Usage: webot  [options]

  Options:

    -h, --help     output usage information

    -V, --version  output the version number

  Commands:

    send [image|text|loc|..]   send a message to test host

    menu [create|delete|get]   manipulate wechat menu

    help [command]             view help info for specified command

```

Use `webot help` for more details.

## 发送测试消息

```man

  Usage: webot send [type] [options] [message]

  Types:

    # t, text            Send text messages (default)

    # i, image, pic      Send image messages

    # l, loc, location   Send location messages

    # e, event           Send event messages

    # scan               Send scan QRcode event

    # reportloc          Send report location event

  Options:

    --token          API token for wechat, defaults to `process.env.WX_TOKEN`

    --port           The port your service is listening at, defaults to `process.env.PORT`

    --host           Server hostname, defaults to 127.0.0.1

    --route          The subdirectory you are watching

    --des            Request destination, a full url

                     Will override host, port and route

    --user           FromUserName of this message.

  Examples:

    webot send --token abc123 --des http://example.com/webot

    webot send t Hello

    webot send loc 20.12 120.33 "Somewhere Out There"

```

### 在代码里使用

```javascript

var send = require('webot-cli').commands.send

var options = {

  silent: true,

  port: PORT,

  route: media.webotPath(),

  token: media.wx_token,

  input: ['text', 'abcotea']

}

send(options, data)

```

## 微信自定义菜单

    webot help menu

需要一个 json 文件保存 access_token 等配置信息（默认是当前目录的 **wx_config.json**）。

为安全起见，建议你只在本地使用此文件，不要把它放到代码仓库中。

```javascript

{

  "appid": "abcedfe123456",

  "secret": "abcdefghijklmn1234567890"

}

```

### 创建或修改

按照微信文档中的[请求示例][1]，新建一个 json 文件（如`menu.json`），然后利用 stdin 传入 `webot menu create` 命令：

文件 **menu.json** 的内容：

```javascript

 {

     "button":[

     {  

          "type":"click",

          "name":"今日歌曲",

          "key":"V1001_TODAY_MUSIC"

      },

      {

           "type":"click",

           "name":"歌手简介",

           "key":"V1001_TODAY_SINGER"

      },

      {

           "name":"菜单",

           "sub_button":[

            {

               "type":"click",

               "name":"hello word",

               "key":"V1001_HELLO_WORLD"

            },

            {

               "type":"click",

               "name":"赞一下我们",

               "key":"V1001_GOOD"

            }]

       }]

 }

```

执行命令：

    webot menu create --config wx_config.json < menu.json

### 自定义菜单与 webot 的结合

发送文字消息或者触发点击事件都可以：

```

var reg_gequ = /(今日歌曲|today music)/i;

webot.set('today_music', {

  pattern: function(info) {

    return reg_gequ.test(info.text) || info.param.eventKey === 'V1001_TODAY_MUSIC';

  },

  handler: function(info, cb) {

    // 从你的数据库里查找今日歌曲

    cb(null, {

      type: 'music',

      musicUrl: 'http://xxxx...',

      hqMusicUrl: 'http://xxxx...'

    });

  },

});

```

## LICENCE

(the MIT licence)

[1]:http://mp.weixin.qq.com/wiki/index.php?title=%E8%87%AA%E5%AE%9A%E4%B9%89%E8%8F%9C%E5%8D%95%E6%8E%A5%E5%8F%A3#.E8.8F.9C.E5.8D.95.E5.88.9B.E5.BB.BA)