core

OpenSumi 是一个开源框架，用于快速构建 AI 原生 IDE 产品，支持云 IDE、桌面 IDE 和 Web IDE 等多种形态。其核心功能包括模块化扩展、工具集成和高效开发环境，适用于企业级 IDE 开发。项目提供丰富的示例模板（如 CodeFuse AI IDE）和完善的文档，支持社区贡献，并遵循 MIT 许可证。

article

README

OpenSumi

A framework helps you quickly build AI Native IDE products.

Changelog · Report Bug · Request Feature · English · 中文

perview

🌟 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

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.