@lark-project/cli
Version:
飞书项目插件开发工具
84 lines (72 loc) • 1.83 kB
Markdown
# @lark-project/cli
Command line tool for lark project plugin development.
# Installation & Usage
To install the cli globally you need to run:
```
npm i -g @lark-project/cli
```
Then you can use the commands by typing:
> lmp stands for Lark Project Management. You can use the "lpm" command to perform various tasks such as init a new project, building and releasing applications, etc.
```
lpm <cmd> [options]
```
# Commands
- [`lpm init <project-name> [plugin-id] [plugin-secret]`](#lpm-init-project-name-plugin-id-plugin-secret)
- [`lpm config <operate> [key] [value]`](#lpm-config-operate-key-value)
- [`lpm start`](#lpm-start)
- [`lpm build`](#lpm-build)
- [`lpm release`](#lpm-release)
## `lpm init <project-name> [plugin-id] [plugin-secret]`
> Initialize an Lark Project plugin project
```
USAGE
$ lpm init <project-name> [plugin-id] [plugin-secret]
OPTIONS
-f, --force overwrite target directory if it exist
-h, --help show CLI help
EXAMPLE
$ lpm init plugin-demo MII_0123456789ABCDEF xxxxxx
```
## `lpm config <operate> [key] [value]`
> Set, get or remove plugin configuration
```
USAGE
$ lpm config <operate> [key] [value]
OPTIONS
-g, --global operate global configuration
-h, --help show CLI help
EXAMPLE
$ lpm config set pluginID MII_0123456789ABCDEF
$ lpm config get pluginID
$ lpm config remove pluginID
```
## `lpm start`
> Start the plugin locally
```
USAGE
$ lpm start
OPTIONS
-h, --help show CLI help
EXAMPLE
$ lpm start
```
## `lpm build`
> Build the plugin project as a product file
```
USAGE
$ lpm build
OPTIONS
-h, --help show CLI help
EXAMPLE
$ lpm build
```
## `lpm release`
> Build the plugin project as a product file and upload it to the cloud.
```
USAGE
$ lpm release
OPTIONS
-h, --help show CLI help
EXAMPLE
$ lpm release
```