码农GPT

码农GPT是一个多功能的命令行界面（CLI），旨在增强编码工作流程。它利用大型语言模型（LLM）和生成式预训练变换器（GPT）的功能，帮助开发者完成各种任务，如注释、优化、文档编写和测试代码。此工具与langchain无缝集成，为代码生成和修改提供强大的后端。

已实现的模型提供者

• OpenAI [gpt-3.5-turbo, gpt-4, gpt-4-turbo-preview(默认)]
• Google [gemini-pro]
• Anthropic [claude-2]

先决条件

在开始使用码农GPT之前，您必须在您的机器上设置OPENAI_API_KEY、GOOGLE_API_KEY和ANTHROPIC_API_KEY环境变量。此密钥使您能够与OpenAI和Google API进行身份验证，这对于语言模型的运行至关重要。

export OPENAI_API_KEY='your-api-key-here'
export GOOGLE_API_KEY='your-api-key-here'
export ANTHROPIC_API_KEY='your-api-key-here''

请确保将your-api-key-here替换为您的实际OpenAI API密钥，以启用码农GPT的完整功能。

入门

安装

使用pip轻松安装码农GPT

pip install codergpt

基本用法

使用以下语法调用码农GPT CLI

codergpt [OPTIONS] COMMAND [ARGS]...

选项

• -v, --verbose INTEGER：调整详细程度（0为默认，1为详细，2为调试）。
• -q, --quiet：抑制输出。
• --version：显示版本号并退出。
• --model：用于执行请求的模型。
  • 可用模型
    • OpenAI：[gpt-3.5-turbo, gpt-4, gpt-4-turbo-preview(默认)]
    • Google：[gemini-pro]
    • Anthropic[claude-2]

命令

检查

分析包并显示其文件语言映射。

codergpt --model <model-name> inspect <path>

示例

$ codergpt --model gpt-4 inspect src/codergpt/

解释

为包中的特定函数或类提供解释。

codergpt explain <path> [--function <function_name>] [--classname <class_name>]

示例

$ codergpt explain src/codergpt/explainer/explainer.py --function explain

注释

自动为您的代码添加注释。选择是否覆盖现有文件或创建新文件。

codergpt comment <path> [--overwrite/--no-overwrite]

示例

$ codergpt comment greetings.py --overwrite

优化

通过优化代码并添加注释来提升您的代码。您可以决定覆盖原始文件或单独保存更改。

codergpt optimize <path> [--overwrite/--no-overwrite]

示例

$ codergpt optimize example.py --overwrite

编写测试

为指定的代码文件生成测试用例，针对特定函数和/或类。

codergpt write-tests <filename> [--function <function_name>] [--class <classname>] [--outfile <output_filename>]

示例

$ codergpt write-tests example.py --function add --class Calculator

文档

通过处理和解释代码来为给定的代码文件创建文档。

codergpt document <path> [--outfile <output_filename>]

示例

$ codergpt document example.py

开发 & 贡献

CoderGPT CLI是用Python开发的，使用了click库来创建命令。以下是添加新命令的模板

import click
from codergpt import CoderGPT

coder = CoderGPT()

@click.command()
@click.argument('path', type=click.Path(exists=True))
def new_command(path):
    # Implement command logic here
    pass

鼓励对CoderGPT做出贡献！请在提出拉取请求之前查看我们的贡献指南。

许可

CoderGPT在MIT许可证下开源。更多详细信息，请参阅LICENSE.md文件。

致谢

本项目使用cookiecutter框架构建，基于monarch-project-template。更新通过cruft管理。

有关CoderGPT CLI的全面详细信息，请参阅官方文档。