Groq Code CLI Enhanced

Groq Code CLI: Enhanced Edition with MCP Integration & Developer Tools

Overview • Installation • Usage • MCP Integration • Development

https://github.com/user-attachments/assets/bc02466c-fef6-4f30-bb1e-df9ca851a88e

目录

• 概述
• 最新动态
• 安装
• 用法

- 认证 - 可用命令 - 开发者工具

• MCP集成

- Brave Search MCP服务器 - 设置MCP服务器 - 可用的MCP服务器

• 发展
• 更新日志
• 鸣谢

概述

编码CLIs无处不在。Groq Code CLI是不同的。它是一个蓝图，一个构建块，供希望利用、定制和扩展CLI以完全属于自己的开发人员使用。领先的开源CLIs都很棒，对开源社区来说是鼓舞人心的，而且功能非常丰富。然而，这只是：他们是 *巨大的*.功能丰富：是的，但具有如此庞大和交织的代码库的本地开发是不友好和压倒性的。 这是一个供希望深入了解的开发人员参与的项目。

Groq Code CLI是您真正拥有CLI的机会。配备了您当前最喜欢的CLI所熟悉的所有功能、工具、命令和UI/UX，我们可以轻松添加您一直想要的新功能。通过在不影响质量的情况下大幅减少臃肿和代码量，您可以根据需要修改此CLI。通过利用Groq上的模型，您可以更快地迭代。只需键入以下命令即可激活CLI groq 在你的终端。

最新动态

这个增强的fork在原始Groq Code CLI的基础上添加了强大的功能：

🔌 MCP（模型上下文协议）集成（v1.2.0）

• 交互式服务器管理：类型 /mcp 用于使用箭头键进行交互式服务器选择
• API密钥自动管理：安全的API密钥输入，自动保存到配置
• 动态路径支持：使用 {{cwd}} 当前工作目录的占位符
• 自定义Brave搜索服务器：内置网络/新闻/本地搜索（官方包不存在！）
• 连接到外部服务器：文件系统、GitHub、谷歌地图、Postgres、Slack等
• MCP工具: mcp_connect, mcp_call_tool, mcp_read_resource, mcp_list
• 自动发现：自动发现工具、资源和提示

🛠️ 增强的开发人员工具（v1.1.0）

• Git操作：状态、差异、日志、添加、提交、分支管理
• TODO提取：查找所有TODO/FIXME/HACK/NOTE/BUG/XXX评论
• 相关性分析：检查包版本和过时的依赖关系
• 新命令: /context, /todos, /init, /mcp

🎨 更新的品牌和UI（v1.2.0）

• 紫绿松石主题：美丽的渐变（#9D4EDD→ #00F5FF)
• 增强横幅：ASCII艺术中的平滑颜色过渡
• 更新徽章：颜色协调的文档

安装

发展（推荐）

# Clone this enhanced version
git clone https://github.com/mcrao/groq-code-cli-enhanced.git
cd groq-code-cli-enhanced

# Install dependencies
npm install

# Build the project
npm run build

# Link globally (enables `groq` command)
npm link

备注：替换 mcrao/groq-code-cli-enhanced 使用您的实际存储库URL。

# Run in background during development for auto-rebuild
npm run dev

原始版本

要使用原始的Groq Code CLI（无增强功能）：

# Using npx, no installation required
npx groq-code-cli@latest

# Or install globally
npm install -g groq-code-cli@latest

用法

# Start chat session
groq

命令行选项

groq [options]

Options:
  -t, --temperature       Temperature for generation (default: 1)
  -s, --system         Custom system message
  -d, --debug                   Enable debug logging
  -p, --proxy              Proxy URL (http/https/socks5)
  -h, --help                    Display help
  -V, --version                 Display version

认证

首次使用时，键入 /login 并输入您的API密钥：

Login

从获取API密钥 Groq控制台 这里

这创建了一个 ~/.groq/ 存储API密钥和配置的文件夹。

环境变量备选方案：

export GROQ_API_KEY=your_api_key_here

代理配置

支持HTTP/HTTPS/SOCKS5代理：

# CLI flag (highest priority)
groq --proxy http://proxy:8080
groq --proxy socks5://proxy:1080

# Environment variables
export HTTP_PROXY=http://proxy:8080
export HTTPS_PROXY=socks5://proxy:1080

