0 Fork 0

Files

T

f25b36a0f2 Add AGENTS.md for Cursor Cloud development environment setup (#144 )

* Add AGENTS.md with Cursor Cloud specific development instructions

- Document known issues: broken ESLint config, dev mode type-only import bug, Grok API 410 error
- Include quick reference table for common development commands
- Note environment requirements (Bun, GROK_API_KEY)

Co-authored-by: Ismail Pelaseyed <homanp@users.noreply.github.com>

* Update bun.lock after dependency install

Co-authored-by: Ismail Pelaseyed <homanp@users.noreply.github.com>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Ismail Pelaseyed <homanp@users.noreply.github.com>

2026-03-17 23:53:51 +01:00

2.0 KiB

Raw Blame History

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`
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).
Grok API 410 error: The client sends search_parameters in every API request, but xAI has deprecated "Live search". This causes a 410 error on headless prompts. This is an API compatibility issue in the codebase, not an environment problem.

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.
MORPH_API_KEY is optional (enables Morph Fast Apply editing).

2.0 KiB Raw Blame History