pony-agent-cli

Pony Agent

Pony Agent CLI：一个在您的终端中运行的、由 AI 驱动的开发工作流助手。

Pony Agent 是一个命令行界面 (CLI) 工具，旨在通过将强大的 AI 助手直接集成到您的终端中来简化软件开发。它能够理解您的项目上下文，与您的代码库进行交互，执行命令，并帮助您以前所未有的速度进行构建、重构和调试。

✨ 功能特性

• AI 驱动的开发: 直接在终端中与 AI 助手进行对话，完成编码、重构、调试等多种开发任务。
• 文件系统操作：通过自然语言指令创建、读取、更新和删除文件及目录。
• 命令执行：在您的项目内部运行 Shell 命令，允许 AI 构建、测试和验证其自身的变更。
• 持久化会话：自动保存您的对话历史，让您可以随时从上次中断的地方继续。
• 统一配置：通过简单的 CLI 命令，轻松管理所有设置。

🚀 安装

使用您喜欢的包管理器全局安装 Pony Agent CLI：

npm install -g pony-agent

💻 使用方法

启动 AI 助手进行交互式会话：

# <entryFile> 是你项目的主要入口文件，例如 src/main.ts
pony simple <entryFile>

📚 命令列表

以下是所有可用的命令：

• pony simple <entryFile>: 启动一个用于编码、设计和调试等任务的交互式 AI 会话。<entryFile> 是项目的代码入口文件，用于构建上下文知识库。
• pony config list: 显示所有当前的配置项。
• pony config get <key>: 获取一个配置项的值 (例如, pony config get simple.model)。
• pony config set <key> <value>: 设置一个配置项的值 (例如, pony config set simple.apiKey \"your-api-key\")。
• pony config rm <key>: 移除一个配置项 (例如, pony config rm simple.apiKey)。

所有配置均通过 conf 进行管理，存储在您操作系统的标准配置目录下。

⚙️ 配置 (Configuration)

以下是所有可配置字段的详细说明。

核心配置 (simple)

这是运行 pony simple 命令所需的基本模型配置。

字段 (key)	类型	是否必须	默认值	描述
apiKey	string	是	-	您的大语言模型提供商的 API 密钥。
model	string	否	gemini-2.5-pro	要使用的模型名称，例如 gpt-4o。
baseURL	string	否	https://generativelanguage.googleapis.com/v1beta/openai/	如果您使用自定义或代理的 OpenAI API 端点，请在此处指定。

设置示例:

# 设置 API Key
pony config set simple.apiKey \"sk-...\"

# 设置模型
pony config set simple.model \"gpt-4o\"

# 设置自定义 API 入口 (如果需要)
pony config set simple.baseURL \"https://your-proxy-url/v1\"

知识库配置 (codex)

这是可选配置，用于启用代码知识库的语义搜索功能。

字段 (key)	类型	是否必须	默认值	描述
model	string	否	Xenova/all-MiniLM-L6-v2	用于生成代码嵌入的 Hugging Face 模型。
dbDirectory	string	否	.codex	用于存储本地向量数据库文件的目录。
tsConfig	string	否	tsconfig.json	项目的 tsconfig.json 文件路径，用于代码分析。
entryFile	string	否	src/main.ts	代码分析的入口文件。

设置示例:

# 开启 Codex 功能需要一次性设置所有相关字段
pony config set codex.model \"Xenova/all-MiniLM-L6-v2\"
pony config set codex.dbDirectory \".codex\"
pony config set codex.tsConfig \"tsconfig.json\"
pony config set codex.entryFile \"src/main.ts\"

LangSmith 追踪配置 (langSmith)

这是可选配置，用于将模型的运行过程记录到 LangSmith 以便进行调试和监控。

字段 (key)	类型	是否必须	默认值	描述
apiKey	string	否	-	您的 LangSmith API 密钥。如果提供，将自动启用追踪。
projectName	string	否	-	在 LangSmith 中显示的项目名称。

设置示例:

pony config set langSmith.apiKey \"ls__...\"
pony config set langSmith.projectName \"pony-agent-dev\"

其他配置

字段 (key)	类型	是否必须	默认值	描述
httpsProxy	string	否	http://127.0.0.1:7890	如果您需要通过 HTTP 代理发出请求，请设置此项。
proxiedDomains	string	否	googleapis.com,huggingface.co	需要通过代理的域名列表，以逗号分隔。

📄 许可证

本项目基于 MIT 许可证发布。