https://github.com/dream-num/cli
Command-line tool for quickly creating univer plugins.
https://github.com/dream-num/cli
cli template univer
Last synced: 9 months ago
JSON representation
Command-line tool for quickly creating univer plugins.
- Host: GitHub
- URL: https://github.com/dream-num/cli
- Owner: dream-num
- License: apache-2.0
- Created: 2023-10-10T08:46:18.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-31T09:17:52.000Z (over 1 year ago)
- Last Synced: 2025-04-01T21:56:01.074Z (9 months ago)
- Topics: cli, template, univer
- Language: TypeScript
- Homepage:
- Size: 705 KB
- Stars: 1
- Watchers: 9
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @univerjs/create-cli
[](https://npmjs.org/package/@univerjs/create-cli)
> Command-line tool for quickly playing with [Univer](https://github.com/dream-num/univer).
## Features
- **Plugin Quickstart:** Swiftly create a new Univer plugin with ease.
- **Custom UMD Package:** Tailor your own UMD package with customizable options
See [Univer docs](https://univer.work/en-us/guides/extend/write-a-plugin/) for more information.
## Usage
Run the following command and follow the prompts to create a plugin:
```sh
# npm
npm create @univerjs/cli@latest
# pnpm
pnpm create @univerjs/cli@latest
```
### Options
#### **-l, --locale \**
Special locale. Available options are `zh-CN` and `en-US`.
#### **-h, --help**
Display help for command.
## Development
```sh
pnpm i
pnpm dev
```
test, create `filter` plugin
```sh
node dist/index.js
```