grok-cli AGENTS.md

Project instructions for AGENTS.md, a file that tells coding agents how to work in a repository, including commands, architecture notes, and known issues.

In plain words
What is it for?
Use it to install dependencies, type-check, build, run the CLI, and understand known development or linting problems.
Why use it?
It gives an agent the project-specific commands and constraints needed to build, check, and run the code correctly.

Instructions file for CodexOpenCode

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.

agentmods
npx agentmods add instructions/superagent-ai/grok-cli/agents-md
Clone the repo
git clone --depth 1 https://github.com/superagent-ai/grok-cli

Made for: Codex, OpenCode.

Per session 467 This file is loaded in full into every session.
When invoked 467 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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.

ModelPer sessionOnce invoked
Fable 5 $0.00467 $0.00467
Opus 5 $0.00234 $0.00234
Sonnet 5 $0.00093 $0.00093
Haiku 4.5 $0.00047 $0.00047

Measured 2d ago against content hash 7b37803590da, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

grok-cli AGENTS.md 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 2d 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.

AGENTS.md · 30 lines

What it actually says

AGENTS.md

Cursor Cloud specific instructions

Overview

Grok CLI (@vibe-kit/grok-cli) is a single-package TypeScript CLI tool — no databases, Docker, or background services. See README.md for full documentation and usage.

Quick reference

Action Command
Install deps bun install (installs Husky; pre-commit runs Biome on staged files)
Typecheck bun run typecheck
Build bun run build
Run built CLI node dist/index.js
Headless mode node dist/index.js --prompt "..." --max-tool-rounds N
CLI help node dist/index.js --help

Known issues

  • ESLint config is broken: The repo has .eslintrc.js (legacy format) but uses ESLint 9 (^9.31.0) + @typescript-eslint v8, which require flat config (eslint.config.js). Additionally, .eslintrc.js uses module.exports (CJS) but package.json has "type": "module" (ESM). Running bun run lint will fail. Use bun run typecheck as the primary code quality check (this is also what CI enforces).
  • Dev mode (bun run dev / bun run dev:node) fails at runtime: src/utils/model-config.ts imports TypeScript interfaces (UserSettings, ProjectSettings) as value imports from settings-manager.ts. These type-only exports are erased at runtime by Bun and tsx, causing SyntaxError: export '...' not found. The fix is to use import type syntax, but this is a pre-existing repo issue. Workaround: build first (bun run build), then run the compiled version (node dist/index.js).

Environment

  • Bun must be installed (not pre-installed on Cloud VMs). The update script handles this.
  • GROK_API_KEY environment variable is required for API calls. Set it as a secret.
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.

  1. 2d ago First seen · 30 lines · 467 tokens per session scan A 7b37803590da

Subscribe to this mod's changes

grok-cli AGENTS.md is an instructions file published in the GitHub repository superagent-ai/grok-cli (3,445 stars, last pushed 1mo ago), licensed MIT. It adds 467 tokens to every session, about $0.0023 per session on Opus 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.

Related

Other instructions, from other repositories