mcpField
C
cli

cli

github.com/saifyxpro开发2.3k55 次安装2 周前更新
代码仓库

关于 cli

通过 `headlessx` 命令使用 HeadlessX 的命令行技能，涵盖工作区设置与维护、身份验证及 operator 命令，并说明文本和 JSON 输出方式。

主要功能

  1. 01初始化并更新本地工作区
  2. 02引导 API 密钥身份验证
  3. 03运行生命周期和 operator 命令
  4. 04支持文本和 JSON 输出
  5. 05提供 CLI 烟雾测试指引

适用场景

  1. 01设置或更新 HeadlessX 工作区
  2. 02登录 HeadlessX API
  3. 03运行网站抓取、映射或爬取命令
  4. 04检查 CLI 状态和日志

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/saifyxpro/headlessx --skill cli

安装后在 Claude Code 中输入/cli确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
auth-and-output.md
command-matrix.md
operator-routes.md
scripts/
smoke_cli.py

详细介绍

HeadlessX CLI

使用 headlessx 作为规范命令。

如需了解完整的命令系列和路由覆盖范围，请阅读：

  • references/command-matrix.md，了解各操作对应的命令
  • references/auth-and-output.md，了解身份验证优先级和输出规则
  • references/operator-routes.md，了解当前以操作为先的 API 映射

如需进行确定性验证，请运行：

  • scripts/smoke_cli.py，验证安装、身份验证接口和核心帮助输出

快速入门

安装并验证：

npm install -g @headlessx-cli/core
headlessx --help

初始化本地工作区：

headlessx init

更新现有工作区：

headlessx init update
headlessx restart
headlessx logs --tail 200 --no-follow

身份验证工作流

仅使用 HeadlessX API 凭据。建议使用：

headlessx login

现在，当可进行交互式输入时，CLI 会在 headlessx init 和 headlessx login 中使用引导式现代提示。

如果用户已有这两个值，请使用标志：

headlessx login --api-key your_headlessx_api_key --api-url http://localhost:38473

如果会话应保持非交互式，请使用环境变量。请参阅 references/auth-and-output.md。

输出规则

面向 LLM 使用时，优先使用默认的 Markdown／文本输出。

仅在确实需要结构化机器可读输出时使用 --json。

命令模式

在编写多步骤 CLI 命令前，请阅读 references/command-matrix.md。其中包含：

  • 生命周期初始化命令
  • 网站抓取、映射和爬取示例
  • Google AI Search 标志
  • Tavily、Exa、YouTube、jobs 和 operators 示例
  • Markdown 和 JSON 文件输出模式

发布与安装

当前软件包：

  • @headlessx-cli/core

全局安装：

npm install -g @headlessx-cli/core

从此代码库发布：

cd /home/saifyxpro/CODE/Crawl/HeadlessX/packages/cli
npm login
pnpm type-check
pnpm build
npm publish --access public

Agent 说明

CLI 可以在 ~/.headlessx 下初始化并管理本地 HeadlessX 工作区，而 operator 命令仍会调用 HeadlessX API。

如果后端使用 apps/api/data 下的持久化浏览器配置文件，CLI 请求会共享该后端状态，因为它们经过同一个 API 实例。

用户要求“测试 CLI”时，优先执行：

  1. headlessx --help
  2. headlessx init --help
  3. headlessx login --help
  4. headlessx status
  5. headlessx doctor
  6. headlessx logs --no-follow
  7. 特定 operator 的帮助或冒烟测试命令

需要快速获得确定性基线时，请使用 scripts/smoke_cli.py。

评论

支持 Markdown