# 初始化环境(init)
在开发环境编码时，建议通过直接使用tplugin-cli serve进行调试。
如果确实需要通过直接调用文件的方式进行调试，需要首先tplugin-cli init获取应用初始化信息。
# 本地调试(serve)
完成相关配置之后，需要开始对本地的代码进行开发和调试。tplugin-cli 提供了 serve 指令。serve 指令要求用户选择一个公司作为调试公司，插件启动后，插件所有的功能都在对应公司中生效。可以实时的在对应公司中调试和测试本地插件代码。
注意：只能选择未安装该插件的公司。
tplugin-cli serve
Usage: tplugin-cli serve [OPTIONS]
用于运行和调试本地插件代码，可以选择一个公司作为调试公司，启动后，本地插件代码将直接于目标公司生效。
Options:
-h --help display help for command
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
当出现下面提示时，表示监听成功。
✔ plugin.yaml校验通过！
✔ 初始化配置获取成功
✔ 配置信息写入成功 .env.yaml
? 请选择一个调试公司 755:TAPD平台
进入调试公司: https://tapd.cn/755
✔ 代理服务器连接成功
✔ 订阅远端成功.可以开始调试代码.
⠸ 监听请求 ...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
例如, 当需求创建时，调用 modules/webhooks/handle_story_update.py 的index函数。
- pluing.yaml 配置
app:
code: demo
desc: Demo
name: demo
icon:
modules:
webhooks:
- events:
- story::create
handler: handle_story_create.index
scopes:
- story
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- 监听效果，对应事件发生时，本地插件将执行收到对应的事件，并调用执行，返回响应数据。
Request: [ 2c306bda-cd9a-11eb-a561-0242ac120002 ]
Body:
{"function":"webhooks.handle_story_update.handle","data":{"event":"story::create","event_from":"web","referer":"{host}\/755\/prong\/stories\/stories_list","workspace_id":20358514,"current_user":"tapd","id":"1020358514854906865","secret":"","rio_token":"","queue_id":"157864","event_id":"143455","created":"2021-06-15 13:25:37"}}
Response:
{'code': 200, 'msg': '', 'data': None}
1
2
3
4
5
6
7
2
3
4
5
6
7
← Hello World 日志查看 →