项目介绍
auto-copilot-cli
是一个功能多样的工具,专为开发人员设计,提供了一系列能够提升代码质量和开发效率的功能。它集成了人工智能的强大功能,旨在帮助程序员快速查找和改进代码库,并就代码问题提供答案。
功能简介
- AI 聊天功能:可以与代码库进行交互,帮助快速查找和改进代码。
- 代码审查:提供自动化的代码审查服务。
- 生成提交信息:在代码提交前自动生成提交信息。
- 代码重构与格式化:支持对文件或文件夹的代码进行重构及格式化。
- 测试代码生成:自动生成测试代码,提升测试效率。
- Shell 命令生成与执行:帮助生成并执行 shell 命令。
- 自然语言转 SQL:将自然语言翻译成 SQL 查询。
设置步骤
- 全局安装
auto-copilot-cli
:# 使用 npm npm install -g auto-copilot-cli # 使用安装脚本 curl -s https://raw.githubusercontent.com/rsaryev/auto-copilot-cli/main/deployment/deploy.bash | bash
- 从 OpenAI 获取 API 密钥。
- 参考 CLI 使用指南以学习如何使用该工具。
常用命令
code-chat <path>
:与代码库进行 AI 对话code-review
:执行代码审查test <file>
:生成测试代码- 可选项:
-o, --output <file>
:输出文件
- 可选项:
refactor <file>
:重构代码- 可选项:
-o, --output <file>
:输出文件
- 可选项:
sql-translator <query>
:将自然语言翻译成 SQL 查询chat <chat>
:与 AI 进行对话shell <goal>
:生成并执行 shell 命令pre-commit
:分析 git 差异并生成提交信息config <key> <value>
:设置配置信息get-config
:打印当前配置信息
基本选项
-h, --help
:显示命令的帮助信息-V, --version
:输出版本号
参与贡献
auto-copilot-cli
欢迎来自各方的贡献。通过社区的协作,不断完善和增强工具的功能,为更多开发人员服务。