优先： --proxy > HTTPS_PROXY > HTTP_PROXY

可用命令

开发者工具

Git操作 (git_operations)

• 检查状态、查看差异、提交历史记录
• 暂存文件并创建提交
• 列出并切换分支

TODO提取 (extract_todos)

• 查找TODO、FIXME、HACK、NOTE、BUG、XXX评论
• 按文件分组或按类型筛选
• 追踪技术债务

相关性分析 (analyze_dependencies)

• 查看所有依赖项和版本
• 检查过时的软件包
• 使用package.json

MCP集成 (mcp_connect, mcp_call_tool, mcp_read_resource, mcp_list)

• 连接到外部MCP服务器
• 访问文件系统、GitHub、谷歌地图、Slack工具
• 扩展AI功能

MCP集成

MCP（模型上下文协议）将AI连接到外部工具和数据源。

快速开始

# Check MCP status and open interactive selector
groq
> /mcp

# The interactive UI will:
# 1. Show all available servers
# 2. Let you select with arrow keys
# 3. Prompt for API key if needed
# 4. Save config automatically
# 5. Connect to the server

Brave Search MCP服务器

🆕 包括定制实施！

自从官方 @modelcontextprotocol/server-brave-search 包不存在，我们构建了一个完整的自定义MCP服务器。

一次性设置：

# 1. Build the Brave Search MCP server
cd mcp-servers/brave-search
npm install
npm run build
cd ../..

# 2. Get your Brave API key
# Visit: https://brave.com/search/api/

# 3. Connect via Groq CLI
npm start
> /mcp
> Select: brave-search (arrow keys + Enter)
> Paste your Brave API key
> Press Enter

可用工具：

• brave_web_search -一般网络搜索
• brave_news_search -带有时间戳的新闻文章
• brave_local_search -当地企业和场所

示例用法：

> Search for latest AI developments
> Find news about quantum computing
> Search for coffee shops in San Francisco

故障排除：

• 构建失败？ 跑 cd mcp-servers/brave-search && npm install && npm run build
• 连接失败？ 检查 ls mcp-servers/brave-search/dist/index.js 存在
• API关键问题？ 从获取新密钥https://brave.com/search/api/

设置MCP服务器

交互式设置（推荐）：

1. 类型 /mcp 打开服务器选择器
2. 使用箭头键（↑↓）进行导航
3. 按Enter键选择服务器
4. 如果提示，请输入API键（Ctrl+H显示/隐藏）
5. 服务器自动连接

手动配置：

编辑 ~/.groq/mcp-config.json:

{
  "servers": {
    "filesystem": {
      "name": "filesystem",
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-filesystem", "{{cwd}}"],
      "enabled": true
    },
    "github": {
      "name": "github",
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-github"],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "your_token_here"
      },
      "enabled": false
    },
    "brave-search": {
      "name": "brave-search",
      "command": "node",
      "args": ["{{project_root}}/mcp-servers/brave-search/dist/index.js"],
      "env": {
        "BRAVE_API_KEY": "your_key_here"
      },
      "enabled": false
    }
  }
}

动态路径：

• {{cwd}} -已替换为当前工作目录
• 使配置可跨机器移植

可用的MCP服务器

更多服务器： 模型上下文协议/服务器

用法示例

文件系统操作：

> Read the package.json file
> Create a new file called notes.txt
> List all TypeScript files

GitHub集成：

> List my GitHub repositories
> Create an issue in my repo
> Show recent commits

Brave搜索（自定义服务器）：

> Search for TypeScript best practices
> Find latest news on climate change
> Search for restaurants near Central Park

组合工作流：

> Connect to MCP servers, read API docs, and create a GitHub issue summarizing them

MCP安全

• MCP操作需要用户批准（除 mcp_list)
• API密钥存储在 ~/.groq/mcp-config.json 具有权限 0o600
• 永远不要将mcp-config.json提交到版本控制
• 定期旋转API键

发展

本地测试

# Auto-rebuild on changes
npm run dev

可用脚本

npm run build      # Build TypeScript to dist/
npm run dev        # Build in watch mode

项目结构

