07242683bf
Complete collection of AI agent skills including: - Frontend Development (Vue, React, Next.js, Three.js) - Backend Development (NestJS, FastAPI, Node.js) - Mobile Development (React Native, Expo) - Testing (E2E, frontend, webapp) - DevOps (GitHub Actions, CI/CD) - Marketing (SEO, copywriting, analytics) - Security (binary analysis, vulnerability scanning) - And many more... Synchronized from: https://skills.sh/ Co-Authored-By: Claude <noreply@anthropic.com>
103 lines
3.4 KiB
Markdown
103 lines
3.4 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
|
|
## Build and Development Commands
|
|
|
|
Always use Node.js/npm instead of Bun.
|
|
|
|
```bash
|
|
# Install dependencies (from skills/dev-browser/ directory)
|
|
cd skills/dev-browser && npm install
|
|
|
|
# Start the dev-browser server
|
|
cd skills/dev-browser && npm run start-server
|
|
|
|
# Run dev mode with watch
|
|
cd skills/dev-browser && npm run dev
|
|
|
|
# Run tests (uses vitest)
|
|
cd skills/dev-browser && npm test
|
|
|
|
# Run TypeScript check
|
|
cd skills/dev-browser && npx tsc --noEmit
|
|
```
|
|
|
|
## Important: Before Completing Code Changes
|
|
|
|
**Always run these checks before considering a task complete:**
|
|
|
|
1. **TypeScript check**: `npx tsc --noEmit` - Ensure no type errors
|
|
2. **Tests**: `npm test` - Ensure all tests pass
|
|
|
|
Common TypeScript issues in this codebase:
|
|
|
|
- Use `import type { ... }` for type-only imports (required by `verbatimModuleSyntax`)
|
|
- Browser globals (`document`, `window`) in `page.evaluate()` callbacks need `declare const document: any;` since DOM lib is not included
|
|
|
|
## Project Architecture
|
|
|
|
### Overview
|
|
|
|
This is a browser automation tool designed for developers and AI agents. It solves the problem of maintaining browser state across multiple script executions - unlike Playwright scripts that start fresh each time, dev-browser keeps pages alive and reusable.
|
|
|
|
### Structure
|
|
|
|
All source code lives in `skills/dev-browser/`:
|
|
|
|
- `src/index.ts` - Server: launches persistent Chromium context, exposes HTTP API for page management
|
|
- `src/client.ts` - Client: connects to server, retrieves pages by name via CDP
|
|
- `src/types.ts` - Shared TypeScript types for API requests/responses
|
|
- `src/dom/` - DOM tree extraction utilities for LLM-friendly page inspection
|
|
- `scripts/start-server.ts` - Entry point to start the server
|
|
- `tmp/` - Directory for temporary automation scripts
|
|
|
|
### Path Aliases
|
|
|
|
The project uses `@/` as a path alias to `./src/`. This is configured in both `package.json` (via `imports`) and `tsconfig.json` (via `paths`).
|
|
|
|
```typescript
|
|
// Import from src/client.ts
|
|
import { connect } from "@/client.js";
|
|
|
|
// Import from src/index.ts
|
|
import { serve } from "@/index.js";
|
|
```
|
|
|
|
### How It Works
|
|
|
|
1. **Server** (`serve()` in `src/index.ts`):
|
|
- Launches Chromium with `launchPersistentContext` (preserves cookies, localStorage)
|
|
- Exposes HTTP API on port 9222 for page management
|
|
- Exposes CDP WebSocket endpoint on port 9223
|
|
- Pages are registered by name and persist until explicitly closed
|
|
|
|
2. **Client** (`connect()` in `src/client.ts`):
|
|
- Connects to server's HTTP API
|
|
- Uses CDP `targetId` to reliably find pages across reconnections
|
|
- Returns standard Playwright `Page` objects for automation
|
|
|
|
3. **Key API Endpoints**:
|
|
- `GET /` - Returns CDP WebSocket endpoint
|
|
- `GET /pages` - Lists all named pages
|
|
- `POST /pages` - Gets or creates a page by name (body: `{ name: string }`)
|
|
- `DELETE /pages/:name` - Closes a page
|
|
|
|
### Usage Pattern
|
|
|
|
```typescript
|
|
import { connect } from "@/client.js";
|
|
|
|
const client = await connect("http://localhost:9222");
|
|
const page = await client.page("my-page"); // Gets existing or creates new
|
|
await page.goto("https://example.com");
|
|
// Page persists for future scripts
|
|
await client.disconnect(); // Disconnects CDP but page stays alive on server
|
|
```
|
|
|
|
## Node.js Guidelines
|
|
|
|
- Use `npx tsx` for running TypeScript files
|
|
- Use `dotenv` or similar if you need to load `.env` files
|
|
- Use `node:fs` for file system operations
|