mcpField
C
cli

cli

github.com/saifyxpro開発2.3k55 回インストール2 週間前に更新
リポジトリ

cli について

`headlessx` コマンドで HeadlessX を操作するためのコマンドラインスキルです。ワークスペースの設定と保守、認証、オペレーターコマンドに加え、テキストと JSON の出力方法を案内します。

主な機能

  1. 01ローカルワークスペースの初期化と更新
  2. 02API キー認証の案内
  3. 03ライフサイクルおよびオペレーターコマンドの実行
  4. 04テキストと JSON の出力
  5. 05CLI スモークテストの手順

活用シーン

  1. 01HeadlessX ワークスペースの設定や更新
  2. 02HeadlessX API への認証
  3. 03ウェブサイトのスクレイピング、マップ、クロール
  4. 04CLI の状態やログの確認

インストール

コマンドをコピーしてターミナルで実行します。

$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
  • 現在のオペレーター優先の API マッピングについてはreferences/operator-routes.md

再現性のある検証を行うには、以下を実行します。

  • インストール、認証関連の機能、基本的なヘルプ出力を確認するには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

エージェント向けメモ

CLI は~/.headlessx以下のローカル HeadlessX ワークスペースを初期設定・管理でき、オペレーターコマンドは引き続き 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. オペレーター固有のヘルプまたはスモークテスト用コマンド

迅速かつ再現性のあるベースラインが必要な場合は、scripts/smoke_cli.pyを使用します。

コメント

Markdown 対応