Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

grokx

用 xAI Grok 订阅(OAuth) 驱动本地开发工具的命令行工具。一次 grokx login,即可:

  • 🔎 联网搜索(主要能力):grokx search 调用 Grok 的实时 web / X 搜索,把"上网查资料并汇总"封装成一个工具,供 Claude Code、Codex 等 agent 调用,返回带来源链接的 Markdown 摘要。
  • 🔌 模型代理(可选):grokx serve 起一个本地代理,同时暴露 OpenAIAnthropic 兼容端点,让 Codex / Claude Code 直接把 Grok 当模型后端使用(零改动,只改 base_url)。

凭证通过 OAuth PKCE 获取并存于 ~/.grokx/auth.json(权限 0600),access token 在使用时按需自动刷新。

安装

预编译二进制(macOS arm64/x86_64、Linux x86_64),无需 Rust:从 Releases 下载对应 grokx-<target>.tar.gz 解压即用。

或从源码安装(需 Rust):

git clone git@github.com:jaymie9019/grokx.git
cd grokx
cargo install --path .

用 Claude Code 的 grok-search skill 时无需手动安装——它会自动下载最新二进制(见下文)。

登录(一次即可)

grokx login          # 浏览器 PKCE 登录
grokx status         # 查看登录态与有效期
grokx models         # 列出账号可用模型

🔎 搜索(给 agent 当工具)

用 Grok 的联网搜索能力查资料并汇总:

grokx search "<查询>" [--depth fast|expert|heavy] [--no-x] [--no-web] [--timeout <>]
  • 默认 --depth expert、同时搜 web 与 X;输出 Markdown 摘要 + ## 来源 链接列表。
  • 深度档:fast(快查)、expert(默认,深挖)、heavy(多 agent 协同,慢且贵)。
  • --no-x / --no-web 关闭对应搜索源;--timeout <秒> 设置请求超时(默认:fast 60 / expert 180 / heavy 300)。

接入 agent:

  • Claude Code:把 skills/grok-search/ 复制到 ~/.claude/skills/(或项目 .claude/skills/),Claude 需要联网信息时会自动调用该 Skill。
  • Codex:见 docs/codex-grok-search.md,把片段加进项目的 AGENTS.md

提示:heavy 可能耗时数分钟,而调用方(Claude Code / Codex)自身的命令超时通常更短,容易先被它们中止。日常优先 expert/fast,需要 heavy 时记得放宽调用方的命令超时。

🔌 模型代理(可选)

grokx serve --port 8787   # 本地代理,自动注入并刷新 OAuth token

OpenAI 兼容(给 Codex):

codex --model grok-4.3 --base-url http://127.0.0.1:8787/v1 --api-key dummy

Anthropic 兼容(给 Claude Code):

ANTHROPIC_BASE_URL=http://127.0.0.1:8787 \
ANTHROPIC_AUTH_TOKEN=dummy \
claude

serve 可选参数:--host--require-key <KEY>(同机门禁)、--model-map claude-3-5-haiku=grok-4.3(把 Claude 模型名映射到 Grok 模型)。

命令一览

命令 说明
grokx login 浏览器 PKCE 登录
grokx logout 删除本地凭证
grokx status 查看登录态、有效期、上游连通性
grokx models 列出账号可用模型
grokx search <q> 联网搜索并汇总(给 agent 当工具)
grokx serve 启动本地 OpenAI/Anthropic 兼容代理

开发

cargo test     # 单元 + 集成测试(wiremock 模拟上游)
cargo build --release

致谢

Anthropic ↔ OpenAI 翻译层 vendor 自 anthropic-proxy-rs(MIT),见 NOTICE

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages