OpenSumi

一个帮助您快速构建原生 AI 集成开发环境的框架。

🌟 快速入门

在这里您可以找到我们的一些示例项目和模板：

• 云 IDE
• 基于 Electron 的桌面 IDE
• CodeFuse IDE - 基于 OpenSumi 的 AI IDE
• CodeBlitz - 一个纯 Web IDE 框架
• 轻量级 Web IDE - 浏览器端的纯 Web IDE
• 类似 IDE 的迷你应用

⚡️ 开发

$ yarn install
$ yarn run init
$ yarn run download-extension  # 可选
$ yarn run start

默认情况下，项目中的 tools/workspace 文件夹会被打开；您也可以通过指定目录来运行项目，方法如下：

$ MY_WORKSPACE={本地路径} yarn run start

通常，您可能还需要一些系统级别的环境依赖。请访问 开发环境准备 以了解如何安装相应的环境依赖。

📕 文档

完整的文档请访问：opensumi.com

📍 发布说明与重大变更

您可以在此处查看所有的发布说明和重大变更：CHANGELOG.md。

🔥 贡献

请阅读我们的 贡献指南，了解我们的提交流程、编码规范等信息。

🙋‍♀️ 想要帮忙吗？

想报告一个 bug、贡献代码或改进文档吗？太好了！请先阅读我们的 贡献指南，然后查看那些标记为“需要帮助”或“适合新手”的问题。

🧑‍💻 需要帮助吗？

前往我们的 问题列表 或 讨论区 创建一个话题，我们会尽快为您解决。

✨ 贡献者

让我们一起构建更优秀的 OpenSumi。

我们诚挚地邀请大家参与贡献。在开始之前，请花点时间阅读我们的贡献指南。您可以通过拉取请求或GitHub 问题分享您的想法。

📃 许可证

版权所有 © 2019 年至今，阿里巴巴集团控股有限公司、蚂蚁科技集团股份有限公司。

根据 MIT 许可证授权。

本项目包含多种采用其他开源许可证的第三方代码。

更多信息请参阅 NOTICE.md 文件。

OpenSumi 快速上手指南

OpenSumi 是一个帮助你快速构建 AI 原生 IDE 产品的框架。本指南将带你完成环境准备、安装及基本运行。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• Node.js: 建议安装 LTS 版本（具体版本要求可参考项目 .nvmrc 或官方文档）。
• Yarn: 项目使用 Yarn 作为包管理器。

  npm install -g yarn
  # 国内开发者推荐使用淘宝镜像加速
  yarn config set registry https://registry.npmmirror.com
  

• Git: 用于克隆代码仓库。
• 系统依赖: 根据操作系统不同，可能需要安装额外的构建工具（如 Python, Make, C++ 编译器等）。如遇报错，请参考 开发环境准备文档 进行补全。

安装步骤

1. 克隆项目

   git clone https://github.com/opensumi/core.git
   cd core
   

2. 安装依赖

   yarn install
   

3. 初始化项目

   yarn run init
   

4. 下载扩展（可选） 如果需要预置一些常用扩展，可执行：

   yarn run download-extension
   

基本使用

完成安装后，你可以通过以下命令启动开发服务器。

• 默认启动 默认会打开项目内的 tools/workspace 文件夹作为工作区：

  yarn run start
  

• 指定工作区启动 你也可以通过环境变量指定本地任意目录作为工作区：

  MY_WORKSPACE={local_path} yarn run start
  

  请将 {local_path} 替换为你本地的实际路径，例如 /Users/name/my-project 或 D:\code\my-project。

启动成功后，浏览器会自动打开或在控制台显示访问地址，即可体验基于 OpenSumi 构建的 IDE 界面。

提示：更多完整文档请访问 opensumi.com，或查看仓库中的示例项目（如 Cloud IDE、Desktop IDE 等）以获取进阶用法。