这款IDE工具，让你的README「活」起来这是一款允许你在任何地点部署 IDE 环境的产品，你可以使用任何云平台的服务

(本图源 SmartIDE 文档截图，若涉版权，请联系我们删除)

大家好，我是马建仓。

你是否也遇到过上述漫画的场景？

目前市面上有许多非常好用的 IDE工具，他们的出现能帮助开发者集成开发环境，让开发变得更加快捷。每个 IDE 也有自己的侧重点，但在云原生时代，新技术、新概念的诞生已经不是什么新鲜事，开发者们需要学习的东西实在太多了。因此，有开发者提出:是否不用重新学习云计算、K8S 等等知识，只需运行一个命令，就能创建想要的 IDE 环境呢？

今天，我们给大家推荐一款致力于让开发变得简单起来的 IDE 工具—— SmartIDE。

SmartIDE 是什么

这是一款允许你在任何地点部署 IDE 环境的产品，你可以使用任何云平台的服务器，只要能通过 SSH 访问这些服务器就行，可以理解为 IDE 环境的部署工具。

目前，这款产品已经在 Gitee 开源，并已经发布了 SmartIDE Server 版，允许开发者在网页上完成开发环境的搭建和完整的开发调试过程。5月22日，SmartIDE v0.1.17 已经发布，本次同步更新了CLI (Build 3332) 的稳定版通道和Server (Build 3333) 生产环境（内测中）。如果你感兴趣的话，快点进项目地址试试吧。

项目地址： gitee.com/smartide/Sm… 开源许可证： GPL-3.0

特点

跨云支持：一键部署云端 WebIDE 环境
自助化搭建
内置 VSCode 或者 JetBrains WebIDE 的远程工作区，提供熟悉的编码体验
支持三种远程工作区运行模式：本地模式、远程模式和 K8s 模式

内含组件

CLI——面向个人开发者

一个简单易用的命令行工具。开发者使用一个简单的指令 smartide start 即可一键搭建开发环境进行编码和调试。

Server——面向团队

支持私有部署的开源容器化开发环境管理服务。继承 CLI 的所有能力，提供网页化的操作，同时针对团队使用进行扩展和支持。

Marketplace——支持私有部署

SmartIDE插件市场是 open-vsx.org 的一个fork，进行了汉化并提供中国本地部署和插件自动同步服务。

开发者镜像和模板

这是一系列预先构建好的开发环境容器，提供多种开发语言的开发者镜像。

核心功能:IDE 即代码

随时随地的部署 IDE 环境并非它的核心功能。

SmartIDE 设计之初是为了让 README 变得“活”起来。

据 SmartIDE 项目作者在开发过程中发现：开发者们在阅读代码仓库的 README 时，常常发现这份说明书与实际运行的内容经常不配套。这不仅影响开发者对项目的认识，也限制了开源项目的传播与影响力。

因此，他们认为为了让 README 变得活起来，将README.md 变成 README.exe，使得项目说明书运行起来。这样做既能让写文档的人有撰写的动力，又能让阅读文档的人顺畅明了。

这就是SmartIDE 的核心功能：IDE as Code（IDE 即代码）。

怎么操作？

1.设计一个IDE 配置文件（默认为：.ide.yaml)文件格式

version: smartide/v0.2
orchestrator:
  type: docker-compose
  version: 3
workspace:
  dev-container:
    service-name: boathouse-calculator
    webide-port: 6800
    
    ports: 
      webide: 6800
      ssh: 6822
      application: 3001
    
    ide-type: vscode
    volumes: 
      git-config: true
      ssh-key: true
    command:
      - npm install
      - npm start
    
  docker-compose-file: docker-compose.yaml

2.插入指令（smartide start），一键搭建开发环境

## 完整指令
smartide start https://gitee.com/idcf-boat-house/boathouse-calculator.git
## 简化版指令
se up https://gitee.com/idcf-boat-house/boathouse-calculator.git

3.开发与调试