Files
MonkeyCode/README.md
2025-07-01 17:11:47 +08:00

72 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<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>
## 👋 项目介绍
MonkeyCode 是一个开源的 AI 编程助手旨在通过智能代码补全、错误检测、代码重构和文档生成等功能提升开发者的编码效率和代码质量。无论您是经验丰富的专业人士还是编程新手MonkeyCode 都能成为您开发流程中不可或缺的强大工具。
## ⚡️ 界面展示
## 🔥 功能与特色
## 🚀 上手指南
### 安装 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) 许可证。这意味着:
- 你可以自由使用、修改和分发本软件
- 你必须以相同的许可证开源你的修改
- 如果你通过网络提供服务,也必须开源你的代码
- 商业使用需要遵守相同的开源要求