Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opensumi/cli
🛠️ Standard Tooling for OpenSumi Extensions Development
https://github.com/opensumi/cli
Last synced: 3 days ago
JSON representation
🛠️ Standard Tooling for OpenSumi Extensions Development
- Host: GitHub
- URL: https://github.com/opensumi/cli
- Owner: opensumi
- License: mit
- Created: 2022-10-31T03:05:35.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-07T11:43:45.000Z (7 months ago)
- Last Synced: 2024-04-13T15:43:38.504Z (7 months ago)
- Language: TypeScript
- Size: 3.48 MB
- Stars: 0
- Watchers: 20
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenSumi CLI
[![NPM Version][npm-image]][npm-url]
[![NPM downloads][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/@opensumi/cli.svg
[npm-url]: https://www.npmjs.com/package/@opensumi/cli
[download-image]: https://img.shields.io/npm/dm/@opensumi/cli.svg
[download-url]: https://npmjs.org/package/@opensumi/cli
[license-image]: https://img.shields.io/npm/l/@opensumi/cli.svg
[license-url]: https://github.com/opensumi/core/blob/main/LICENSE
[license-image]: https://img.shields.io/npm/l/@opensumi/cli.svg
[license-url]: https://github.com/opensumi/core/blob/main/LICENSE
🛠️ Standard Tooling for OpenSumi Extensions Development
## Develop
```bash
$ yarn
$ yarn dev
```
Test command on the local:
```bash
$ ./packages/cli/bin/sumi.js [options]
```
## Publish
```bash
$ yarn release
```
Then push commits and tag to the main branch, the `@opensumi/cli@{tag_version}` will release automatically.
## Usage
Install `@opensumi/cli`:
```
$ npm install @opensumi/cli -g
```
Initailize the template:
```
$ sumi init opensumi-ext-demo
$ cd opensumi-ext-demo
$ npm run watch
$ sumi dev
```
## Commands
```md
Usage: sumi [options]
Options:
-V, --version output the version number
-h, --help output usage information
Commands:
init init a new extension powered by OpenSumi
watch watch extension in development mode
dev [options] launch OpenSumi IDE load specified extension.
compile compile extension in production mode
package [options] Packages an extension
install [extensionDir] installing a extension
engine OpenSumi cli engine management
add download and install a [version]
remove remove specific [version] engine
use change current engine to [version]
ls list installed engine versions
ls-remote list remote engine versions available for install
current display currently selected version
Run sumi --help for detailed usage of given command.
```
## Use the specified OpenSumi version
1. List the remote engine version
```
$ sumi engine ls-remote
2.22.10-rc-1679037411.0 rc
-> 2.23.0 latest
```
2. Add expected version
```
$ sumi engine add 2.23.0
```
## License
Copyright (c) 2019-present Alibaba Group Holding Limited, Ant Group Co. Ltd.
Licensed under the [MIT](LICENSE) license.