chrome-use: Instructions file for Codex

AGENTS.md

Instructions for AI coding agents working with this codebase.

Package Manager

This project uses pnpm. Always use pnpm instead of npm or yarn for installing dependencies, running scripts, etc. (e.g., pnpm install, pnpm run build).

Code Style

• Do not use emojis in code, output, or documentation. Unicode symbols (✓, ✗, →, ⚠) are acceptable.
• In documentation and markdown, never use double hyphens (--) as a dash. Use an emdash (—) sparingly when needed. Prefer rewriting the sentence to avoid dashes entirely.
• CLI colored output uses cli/src/color.rs. This module respects the NO_COLOR environment variable. Never use hardcoded ANSI color codes.
• CLI flags must always use kebab-case (e.g., --auto-connect, --allow-file-access). Never use camelCase for flags (e.g., --autoConnect is wrong).

Documentation

When adding or changing user-facing features (new flags, commands, behaviors, environment variables, etc.), update all of the following:

1. cli/src/output.rs — --help output (flags list, examples, environment variables)
2. README.md — Options table, relevant feature sections, examples
3. skill-data/core/SKILL.md (and its references/) — so AI agents know about the feature when they load the core skill. Edit skill-data/core/SKILL.md for overview/workflow changes; edit skill-data/core/references/*.md for detailed reference content. Do not put feature content in skills/chrome-use/SKILL.md — that file is an intentionally thin discovery stub for npx skills add and exists only to redirect agents to chrome-use skills get core.
4. docs/*.html and their docs/en/*.html mirrors — the docs site at chrome-use.leeguoo.com. These are hand-written static HTML, not a generator: docs/ is Chinese, docs/en/ is English, and both must be updated. A commit that touches skill-data/ prints a reminder naming the pages to update.
5. README.md and README.zh.md — both, for the same reason.
6. Inline doc comments in the relevant source files