Skip to content

AGENTS.md

Latest commit

 

History

History
85 lines (53 loc) · 3.42 KB

AGENTS.md

File metadata and controls

85 lines (53 loc) · 3.42 KB

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.
  • 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. skills/agent-browser/SKILL.md -- so AI agents know about the feature
  4. docs/src/app/ -- the Next.js docs site (MDX pages)
  5. Inline doc comments in the relevant source files

This applies to changes that either human users or AI agents would need to know about. Do not skip any of these locations.

In the docs/src/app/ MDX files, always use HTML <table> syntax for tables (not markdown pipe tables). This matches the existing convention across the docs site.

Architecture

This is a Rust codebase. The browser automation daemon lives in cli/src/native/ (daemon, actions, browser, CDP client, snapshot, state). The --engine flag selects Chrome vs Lightpanda. The install command downloads Chrome from Chrome for Testing directly.

Testing

Unit Tests

cd cli && cargo test

Runs all unit tests (~320 tests). These are fast and don't require Chrome.

End-to-End Tests

cd cli && cargo test e2e -- --ignored --test-threads=1

Runs 18 e2e tests that launch real headless Chrome instances and exercise the full native daemon command pipeline. Requirements:

  • Chrome must be installed
  • Must run serially (--test-threads=1) to avoid Chrome instance contention
  • Tests are #[ignore]'d so they don't run during normal cargo test

The e2e tests live in cli/src/native/e2e_tests.rs and cover: launch/close, navigation, snapshots, screenshots, form interaction, cookies, storage, tabs, element queries, viewport/emulation, domain filtering, diff, state management, error handling, and Phase 8 commands.

Linting and Formatting

cd cli && cargo fmt -- --check   # Check formatting
cd cli && cargo clippy            # Lint

Source Code Reference

Source code for dependencies is available in opensrc/ for deeper understanding of implementation details.

See opensrc/sources.json for the list of available packages and their versions.

Use this source code when you need to understand how a package works internally, not just its types/interface.

Fetching Additional Source Code

To fetch source code for a package or repository you need to understand, run:

npx opensrc <package>           # npm package (e.g., npx opensrc zod)
npx opensrc pypi:<package>      # Python package (e.g., npx opensrc pypi:requests)
npx opensrc crates:<package>    # Rust crate (e.g., npx opensrc crates:serde)
npx opensrc <owner>/<repo>      # GitHub repo (e.g., npx opensrc vercel/ai)