Groq Code CLI：一个由Groq驱动的可定制命令行编程工具

Groq Code CLI 是一个轻量级、开源的命令行编程工具，它利用Groq的API提供快速的AI代码生成和交互能力。这个项目的核心理念不是要成为一个功能繁杂、难以维护的庞大应用，而是作为一个基础蓝图，让开发者可以轻松地在此之上进行修改、扩展和定制，创造出完全属于自己的命令行工具。开发者可以很方便地添加新的命令、集成外部工具，甚至修改界面的视觉元素。它通过简化代码库和降低复杂性，鼓励开发者深入其中，根据自己的工作流进行定制开发，例如，用户可以自行添加代码复杂度分析、自动化测试、知识图谱构建等高级功能。

功能列表

• 快速交互: 由Groq提供技术支持，能够实现快速的代码生成和响应。
• 命令行聊天: 在终端中通过groq命令启动一个与AI的交互式聊天会话。
• 高度可定制: 允许开发者轻松添加新的斜杠命令（slash commands）和工具，提供了详细的定制指南。
• API密钥管理: 支持通过/login命令或设置环境变量GROQ_API_KEY来管理和验证用户身份。
• 模型选择: 用户可以使用/model命令查看并选择在Groq平台上可用的不同语言模型。
• 会话管理: 提供/clear命令，可以随时清除当前的聊天历史和上下文。
• 参数调整: 支持通过命令行选项调整AI模型的行为，例如使用-t或--temperature来设定生成内容的多样性。
• 系统消息定制: 用户可以通过-s或--system选项在启动时向AI提供自定义的系统级指令。

使用帮助

Groq Code CLI 是一个为开发者设计的命令行工具，旨在提供一个高度可定制和快速迭代的AI编程环境。以下是详细的安装和使用说明，帮助你快速上手。

安装

你可以根据不同的需求选择两种安装方式：

1. 快速试用 (npx)

如果你只是想快速体验一下这个工具，而不想在本地克隆整个代码库，可以使用npx命令。这个命令会从npm仓库拉取最新的稳定版本并直接运行，无需在你的电脑上安装任何文件。

打开你的终端，输入以下命令：

npx groq-code-cli@latest

执行后，Groq Code CLI就会启动，你可以直接开始使用。

2. 本地开发和定制 (推荐)

如果你希望对这个工具进行修改、添加新功能，或者长期使用，推荐采用本地开发安装模式。这种方式会将项目的源代码完整地克隆到你的电脑上，并允许你对代码进行任何修改。

第一步：克隆代码库
首先，使用git将项目源代码从GitHub克隆到本地。

git clone https://github.com/build-with-groq/groq-code-cli.git

第二步：进入项目目录
使用cd命令进入刚刚克隆下来的文件夹。

cd groq-code-cli

第三步：安装项目依赖
该项目使用Node.js，你需要使用npm install命令来安装所有必需的依赖包。

npm install

第四步：编译项目
由于项目使用TypeScript编写，你需要将其编译成JavaScript才能运行。

npm run build

第五步：链接到全局命令
为了能在电脑的任何路径下都能通过groq命令来调用这个工具，你需要使用npm link命令。

npm link

执行此命令后，groq命令就会成为一个全局可用的命令。

第六步 (可选): 开启自动编译
如果你计划对源代码进行修改，可以运行开发模式命令。此命令会监控文件变化，并在你保存文件后自动重新编译，让你无需手动执行npm run build。

npm run dev

建议将此命令在一个独立的终端窗口中保持运行。

首次使用：配置API密钥

无论使用哪种方式安装，首次运行时都需要配置你的Groq API密钥。

1. 在终端中启动工具：

   groq
   

2. 在启动的聊天界面中，输入/login命令并按回车。
3. 程序会提示你输入API密钥。你可以从 Groq Console 获取你的免费API密钥。
4. 输入密钥后，程序会在你的用户主目录下创建一个名为.groq的隐藏文件夹，用于保存密钥和其它配置信息。

你也可以通过设置环境变量的方式来临时提供API密钥，这在持续集成(CI)环境或测试时非常有用。

export GROQ_API_KEY=your_api_key_here

