react-ink-components

Rules for building React components with Ink, a library that renders terminal interfaces using React-style components instead of web-page elements.

In plain words
What is it for?
Use them when creating or reviewing terminal UI components such as chat views, diff displays, prompts, loading indicators, and status panels.
Why use it?
They help terminal screens behave consistently and fit the project's existing component structure and keyboard interactions.

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

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 427 The whole file, excluding the scripts and references it only reads on demand.
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.00000 $0.00427
Opus 5 $0.00000 $0.00214
Sonnet 5 $0.00000 $0.00085
Haiku 4.5 $0.00000 $0.00043

Measured yesterday against content hash a7f6d55985c3, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

react-ink-components 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 yesterday.

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/react-ink-components.mdc · 46 lines

What it actually says

React + Ink Terminal UI

Framework

This project uses Ink v4 to render React components in the terminal. Ink provides <Box>, <Text>, and other primitives instead of HTML elements.

Component Patterns

  • Use functional components with hooks — no class components.
  • JSX is compiled with "jsx": "react" (classic transform), so import React from "react" is required in every .tsx file.
  • Components are in src/ui/components/ and follow kebab-case naming (chat-interface.tsx, diff-renderer.tsx).

Key Components

Component Purpose
ChatInterface Main chat loop, orchestrates agent interaction
ChatHistory Renders conversation entries
ChatInput User text input with key bindings
DiffRenderer Displays file diffs
ModelSelection Model picker UI
LoadingSpinner Animated loading indicator
ConfirmationDialog User confirmation prompts for tool operations
McpStatus MCP server connection status
CommandSuggestions Autocomplete suggestions
ApiKeyInput API key entry prompt

Ink-Specific Guidelines

  • Use <Box> for layout (flexbox model) and <Text> for styled text.
  • Use Ink's useInput hook for keyboard handling.
  • Use chalk for color utilities in src/ui/utils/colors.ts.
  • Markdown rendering for chat output uses marked + marked-terminal.
  • The app is rendered via render(React.createElement(ChatInterface, { agent, initialMessage })) in the entry point.

Hooks

  • Custom hooks live in src/hooks/.
  • Follow the use prefix convention (useInput, useChat, etc.).
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. yesterday First seen · 46 lines · 0 tokens per session scan A a7f6d55985c3

Subscribe to this mod's changes

react-ink-components is a cursor rule published in the GitHub repository superagent-ai/grok-cli (3,441 stars, last pushed 1mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 427 tokens. 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.