What is project-overview?

An overview of Grok CLI, an open-source terminal program that provides AI coding assistance through the Grok service.

Use it to locate the agent, API client, search tools, terminal interface, settings, and Git repository discovery code.

It explains the project's main parts, technologies, and command-line architecture before someone changes the code.

project-overview — Cursor rule for Cursor by superagent-ai/grok-cli

About the project

grok-cli is an open-source terminal coding agent that uses the Grok API to work on software projects. Developers use it for interactive or headless coding tasks, with features including web and X search, sub-agents, a terminal interface, and remote control through Telegram.

superagent-ai/grok-cli · 3,496 stars · on GitHub

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Clone the repo

git clone --depth 1 https://github.com/superagent-ai/grok-cli

Made for: Cursor.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/rules/superagent-ai/grok-cli/project-overview/github.svg)](https://agentmods.dev/rules/superagent-ai/grok-cli/project-overview)

Your own site

<a href="https://agentmods.dev/rules/superagent-ai/grok-cli/project-overview"><img src="https://agentmods.dev/badge/rules/superagent-ai/grok-cli/project-overview/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/rules/superagent-ai/grok-cli/project-overview"><img src="https://agentmods.dev/badge/rules/superagent-ai/grok-cli/project-overview.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 753 This file is loaded in full into every session.

When invoked 753 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00753	$0.00753
Opus 5.5	$0.00301	$0.00301
Sonnet 5.5	$0.00151	$0.00151
Haiku 4.5	$0.00075	$0.00075

Measured 1mo ago against content hash 523d3251e067, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

project-overview scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/project-overview.mdc · 66 lines

How it starts

The opening of the file, as written. The whole thing — 66 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Grok CLI — Project Overview

Grok CLI (@vibe-kit/grok-cli) is an open-source AI coding agent powered by Grok that brings AI assistance directly into the terminal.

Tech Stack

Language: TypeScript (ES2022, ESNext modules)
Runtime: Bun (primary)
UI Framework: React with OpenTUI for terminal rendering
Build: tsc (TypeScript compiler)
Package Manager: Bun
API Client: OpenAI SDK (for OpenAI-compatible xAI API)
Tools: Bash-only (all file operations via shell commands)
Search: X Search API + Web Search via xAI Responses API

Architecture

src/
├── index.ts          # CLI entry point (Commander.js + OpenTUI)
├── agent/
│   └── agent.ts      # Agent — orchestrates client, bash tool, search
├── grok/
│   ├── client.ts     # Grok API client (Chat Completions + Responses API)
│   ├── models.ts     # Model definitions and metadata
│   └── tools.ts      # Tool schemas (bash, search_web, search_x)
├── tools/
│   └── bash.ts       # Bash command execution
├── ui/
│   └── app.tsx       # OpenTUI React terminal UI
├── utils/
│   ├── settings.ts   # User and project settings
│   ├── git-root.ts   # Resolve git repository root for AGENTS.md discovery
│   └── instructions.ts # AGENTS.md (ecosystem) custom instructions
└── types/
    └── index.ts      # Shared TypeScript types

Key Patterns

Agent loop: Agent.processMessage() is an async generator that yields StreamChunk objects — the LLM responds, tools execute, results feed back until no more tool calls remain.
Bash-only tools: The agent uses bash for everything (file editing, searching, git, builds, etc.).
X Search & Web Search: Integrated via the xAI Responses API for real-time information.
Settings hierarchy: Environment variables → User-level (~/.grok/user-settings.json) → Project-level (.grok/settings.json).
Custom instructions: ~/.grok/AGENTS.md, then AGENTS.override.md / AGENTS.md per directory from git root through the workspace cwd (Codex-style merge).
ESM only: The project uses "type": "module" — all imports use .js extensions for compiled output.

Read the full file on GitHub · 66 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

1mo ago First seen · 66 lines · 753 tokens per session scan A 523d3251e067

Subscribe to this mod's changes

project-overview is a cursor rule published in the GitHub repository superagent-ai/grok-cli (3,496 stars, last pushed 3mo ago), licensed MIT. It adds 753 tokens to every session, about $0.0030 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

agents ai cli code grok xai

use-bun-instead-of-node-vite-npm-pnpm

../../CLAUDE.md.

ashlrai/ashlrcode · 5 tokens

po

AIOX agent @po - Product Owner.

SynkraAI/aiox-core · 9 tokens

hatch3r-dynamic-stack-verification

Runtime-evidence gates for stacks with no static type layer (plain-JS Vue, dynamic persistence) — smoke-mount changed components, dormant-collection-read ratchet, runtime smoke evidence on module-boundary changes; a green lint+build+mock-suite proves a layer, not the system.

hatch3r/hatch3r · 0 tokens

hatch3r-spec-currency

Spec-currency mandate — any diff changing user-observable behavior covered by a docs/specs/ file updates that spec in the same delivery; staleness definition, review-gate drift finding with a named owner, and a release-readiness sweep.

hatch3r/hatch3r · 0 tokens

bundling

The project uses a custom type bundling system to provide full TypeScript IntelliSense support in the Monaco editor for @bubblelab/bubble-core and its dependencies. This is necessary because Monaco cannot directly resolve workspace packages or external dependencies.

bubblelabai/BubbleLab · 1,505 tokens

hatch3r-api-design

REST, GraphQL, and gRPC contract patterns covering versioning, auth, CORS, pagination, webhooks, rate limiting, and security headers.

hatch3r/hatch3r · 30 tokens