groq-code-cli/
├── src/
│   ├── commands/           # Slash command implementations
│   ├── core/               # Agent and CLI entry point
│   ├── tools/              # AI-callable tool functions
│   ├── ui/                 # Terminal UI components (React + Ink)
│   └── utils/              # Utilities (file ops, settings, MCP manager)
├── mcp-servers/            # Custom MCP server implementations
│   └── brave-search/       # Brave Search MCP server
├── docs/                   # Documentation assets
├── package.json
├── tsconfig.json
└── LICENSE

入口点：

• src/core/cli.ts -主CLI入口点
• src/core/agent.ts -AI代理实现
• src/ui/hooks/useAgent.ts -TUI代理桥

定制

添加新工具

1. 定义架构 在 src/tools/tool-schemas.ts:

export const YOUR_TOOL_SCHEMA: ToolSchema = {
  type: 'function',
  function: {
    name: 'your_tool_name',
    description: 'What your tool does',
    parameters: {
      type: 'object',
      properties: {
        param1: { type: 'string', description: 'Description' }
      },
      required: ['param1']
    }
  }
};

1. 实施 在 src/tools/tools.ts:

export async function yourToolName(param1: string): Promise {
  // Implementation
  return createToolResponse(true, result, 'Success');
}

1. 注册 在 TOOL_REGISTRY 和 executeTool 在 src/tools/tools.ts

1. 添加架构 到 ALL_TOOL_SCHEMAS 在 src/tools/tool-schemas.ts

添加新的Slash命令

1. 创建 src/commands/definitions/your-command.ts:

import { CommandDefinition, CommandContext } from '../base.js';

export const yourCommand: CommandDefinition = {
  command: 'yourcommand',
  description: 'Description',
  handler: ({ addMessage }: CommandContext) => {
    addMessage({ role: 'system', content: 'Response' });
  }
};

1. 注册 在 src/commands/index.ts

更改启动命令

改变 "groq" 在 package.json "bin" 字段转换为您的首选命令：

"bin": {
  "your-command": "./dist/core/cli.js"
}

然后： npm run build && npm link

更新日志

\[1.2.0\]-MCP集成和增强品牌

MCP功能

• 交互式服务器选择 /mcp 命令
• API密钥自动管理（保存、更新、安全输入）
• 动态的 {{cwd}} 路径占位符
• 自定义Brave Search MCP服务器（网络/新闻/本地搜索）
• 4个新的MCP工具： mcp_connect, mcp_call_tool, mcp_read_resource, mcp_list
• 支持文件系统、GitHub、谷歌地图、Postgres、Slack服务器

品牌化

• 紫绿松石渐变主题（#9D4EDD→ #00F5FF)
• 增强的ASCII艺术横幅
• 更新徽章和文件

技术性的

• 添加 @modelcontextprotocol/sdk@^1.20.0
• 新 src/utils/mcp-manager.ts 单例
• MCP服务器管理基础架构
• 全面的错误处理

\[1.1.0\]-增强的开发人员工具

新工具

• Git操作：状态、差异、日志、添加、提交、分支
• TODO提取：查找TODO/FIXME/HACK/NOTE/BUG/XXX
• 相关性分析：检查版本、过时的软件包

新命令

• /context -显示项目上下文大小
• /todos -提取TODO评论
• /init -生成项目上下文

技术性的

• 添加 simple-git@^3.28.0
• 3个新的工具模式和实现
• 增强的启动横幅

\[1.0.2\]-初始版本

• 核心CLI功能
• 基本工具和命令

鸣谢

这个增强版是在优秀的基础上构建的 Groq Code命令行界面 Groq团队。

原始项目: 使用groq/groq代码cli构建 许可证：MIT

此分叉中的增强功能

• MCP（模型上下文协议）与交互式管理的集成
• 自定义Brave Search MCP服务器实现
• Git操作、TODO提取、依赖关系分析
• 紫绿松石渐变配色方案
• 附加的斜线命令和全面的内联文档

所有增强功能都保持了MIT许可证和原始项目的精神。

贡献

欢迎通过PR进行改进！

原始项目：

• Groq Code命令行界面： 使用groq/groq代码cli构建
• 在上与Groq分享您的创作 X/推特!

特色社区创意：

• OpenRouter支持 拉胡尔弗兰
• 此增强版-MCP和开发人员工具

______________________________________________________________________

Made with ⚡ by the community • Built on Groq