development-workflow

A development workflow guide that documents the required Bun setup and the commands for installing dependencies, developing, building, checking types, linting, formatting, and running the project.

In plain words
What is it for?
It is for working on the project, running its checks, formatting staged files, and meeting the type-checking and linting expectations for pull requests.
Why use it?
It gives contributors a shared routine for preparing changes and catching problems before submission.

Cursor rule for Cursor

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 rules/superagent-ai/grok-cli/development-workflow
Clone the repo
git clone --depth 1 https://github.com/superagent-ai/grok-cli

Made for: Cursor.

Per session 486 This file is loaded in full into every session.
When invoked 486 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.00486 $0.00486
Opus 5 $0.00243 $0.00243
Sonnet 5 $0.00097 $0.00097
Haiku 4.5 $0.00049 $0.00049

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

Security

Grade A, and why

development-workflow 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.

.cursor/rules/development-workflow.mdc · 67 lines

What it actually says

Development Workflow

Prerequisites

  • Bun 1.0+ (required)

Common Commands

# Install dependencies
bun install

# Development (runs from source with Bun)
bun run dev

# Build (compile TypeScript to dist/)
bun run build

# Type checking (no emit)
bun run typecheck

# Linting
bun run lint

# Format (check / write)
bun run format
bun run format:fix

# Run the built CLI
bun run start

Environment Variables

Variable Required Description
GROK_API_KEY Yes API key for xAI Grok
GROK_BASE_URL No Custom API endpoint (default: https://api.x.ai/v1)
GROK_MODEL No Model override (default: grok-4.3)
GROK_MAX_TOKENS No Max tokens per response (default: 16384)

Copy .env.example to .env and fill in your values.

Git hooks

After bun install, Husky installs a pre-commit hook that runs lint-staged: Biome format + lint (check --write) on staged *.{ts,tsx,js,mjs,cjs,json} files. Fixes are written to disk and re-staged automatically when possible.

Before Submitting Changes

  1. Run bun run typecheck — CI enforces this on every PR.
  2. Run bun run lint — fix any Biome issues (or let pre-commit apply safe fixes).
  3. Ensure no secrets or .env files are committed.
  4. Follow the PR template in .github/pull_request_template.md.

Project Structure Conventions

  • Source code lives in src/, compiled output in dist/ (gitignored).
  • The CLI entry point is src/index.ts which uses Commander.js for argument parsing.
  • UI is built with OpenTUI React (@opentui/react).
  • Only tool is bash — all file operations happen through shell commands.
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 · 67 lines · 486 tokens per session scan A 67d4d6a7e699

Subscribe to this mod's changes

development-workflow is a cursor rule published in the GitHub repository superagent-ai/grok-cli (3,441 stars, last pushed 1mo ago), licensed MIT. It adds 486 tokens to every session, about $0.0024 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.