OpenSumi
A framework helps you quickly build AI Native IDE products.
[![CI][ci-image]][ci-url]
[![E2E][e2e-image]][e2e-url]
[![Test Coverage][test-image]][test-url]
[](http://makeapullrequest.com)
[![Issues need help][help-wanted-image]][help-wanted-url]
[![Discussions][discussions-image]][discussions-url] [![CLA assistant][cla-image]][cla-url] [![License][license-image]][license-url]
[![NPM Version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url]
[![Open in CodeBlitz][codeblitz-image]][codeblitz-url]
[ci-image]: https://github.com/opensumi/core/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/opensumi/core/actions/workflows/ci.yml
[e2e-image]: https://github.com/opensumi/core/actions/workflows/e2e.yml/badge.svg
[e2e-url]: https://github.com/opensumi/core/actions/workflows/e2e.yml
[discussions-image]: https://img.shields.io/badge/discussions-on%20github-blue
[discussions-url]: https://github.com/opensumi/core/discussions
[npm-image]: https://img.shields.io/npm/v/@opensumi/ide-core-common.svg
[npm-url]: https://www.npmjs.com/package/@opensumi/ide-core-common
[download-image]: https://img.shields.io/npm/dm/@opensumi/ide-core-common.svg
[download-url]: https://npmjs.org/package/@opensumi/ide-core-common
[license-image]: https://img.shields.io/npm/l/@opensumi/ide-core-common.svg
[license-url]: https://github.com/opensumi/core/blob/main/LICENSE
[cla-image]: https://cla-assistant.io/readme/badge/opensumi/core
[cla-url]: https://cla-assistant.io/opensumi/core
[test-image]: https://codecov.io/gh/opensumi/core/branch/main/graph/badge.svg?token=07JAPLU957
[test-url]: https://codecov.io/gh/opensumi/core
[codeblitz-image]: https://img.shields.io/badge/Ant_Codespaces-Open_in_CodeBlitz-1677ff
[codeblitz-url]: https://codeblitz.cloud.alipay.com/github/opensumi/core
[github-issues-url]: https://github.com/opensumi/core/issues
[help-wanted-image]: https://flat.badgen.net/github/label-issues/opensumi/core/π€%20help%20wanted/open
[help-wanted-url]: https://github.com/opensumi/core/issues?q=is%3Aopen+is%3Aissue+label%3A%22π€+help+wanted%22
[Changelog](./CHANGELOG.md) Β· [Report Bug][github-issues-url] Β· [Request Feature][github-issues-url] Β· English Β· [δΈζ](./README-zh_CN.md)
π Getting Started
Here you can find some of our example projects and templates:
β‘οΈ Development
$ yarn install
$ yarn run init
$ yarn run download-extension # Optional
$ yarn run start
By default, the tools/workspace folder in the project would be opened, or you can run the project by specifying the directory in the following way:
$ MY_WORKSPACE={local_path} yarn run start
Usually, you may still encounter some system-level environment dependencies. You can visit Development Environment Preparation to see how to install the corresponding environment dependencies.
π Documentation
For complete documentation: opensumi.com
π ReleaseNotes & BreakingChanges
You can see all the releasenotes and breaking changes here: CHANGELOG.md.
π₯ Contributing
Read through our Contributing Guide to learn about our submission process, coding rules and more.
πββοΈ Want to Help?
Want to report a bug, contribute some code, or improve documentation? Excellent! Read up on our Contributing Guidelines for contributing and then check out one of our issues labeled as help wanted or good first issue.
π§βπ» Needs some help?
Go to our issues or discussions to create a topic, it will be resolved as soon as we can.
β¨ Contributors
Let's build a better OpenSumi together.
We warmly invite contributions from everyone. Before you get started, please take a moment to review our Contributing Guide. Feel free to share your ideas through Pull Requests or GitHub Issues.
π License
Copyright (c) 2019-present Alibaba Group Holding Limited, Ant Group Co. Ltd.
Licensed under the MIT license.
This project contains various third-party code under other open source licenses.
See the NOTICE.md file for more information.
