zoushiyang/page-agent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update package descriptions

Browse Source
This commit is contained in:
Simon
2026-01-19 20:14:40 +08:00
parent 60450ea7be
commit 3df71788ff
3 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
AGENTS.md
View File

@@ -31,8 +31,8 @@ Simple monorepo solution: TypeScript references + Vite aliases. Update tsconfig
``` ```
packages/ packages/
├── page-agent/ # npm: "page-agent" ⭐ MAIN (with Panel UI + IIFE builds) ├── core/ # npm: "@page-agent/core" ⭐ Core agent logic (headless)
├── core/ # npm: "@page-agent/core" (headless, no UI) ├── page-agent/ # npm: "page-agent" entry class (with UI + controller + demo builds)
├── website/ # @page-agent/website (private) ├── website/ # @page-agent/website (private)
├── llms/ # @page-agent/llms ├── llms/ # @page-agent/llms
├── page-controller/ # @page-agent/page-controller ├── page-controller/ # @page-agent/page-controller
@@ -90,7 +90,7 @@ Build with `npm run build:iife --workspace=page-agent`.
### Page Agent (`packages/page-agent/`) ### Page Agent (`packages/page-agent/`)
| File | Description | | File | Description |
| ----------------------- | -------------------------------------------- | | ------------------------ | -------------------------------------------- |
| `src/PageAgent.ts` | ⭐ Main class with UI, extends PageAgentCore | | `src/PageAgent.ts` | ⭐ Main class with UI, extends PageAgentCore |
| `src/entry-iife.ts` | IIFE entry (exposes PageAgent class) | | `src/entry-iife.ts` | IIFE entry (exposes PageAgent class) |
| `src/entry-iife-demo.ts` | IIFE demo entry (auto-init with demo API) | | `src/entry-iife-demo.ts` | IIFE demo entry (auto-init with demo API) |
@@ -98,7 +98,7 @@ Build with `npm run build:iife --workspace=page-agent`.
### Core (`packages/core/`) ### Core (`packages/core/`)
| File | Description | | File | Description |
| ----------------------- | ------------------------------------------- | | ---------------------- | --------------------------------------- |
| `src/PageAgentCore.ts` | ⭐ Core agent class without UI | | `src/PageAgentCore.ts` | ⭐ Core agent class without UI |
| `src/tools/` | Tool definitions calling PageController | | `src/tools/` | Tool definitions calling PageController |
| `src/config/` | Configuration types and constants | | `src/config/` | Configuration types and constants |
@@ -107,10 +107,10 @@ Build with `npm run build:iife --workspace=page-agent`.
### LLMs (`packages/llms/`) ### LLMs (`packages/llms/`)
| File | Description | | File | Description |
| ---------------------------- | ------------------------------------- | | --------------------- | ------------------------------------- |
| `src/index.ts` | ⭐ LLM class with retry logic | | `src/index.ts` | ⭐ LLM class with retry logic |
| `src/types.ts` | MacroToolInput, AgentBrain, LLMConfig | | `src/types.ts` | MacroToolInput, AgentBrain, LLMConfig |
| `src/OpenAILenientClient.ts` | OpenAI-compatible client | | `src/OpenAIClient.ts` | OpenAI-compatible client |
### Page Controller (`packages/page-controller/`) ### Page Controller (`packages/page-controller/`)

4
README-zh.md
View File

@@ -76,8 +76,8 @@ PageAgent adopts a simplified monorepo structure:
``` ```
packages/ packages/
├── page-agent/ # AI agent and demo(npm: page-agent) ├── core/ # ** Core agent logic without UI(npm: @page-agent/core) **
├── core/ # Agent core logic without UI(npm: @page-agent/core) ├── page-agent/ # Exported agent and demo(npm: page-agent)
├── llms/ # LLM 客户端 (npm: @page-agent/llms) ├── llms/ # LLM 客户端 (npm: @page-agent/llms)
├── page-controller/ # DOM 操作 & 蒙层 & 模拟鼠标 (npm: @page-agent/page-controller) ├── page-controller/ # DOM 操作 & 蒙层 & 模拟鼠标 (npm: @page-agent/page-controller)
├── ui/ # 面板 & i18n (npm: @page-agent/ui) ├── ui/ # 面板 & i18n (npm: @page-agent/ui)

4
README.md
View File

@@ -74,8 +74,8 @@ PageAgent adopts a simplified monorepo structure:
``` ```
packages/ packages/
├── page-agent/ # AI agent and demo(npm: page-agent) ├── core/ # ** Core agent logic without UI(npm: @page-agent/core) **
├── core/ # Agent core logic without UI(npm: @page-agent/core) ├── page-agent/ # Exported agent and demo(npm: page-agent)
├── llms/ # LLM client (npm: @page-agent/llms) ├── llms/ # LLM client (npm: @page-agent/llms)
├── page-controller/ # DOM operations & Visual Mask (npm: @page-agent/page-controller) ├── page-controller/ # DOM operations & Visual Mask (npm: @page-agent/page-controller)
├── ui/ # Panel & i18n (npm: @page-agent/ui) ├── ui/ # Panel & i18n (npm: @page-agent/ui)