MonkeyCode/README.md

# 暂未正式发布，敬请期待

<p align="center">
  <img src="/images/banner.png" width="400" />
</p>

<p align="center">
  <a target="_blank" href="https://monkeycode.docs.baizhi.cloud/">📖 官方网站</a> &nbsp; | &nbsp;
  <a target="_blank" href="/images/wechat.png">🙋‍♂️ 微信交流群</a>
</p>

## 👋 项目介绍

> 还在为 cursor 要上传你的核心代码而烦恼吗？  
> 还在为离线环境无法使用 cursor 而烦恼吗？  
> 为什么不试试 MonkeyCode？

**MonkeyCode** 是一款专为研发管理而设计的 AI 编程助手，它不仅仅是普通的 AI 编程助手，还包含了功能远超 Cursor Team 版的企业级管理面板。

MonkeyCode 充分考虑了隐私和安全，支持**完全私有化和离线使用**，在帮助你快速完成代码编写，提高开发效率的同时，还支持对 AI 编程行为进行严格审计和管控。

> MonkeyCode 客户端插件部分基于 [Roo Code](https://github.com/RooCodeInc/Roo-Code) 开发，在 Roo Code 的基础上增加了 `代码补全` 和 `代码安全扫描` 功能，并优化了用户体验。  
> 感谢 Roo Code 团队 🙏🙏🙏

## ⚡️ 界面展示

| -                                                | -                                                |
| ------------------------------------------------ | ------------------------------------------------ |
| <img src="/images/screenshot-1.png" width=370 /> | <img src="/images/screenshot-2.png" width=370 /> |
| <img src="/images/screenshot-3.png" width=370 /> | <img src="/images/screenshot-4.png" width=370 /> |

## 🔥 功能与特色

- **企业级管理面板**：对使用 AI 编程行为进行严格审计和管控，确保团队协作的高效性和安全性。
- **私有化部署**：支持一键安装到私有化环境，支持完全离线使用，让你的代码隐私得到保障。
- **代码安全扫描**：AI 生成的代码是否安全可靠？MonkeyCode 内置了安全扫描引擎，帮助你发现代码中可能存在的高风险安全漏洞。
- **智能代码补全**：通过 AI 理解代码上下文并生成补全建议，减少手动输入代码的时间，显著提升开发效率。
- **自然语言编程**：通过自然语言对话，让 AI 帮你自动完成编程、调试、设计、文档等工作。

## 🚀 上手指南

### 安装 MonkeyCode

你需要一台支持 Docker 20.x 以上版本的 Linux 系统来安装 MonkeyCode。

使用 root 权限登录你的服务器，然后执行以下命令。

```bash
bash -c "$(curl -fsSLk https://release.baizhi.cloud/monkeycode/manager.sh)"
```

根据命令提示的选项进行安装，命令执行过程将会持续几分钟，请耐心等待。

### 登录 MonkeyCode

安装成功后会输出如下的访问信息。通过输出的用户名和密码登录访问地址。

```
SUCCESS  控制台信息:
SUCCESS    访问地址(内网): http://*.*.*.*:<port>
SUCCESS    访问地址(外网): http://*.*.*.*:<port>
SUCCESS    用户名: admin
SUCCESS    密码: **********************
```

### 配置与初始化

### 邀请成员

### 安装 IDE 插件

### 开始使用

## 社区交流

欢迎加入我们的微信群进行交流。

<img src="/images/wechat.png" width="300" />

## 🙋‍♂️ 贡献

欢迎提交 [Pull Request](https://github.com/chaitin/MonkeyCode/pulls) 或创建 [Issue](https://github.com/chaitin/MonkeyCode/issues) 来帮助改进项目。


## 📝 许可证

本项目采用 GNU Affero General Public License v3.0 (AGPL-3.0) 许可证。这意味着：

- 你可以自由使用、修改和分发本软件
- 你必须以相同的许可证开源你的修改
- 如果你通过网络提供服务，也必须开源你的代码
- 商业使用需要遵守相同的开源要求