Skip to content

Commit 56ebcb2

Browse files
authored
feat(docs): update README and localization files with new features and images; remove outdated GIFs (#634)
1 parent 8fa28ad commit 56ebcb2

18 files changed

+57
-57
lines changed

README.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,52 +9,59 @@ English | <a href="https://github.com/zgsm-ai/costrict/blob/main/README.zh-CN.md
99
<br>
1010
<br>
1111

12+
Costrict is a **free, open-source AI-assisted programming tool** that supports private deployment for enterprises, making it the optimal choice for enterprise serious programming. Its core capabilities are outstanding: **Strict Mode,Code Review** , Code Completion, etc. Feature highlights include: enterprise-level business understanding, standardized AI development processes, Vibe Mode, MCP service, multiple advanced free models, API/model customization, mode selection/customization, image context capabilities, and more. It supports multiple mainstream IDEs and leads the way in supporting VS Code and JetBrains IDEs. Compatible with popular languages including Python, Go, Java, JavaScript/ TypeScript, and C/C++."
13+
1214
<div align="center">
1315

1416
<a href="https://marketplace.visualstudio.com/items?itemName=zgsm-ai.zgsm" target="_blank"><img src="./assets/images/readme/download on vscode marketplace_en.png" alt="Download on VS Marketplace"></a>
1517
<img src="./assets/images/readme/rate review_en.png" alt="Rate Review">
18+
<a href="https://docs.costrict.ai/en/guide/installation/" target="_blank"><img src="./assets/images/readme/docs_center_en.png" alt="Docs Center"></a>
1619

1720
</div>
1821

19-
CoStrict is a **free**, **open-source AI-assisted programming tool** that supports private deployment for enterprises, making it the optimal choice for enterprise serious programming. Its core capabilities are outstanding: Code Review, AI Agent, Code Completion, etc. Feature highlights include: enterprise-level code repository indexing, MCP service, multiple advanced free models, API/model customization, mode selection/customization, image context capabilities, and more. It supports multiple mainstream IDEs and leads the way in supporting VS Code. Compatible with popular languages including Python, Go, Java, JavaScript/TypeScript, and C/C++."
20-
2122
## Features
2223

23-
- **Code Review**: Code Review enables indexing and parsing of entire code repositories, implementing company-wide RAG (Retrieval-Augmented Generation) for coding knowledge. It adopts the strategy of "specialized checks by a multi-expert model" + "cross-confirmation by multiple models." It supports users in conducting code checks on functions, selected code lines, code files, and entire project files.
24+
- **Strcit Mode:**
2425

25-
<br>
26+
Strict Mode standardizes the process of AI-generated code, making it more aligned with enterprise development scenarios. It systematically breaks down a single requirement into steps such as:Requirements Analysis, Architecture Design, Task Planning and Test Generation etc. acting as a standardized procedure for AI to ensure high-quality and highly controllable output.
2627

27-
![reviewgif](./assets/images/readme/codereview_en.gif)
28+
<a href="https://docs.costrict.ai/en/tutorial-videos/video/#strict-mode" target="_blank"><img src="./assets/images/readme/strict_mode_en_buffer.png" alt="Docs Center"></a>
2829

29-
![codereview](./assets/images/readme/codereview_en.png)
30+
![Strcit Mode](./assets/images/readme/strict_mode_en.png)
3031

31-
- **AI Agent**: The AI Agent can perform end-to-end tasks based on developer requirements, featuring capabilities including: autonomous decision-making, full-repository context retrieval, tool invocation, error repair, and terminal operation. While maintaining comparable effectiveness, it reduces costs by over 50% compared to other open-source alternatives.
32-
33-
<br>
32+
- **Code Review:**
3433

35-
![agentgif](./assets/images/readme/agent_en.gif)
34+
Code Review enables indexing and parsing of entire code repositories, implementing company-wide RAG (Retrieval-Augmented Generation) for coding knowledge.
35+
It adopts the strategy of "specialized checks by a multi-expert model" + "cross-confirmation by multiple models."
36+
It supports users in conducting code checks on functions, selected code lines, code files, and entire project files.
3637

37-
![aiagent](./assets/images/readme/ai-agent_en.png)
38-
39-
- **Code Completion**: Code Completion automatically generates subsequent code based on the context around your cursor, delivering results in sub-second response times. It supports comment-based completion, variable completion, function completion, and more – all instantly accepted with a single Tab key press.
38+
<br>
4039

41-
- **More features**: - **MCP Service**: Seamlessly integrates with the MCP open ecosystem to enable standardized system connectivity. You can Integrate external APIs、Connect to databases、Develop custom tools through MCP services. - **APIs & Model Customization**:Officially provided are multiple free advanced models like claude-sonnet-4; it also supports using third-party API providers such as Anthropic, OpenAI, etc.; you can also configure any API compatible with OpenAl; or use local models through I M Studio/Ollama - **Mode Customization**: We provide various default modes to adapt to different scenarios, such as the Code mode with outstanding coding capabilities and the Orchestrator mode skilled in complex task decomposition. You can also customize mode according to your needs. - **Context**: CoStrict will automatically incorporate all repository data of large files into the context, and for code completion scenarios, it will also dynamically perceive the context based on the cursor position. You can also add files/folders, terminals, issues, etc. using the @ key to provide more precise context information for the input. - **Image**:You can click the image icon below the dialog box to upload an image, or you can hold down the Shift key to drag and drop the image into the input box. - **Quick Menu**: Select code, right-click to open the function menu, supported features include: Explain Code, Fix Code, Improve Code, Add Comments, Code Review, Add Logging, Enhance Robustness, Simplify Code, Optimize Performance, etc., which can meet all your code scenarios.
40+
<a href="https://docs.costrict.ai/en/tutorial-videos/video/#ai-codereview" target="_blank"><img src="./assets/images/readme/codereview_buffer.png" alt="Docs Center"></a>
4241

43-
<br>
42+
![morefeature](./assets/images/readme/codereview_en.png)
4443

45-
![completiongif](./assets/images/readme/completion.gif)
44+
- **More features:**
4645

47-
![morefeature](./assets/images/readme/more-feature_en.png)
46+
- **Code Completion:** Automatically generates subsequent code based on the cursor's context code, quickly outputs code in seconds
47+
- **Vibe Code:** Vibe Code is designed for rapid development and simple tasks. It supports multi-turn natural language dialogue, allowing for real-time refinement and precise code generation.
48+
- **MCP Service:** Seamlessly integrates with the MCP open ecosystem to enable standardized system connectivity. You can Integrate external APIs、Connect to databases、Develop custom tools through MCP services.
49+
- **APIs & Model Customization:** Officially provided are multiple free advanced models like claude-sonnet-4; it also supports using third-party API providers such as Anthropic, OpenAI, etc.; you can also configure any API compatible with OpenAl; or use local models through I M Studio/Ollama
50+
- **Mode Customization:** We provide various default modes to adapt to different scenarios, such as the Code mode with outstanding coding capabilities and the Orchestrator mode skilled in complex task decomposition. You can also customize mode according to your needs.
51+
- **Context:** Shenma will automatically incorporate all repository data of large files into the context, and for code completion scenarios, it will also dynamically perceive the context based on the cursor position. You can also add files/folders, terminals, issues, etc. using the @ key to provide more precise context information for the input.
52+
- **Image:** You can click the image icon below the dialog box to upload an image, or you can hold down the Shift key to drag and drop the image into the input box.
53+
- **Multi-language Support:** Supports mainstream programming languages: Python, Go, Java, JavaScript, TypeScript, C/C++ and all other programming languages
54+
- **Privacy & Security:** To ensure data security and provide better service at a lower cost, we offer a professional and comprehensive private deployment solution, ensuring code security through physical isolation and end-to-end encryption.
4855

49-
## Quick Start
56+
![morefeature](./assets/images/readme/more-feature_en.png)
5057

51-
### Deployment
58+
<br>
5259

53-
Refer to [Deployment Guide](/assets/docs/devel/en-US/deployment.md)
60+
## For more assistance
5461

55-
### Build
62+
Refer to [Deployment Guide](https://docs.costrict.ai/en/guide/installation)
5663

57-
Refer to Development Documentation
64+
Guidelines for private deployment: https://docs.costrict.ai/en/deployment/introduction
5865

5966
## Contributing
6067

README.zh-CN.md

Lines changed: 28 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -9,70 +9,63 @@
99
<br>
1010
<br>
1111

12+
CoStrict 是一款免费开源的AI辅助编程工具,支持企业私有化部署,是企业严肃编程的最佳选择。核心场景能力突出:企业级严肃编程(Strict Mode)、代码审查(Code Review)、代码补全(Code Completion)等,特性功能亮点十足:企业级业务理解、系统规范的AI开发流程、氛围编程模式、MCP服务、多种高级免费模型、API/模型自定义、模式选择/自定义等。支持多种主流IDE工具,已支持VS Code和JetBrains IDEs。支持Python、Go、 Java、JavaScript/TypeScript、C/C++等多种主流语言。
13+
1214
<div align="center">
1315

1416
<a href="https://marketplace.visualstudio.com/items?itemName=zgsm-ai.zgsm" target="_blank"><img src="./assets/images/readme/download on vscode marketplace.png" alt="Download on VS Marketplace"></a>
1517
<img src="./assets/images/readme/rate review.png" alt="Rate Review">
18+
<a href="https://docs.costrict.ai/guide/installation/" target="_blank"><img src="./assets/images/readme/docs_center_zh.png" alt="Docs Center"></a>
1619

1720
</div>
1821

19-
CoStrict是一款免费开源的AI辅助编程工具,支持企业私有化部署,是企业严肃编程的最佳选择。核心场景能力突出:代码审查(Code Review)、智能体( AI Agent)、代码补全(Code Completion)等,特性功能亮点十足:企业级代码仓库索引、MCP服务、多种高级免费模型、API/模型自定义、模式选择/自定义、图片上下文等。支持多种主流IDE工具,率先支持VS Code。支持Python、Go、 Java、JavaScript/TypeScript、C/C++等多种主流语言。
20-
2122
## 产品特性 Features
2223

23-
- **代码审查(Code Review)**:代码审查能够进行全量代码仓库的索引解析,公司级编码知识库RAG(增强检索) 在发现问题和确认问题上采用“多专家模型专项检查”+“多模型交叉确认”策略 支持用户对函数、选中代码行、代码文件和整个工程文件进行代码检查
24+
- **严肃编程(Strcit Mode):**
25+
严肃编程规范了AI生成代码的流程,使其更符合企业开发场景。它将一句话的需求,系统性地拆解为需求设计、架构设计、测试设计、代码设计等步骤,如同为AI设定了标准工序,确保输出结果高质量、高可控。
2426

2527
<br>
2628

27-
![reviewgif](./assets/images/readme/codereview.gif)
28-
29-
![codereview](./assets/images/readme/codereview.png)
30-
31-
- **智能体(AI Agent):**: 智能体能够根据开发者的需求端到端完成任务,具备:自主决策、全仓库上下文检索、调用工具、错误修复、运行终端等能力。在效果一致的情况下,Token消耗成本相较其它开源软件,能节省 50%以上
32-
33-
<br>
29+
<a href="https://docs.costrict.ai/tutorial-videos/video#%E4%B8%A5%E8%82%83%E7%BC%96%E7%A8%8B" target="_blank"><img src="./assets/images/readme/strict_mode_zh_buffer.png" alt="Docs Center"></a>
3430

35-
![agentgif](./assets/images/readme/agent.gif)
31+
![Strcit Mode](./assets/images/readme/strict_zh.png)
3632

37-
![aiagent](./assets/images/readme/ai-agent.png)
33+
- **代码补全(Code Completion):**
34+
代码审查能够进行全量代码仓库的索引解析,公司级编码知识库RAG(增强检索) 在发现问题和确认问题上采用“多专家模型专项检查”+“多模型交叉确认”策略 支持用户对函数、选中代码行、代码文件和整个工程文件进行代码检查
3835

39-
- **代码补全(Code Completion)**:代码自动补全,根据光标的上下文代码,自动生成后续代码,快速秒级出码 支持注释描述的补全,变量补全,函数补全等,Tab 一键采纳
36+
<a href="https://docs.costrict.ai/tutorial-videos/video#%E4%BB%A3%E7%A0%81%E5%AE%A1%E6%9F%A5" target="_blank"><img src="./assets/images/readme/codereview_buffer.png" alt="Docs Center"></a>
4037

41-
![completiongif](./assets/images/readme/completion.gif)
38+
![morefeature](./assets/images/readme/codereview.png)
4239

4340
<br>
4441

45-
![morefeature](./assets/images/readme/more-feature.png)
42+
- **更多特性(More Features):**
43+
- **代码补全:** 代码自动补全,Costrcit能根据光标所在位置的上下文代码,自动生成后续代码,快速秒级出码
44+
- **氛围编程:** 氛围编程专为快速开发与简单任务场景设计,它支持多轮自然语言对话,边说边改,精准生成代码
45+
- **MCP服务:** 无缝对接MCP开放生态,实现标准化系统连接。您可以通过MCP服务集成外部 API、连接数据库或开发定制工具等
46+
- **第三方API和模型自定义:** 官方提供了各种免费的高级模型,像claude-sonnet-4;也支持使用第三方API提供商如Anthropic、OpenAl等;您还可以配置任何与OpenAl兼容的API;或者通过I M Studio/Ollama使用本地模型
47+
- **模式自定义:** 我们提供了多种默认模式以适应不同场景,例如:代码能力突出的Code模式、擅长复杂任务拆解的Orchestrator模式。您也可以根据需求自定义模式
48+
- **大仓库上下文:** Costrict 会自动将大文件全仓库数据纳入上下文,对于代码补全场景也会根据光标位置动态感知上下文。 你也可以通过@键添加文件/文件夹、终端、问题等等给输入更精准的上下文信息
49+
- **支持图片:** 多模态模型支持上传图片,您可以点击对话框下方的图片icon上传图片,也可以按住shift键将图片拖拽到输入框内
50+
- **快捷菜单:** 选中代码,点击右键出现功能菜单,支持:解释代码、修复代码、改进代码、添加注释、代码审查、添加日志、增加容错、简化代码、优化性能等功能,能满足你所有的代码场景
51+
- **多语言支持:** 支持主流编程语言:Python, Go, Java, JavaScript, TypeScript, C/C++ 等所有编程语言
52+
- **隐私 & 安全:** 为确保数据安全和更好的服务更低的成本,我们提供了专业完整的私有化部署方案,通过物理隔离和端到端加密,确保代码的安全。
4653

47-
- **更多特性(More Features)**
48-
- **MCP 服务**:无缝对接MCP开放生态,实现标准化系统连接。您可以通过MCP服务集成外部 API、连接数据库或开发定制工具等
49-
- **第三方API和模型自定义**: 官方提供了各种免费的高级模型,像claude-sonnet-4;也支持使用第三方API提供商如Anthropic、OpenAl等;您还可以配置任何与OpenAl兼容的API;或者通过I M Studio/Ollama使用本地模型
50-
- **模式自定义**:我们提供了多种默认模式以适应不同场景,例如:代码能力突出的Code模式、擅长复杂任务拆解的Orchestrator模式。您也可以根据需求自定义模式
51-
- **大仓库上下文**:CoStrict会自动将大文件全仓库数据纳入上下文,对于代码补全场景也会根据光标位置动态感知上下文。 你也可以通过@键添加文件/文件夹、终端、问题等等给输入更精准的上下文信息
52-
- **支持图片**:多模态模型支持上传图片,您可以点击对话框下方的图片icon上传图片,也可以按住shift键将图片拖拽到输入框内
53-
- **快捷菜单**: 选中代码,点击右键出现功能菜单,支持:解释代码、修复代码、改进代码、添加注释、代码审查 、添加日志、增加容错、简化代码、优化性能等功能,能满足你所有的代码场景
54+
![morefeature](./assets/images/readme/more-feature.png)
5455

5556
## 更多帮助 For more assistance
5657

57-
更多操作详情可访问Costrict官方文档: https://costrict.ai/download
58-
59-
## 快速开始
60-
61-
### 部署
62-
63-
请参考 [部署指南](/assets/docs/devel/zh-CN/deployment.md)
64-
65-
### 构建
58+
更多操作详情可访问 CoStrict 官方文档:https://docs.costrict.ai/guide/installation
6659

67-
请参考 开发文档
60+
私有化部署指引文档:https://docs.costrict.ai/deployment/introduction
6861

6962
## 如何贡献
7063

71-
CoStrict是由友好的用户、贡献者、提交者和项目管理委员会成员共同开发和维护的开源项目。
64+
CoStrict 是由友好的用户、贡献者、提交者和项目管理委员会成员共同开发和维护的开源项目。
7265

7366
欢迎所有人以多种方式加入并为项目做出贡献,不仅限于代码贡献。诸如上报问题、报告漏洞、提议新功能、改进文档、完善网站、组织活动或撰写博客文章等贡献均受到欢迎和认可。
7467

75-
本文档是CoStrict社区新成员入门贡献项目的指南
68+
本文档是 CoStrict 社区新成员入门贡献项目的指南
7669

7770
### 上报问题
7871

@@ -82,7 +75,7 @@ CoStrict是由友好的用户、贡献者、提交者和项目管理委员会成
8275

8376
### 提交代码
8477

85-
Costrict项目采用 Github Forking 工作流:[Costrict项目代码贡献流程](https://github.com/zgsm-ai/costrict/blob/main/assets/docs/devel/zh-CN/fork.md)
78+
CoStrict项目采用 Github Forking 工作流:[CoStrict项目代码贡献流程](https://github.com/zgsm-ai/costrict/blob/main/assets/docs/devel/zh-CN/fork.md)
8679

8780
## 版权声明
8881

assets/images/readme/agent.gif

-15.7 MB
Binary file not shown.

assets/images/readme/agent_en.gif

-15 MB
Binary file not shown.

assets/images/readme/ai-agent.png

-87.1 KB
Binary file not shown.
-85.9 KB
Binary file not shown.
-4.02 MB
Binary file not shown.
2.56 MB
Loading
-5.86 MB
Binary file not shown.
-2.23 MB
Binary file not shown.

0 commit comments

Comments
 (0)