飞书开发者工具-命令行

飞书开发者工具（命令行形式）是由官方推出，供开发者基于飞书开放能力开发生态应用和企业自建应用的开发工具，当前提供了新建项目、登录、登出、本地调试、代码包上传、真机预览、诊断、反馈等功能，更多特性也在持续迭代中。

开发者在安装完命令行工具后，即可在终端使用 opdev 命令。比如：

• 使用 opdev login 登录飞书账号
• 使用 opdev preview 预览正在开发的小程序；
• 使用 opdev upload 上传正在开发的小程序；

通过阅读下面的文档，你可以快速了解本工具的安装和日常使用方式。

安装

命令行安装，直接复制以下脚本在终端中运行

npm install https://lf-cdn-tos.bytescm.com/obj/static/opdev/ide/cli/bdeefe-opdev-cli-2.19.1.tgz -g

• Node.js版本检查

 $ node -v

• NPM版本检查

$ npm -v

验证是否安装成功

任选上面两种方式安装之后，请在命令行终端执行以下指令检查是否成功安装:

$ opdev help

安装正常将看到如下输出：

opdev: Lark Open Platform Developer ToolsetUSAGE$ opdev [COMMAND]COMMANDSAccount relatedlogin Login with feishu accountlogoutLog out of the Feishu account....

也可用opdev version命令来检查工具版本：

$ opdev --version2.19.1

如在安装过程中你可能会遇到如下问题，请先查看下列 FAQ

• 在安装的过程中遇到“permission denied”报错
  
• 在安装的过程中需要“xcodebuild”
  
• 在 macOS 系统下运行独立安装包提示“不受信任的开发者”怎么办？
  

功能介绍

       Lark开发者工具围绕应用项目提供项目预览、上传、反馈等功能，也支持用户登录、登出和租户切换等账号管理能力

指令操作

help（查看帮助信息）

       所有命令都可以使用 help 显示相关帮助信息

# 查看帮助信息$ opdev help# 查看单个命令帮助信息，如上传命令$ opdev upload --help

login（登录Lark账号）

       登录态是使用上传小程序、预览小程序、模拟器内登录等相关操作的前提条件。该命令会打开你的默认浏览器进行登录。若你的浏览器上存有Lark开放平台的登录状态，会默认登录到当前企业用户下，否则需要进行扫码登录。

$ opdev login

logout（登出）

       退出当前账号可执行

$ opdev logout

tenant switch（租户切换）

       在当前登录账号下切换租户（v1.2.0 + 支持）

$ opdev tenant switch

preview（预览）

小程序预览
       移动端用Lark扫描预览二维码打开小程序预览界面，PC端通过“开发者小助手”机器人下发的预览消息卡片进入界面。

小程序预览依赖以下条件：

1. 通过opdev login指令或者模拟器界面已经完成Lark账号登录；
2. 在应用项目中的配置project.config.json填写了正确的 appId，appId 的获取参考文档

       执行预览的指令如下：

$ opdev preview [project-path] --platform=mobile# 或者$ opdev preview [project-path] -p mobile

预览时指定启动页面

       预览时指定启动页面和启动参数（v1.2.0+支持)

opdev preview [project-path] --platform=mobile --startPage 'page/index/index?title="hello"'# 或者opdev preview [project-path] -p mobile --s 'page/index/index?title="hello"'

upload（上传）

       开发完成后上传小程序代码包至开发者后台。

代码包上传依赖以下条件：

1. 通过opdev login指令或者模拟器界面已经完成Lark账号登录；
2. 在应用项目中的配置project.config.json填写了正确的 appId，appId 的获取参考文档

备注：v1.4.0 及以上版本支持小组件的上传，不需要提供 platform

       指令如下：

$ opdev upload [project-path] --platform=pc --version=版本号 --description=描述# 或者$ opdev upload [project-path] -p pc -v 版本号 -d 描述# 必须填写合法的版本号，例如：1.0.0，并且要大于上一次的版本

       上传移动端主导航栏小程序至开发者后台

$ opdev upload [project-path] --type=gadget-nav --platform=mobile --version=版本号 --description=描述# 或者$ opdev upload [project-path] -t gadget-nav -p mobile -v 版本号 -d 描述

feedback（反馈）

        开发过程中遇到问题需要寻求帮助时可以通过这个指令打开反馈入口

$ opdev feedback