主要功能操作

1. 启动聊天会话

在任何目录下，只需在终端输入groq即可开始与AI对话。

你可以直接提问，或者让它帮你写代码、解释概念等。

2. 使用斜杠命令 (Slash Commands)

在聊天界面中，你可以通过输入以/开头的命令来执行特定操作。

• /help: 显示所有可用的命令及其说明。
• /login: 用于登录和设置API密钥。
• /model: 列出当前可用的AI模型，并允许你切换模型。
• /clear: 清除当前窗口的聊天记录，开始一个全新的对话。
• /reasoning: 切换是否在AI的回答中显示其思考过程。

3. 使用命令行选项

你可以在启动groq命令时添加一些选项来控制AI的行为。

• -t, --temperature <temp>: 设置生成内容的“温度”，这是一个0到2之间的数字。较高的值（如1.2）会使输出更具创造性和随机性，而较低的值（如0.5）则会使输出更具确定性和一致性。默认值为1。

  groq -t 0.7
  

• -s, --system <message>: 设置一条系统消息。这条消息会作为最高指示，指导AI在整个会话中的行为。例如，你可以让它扮演一个特定的角色。

  groq -s "你是一个资深的Go语言程序员，请只用Go语言回答问题。"
  

• -d, --debug: 启用调试模式，会将详细的日志信息输出到当前目录下的debug-agent.log文件中。
• -h, --help: 显示帮助信息，列出所有可用的命令行选项。
• -V, --version: 显示当前安装的groq-code-cli的版本号。

应用场景

1. 日常编码辅助
   开发者在编写代码时，可以随时打开终端，向Groq Code CLI提问，例如“如何用Python实现一个快速排序算法？”或“帮我写一个连接Redis数据库的Node.js代码片段”。由于其快速响应的特性，可以显著减少在搜索引擎和文档中查找信息的时间。
2. 代码调试与解释
   当遇到一段不理解的代码或者一个难以排查的错误时，可以直接将代码或错误信息粘贴到CLI中，让AI解释代码的逻辑或提供可能的错误原因和修复建议。
3. 学习新技术
   初学者或希望扩展技术栈的开发者，可以利用它作为一个交互式的学习工具。可以提问关于新框架、新语言的基础概念和核心用法，AI会提供结构化的解释和代码示例。
4. 自动化脚本编写
   对于需要编写一些简单脚本（如Shell、Python）来自动化日常任务的运维人员或开发者，可以直接用自然语言描述需求，例如“写一个脚本，删除当前目录下所有超过30天的.log文件”，AI可以快速生成可用的脚本。
5. 构建个性化开发工具
   高级用户和开发者团队可以基于Groq Code CLI进行二次开发，将团队内部的知识库、API文档、代码规范等信息集成进去，或者添加与内部系统（如CI/CD、项目管理工具）交互的功能，打造一个符合团队特定工作流的专属CLI工具。

QA

1. 这个工具是免费的吗？
   Groq Code CLI本身是开源免费的，你可以在GitHub上获取其全部源代码。但是，它依赖Groq云平台提供的AI模型服务，你需要从Groq官方网站获取API密钥。通常Groq会为新用户提供一定的免费使用额度，超出部分需要付费。
2. 我需要懂编程才能用吗？
   基本使用不需要编程知识，你可以像使用聊天工具一样与它对话，获取信息和代码。但它的核心价值在于其可定制性，如果你想修改或扩展它的功能，那么就需要具备一定的Node.js和TypeScript编程知识。
3. 它和其他AI编程工具有什么不同？
   最大的不同在于它的设计理念。许多AI编程工具追求功能大而全，但代码复杂，难以修改。Groq Code CLI反其道而行之，它故意保持轻量和简单，将自己定位为一个“蓝图”或“框架”，鼓励用户自己动手进行定制和扩展，核心优势是高可定制性和低延迟。
4. 如何添加一个新的命令，比如/test？
   你需要在src/commands/definitions/目录下创建一个test.ts文件，在其中定义命令的行为，然后在src/commands/index.ts文件中注册这个新命令。详细的开发文档在项目的README文件中有提供，指引非常清晰。