@gui-chat-plugin/browse

中文文档
2.1.0发布于 2026/10/18MITTypeScriptESM + CJS零依赖近 30 天下载 4914

Web browsing plugin for GUI Chat applications

原始使用文档
文档目录13 节
  1. Features
  2. Installation
  3. Usage
  4. Vue Integration
  5. Core-only Usage
  6. API
  7. BrowseArgs
  8. BrowseToolData
  9. BrowseJsonData
  10. Development
  11. Test Prompts
  12. License
  13. Related

@gui-chat-plugin/browse

npm version scoria

Web browsing plugin for GUI Chat applications. Browse and extract content from web pages.

Features

  • Extract content from any web page URL
  • Twitter/X post embedding support
  • Article content parsing (title, byline, excerpt, body)
  • Clean, readable content display

Installation

yarn add @gui-chat-plugin/browse gui-chat-protocol

gui-chat-protocol is a peer dependency — install it alongside the plugin; the host application provides the runtime and this plugin only declares the compatible range.

Usage

Vue Integration

// In src/tools/index.ts
import BrowsePlugin from "@gui-chat-plugin/browse/vue";

const pluginList = [
  // ... other plugins
  BrowsePlugin,
];

// In src/main.ts
import "@gui-chat-plugin/browse/style.css";

Core-only Usage

import { executeBrowse, TOOL_DEFINITION } from "@gui-chat-plugin/browse";

// Browse a webpage
const result = await executeBrowse(context, {
  url: "https://example.com/article",
});

API

BrowseArgs

interface BrowseArgs {
  url: string; // The URL of the webpage to browse
}

BrowseToolData

interface BrowseToolData {
  url: string;
  twitterEmbedHtml?: string | null;
}

BrowseJsonData

interface BrowseJsonData {
  data: {
    title?: string;
    description?: string;
    content?: string;
    textContent?: string;
    text?: string;
    byline?: string;
    excerpt?: string;
  };
}

Development

# Install dependencies
yarn install

# Run demo
yarn dev

# Build
yarn build

# Lint
yarn lint

Test Prompts

Try these prompts to test the plugin:

  1. "Browse the Wikipedia page about artificial intelligence and tell me the key points"
  2. "Show me what's on the Hacker News homepage"
  3. "Read this article and summarize it: https://example.com/article"

License

MIT

版本与发布记录

@gui-chat-plugin/browse 共发布 11 个版本,首次发布于 2026/01/19;过去 12 个月发布了 11 个版本。

版本发布日期距今
2.1.0latest2026/10/1830 天前
2.0.02026/08/033 个月前
1.1.12026/08/033 个月前
1.1.02026/07/243 个月前
1.0.02026/07/233 个月前
0.5.12026/07/164 个月前

关于 @gui-chat-plugin/browse 的常见问题

@gui-chat-plugin/browse 是什么?

Web browsing plugin for GUI Chat applications

如何安装 @gui-chat-plugin/browse?

在项目目录运行 npm install @gui-chat-plugin/browse,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:vue(^3.5.0)、gui-chat-protocol(^2.3.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gui-chat-plugin/browse 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gui-chat-plugin/browse 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gui-chat-plugin/browse 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gui-chat-plugin/browse 可以商用吗?

@gui-chat-plugin/browse 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gui-chat-plugin/browse 的下载量有多少?

根据 npm 官方下载统计,@gui-chat-plugin/browse 在 2026/10/17 – 2026/11/15 这 30 天内被下载 4,914 次,日均约 164 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gui-chat-plugin/browse 还在维护吗?

最新版本 2.1.0 发布于 2026/10/18(30 天前);至今共发布 11 个版本,其中过去 12 个月发布了 11 个;首次发布于 2026/01/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。