Liferay Workspace
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

ワークスペース内のAIツール

Liferay Workspaceでは、AIベースのツールを使用してプロジェクトを構築できます。ワークスペースには、あらゆるAIエージェントに付与できるルールとスキルが含まれています。これらのルールは、エージェントがプロジェクトの構造、プロジェクトを構築するBladeコマンド、およびエージェントが使用できるLiferay機能を認識するようにします。これらのスキルは、オブジェクトの作成、ページやフラグメントの構築、サイトのスタイリングといったタスクをガイドします。

前提条件

  1. ワークスペースを作成する前に、Blade 8.0.2以降のバージョンが動作していることを確認してください。バージョンを確認するには、以下を実行してください。

    blade version
    

    お使いのバージョンが8.0.2未満の場合は、Bladeをアップデートしてください。

    blade update
    

    Bladeをお持ちでない場合は、 Blade CLI を参照してください。

  2. Liferayワークスペースを作成する:

    blade init ai-workspace
    
    注記

    blade initワークスペースのupdateWorkspaceタスクを実行し、最新の公開ルールとスキルを新しいワークスペースにダウンロードします。タスクをスキップするには、 --skip-update-workspace ( -s) を渡します。

  3. お使いのLiferayのバージョンに応じたBladeプロンプト。それを提供すれば、ワークスペースが作成されます!

  4. 新しいワークスペースフォルダに切り替えます。

    cd ai-workspace
    

    このフォルダはワークスペースのルートです。ここから先は、担当エージェントがルールを読み上げます。ルールが正しく届いたことを確認するには、 ls .agentsを実行し、 liferay-rules.mdが存在することを確認してください。

  5. 選択したAIエージェントの指示に従って、システムにインストールしてください。例えば、Claude、Copilot、Geminiには、APIキーを使ってインストールおよび設定する必要のあるCLIツールがあります。 CursorとWindsurfは、それぞれのエディタにエージェントを組み込んでいる。

AIルール

Liferay Workspaceには、AIエージェントがLiferayプロジェクトを作成する際に役立つ、Markdownで記述されたルールが含まれています。これらのルールは、ワークスペース内の隠しフォルダにあります。

ワークスペースのルートには、プロジェクトのビルドフォルダとソースフォルダに加えて、非表示のAIルールフォルダが格納されています。

ワークスペースのルートにある.agentsフォルダは、正規のルールツリーです。そのエントリポイントはliferay-rules.mdで、これはエージェントをrules/にあるリファレンスカードとskills/にあるスキルにルーティングします(スキルとリファレンスカードを参照)。

各カスタムスキルを.agents/skills内の独自の新しいフォルダにSKILL.mdファイルとして保存することで、このツリーを拡張します。カスタム参照カードを.agents/rulesに新しいファイルとして保存します。エージェントがリクエストをルーティングできるように.agents/liferay-rules.mdの Skill Router テーブルに行を追加して、新しいスキルをマッピングします。

同梱されているスキルカードやリファレンスカードは変更しないでください。ルールを更新すると、 liferay-rules.mdを含むすべてのバンドルファイルが上書きされます。アップデート後は毎回、カスタムスキルルーターの行を再度追加してください。 Claude Codeを使用する場合は、カスタムスキルとリファレンスカードを.claudeフォルダ内の対応するパスにコピーし、スキル ルーターの行を.claude/CLAUDE.mdに追加してください。

エージェントがルールを自動的に見つけられない場合は、次のようなプロンプトを使用して.agentsフォルダを指定してください。

Using the rules in the current working directory's `.agents` folder, create an object client extension project that....

ルールでは、エージェントに対し、Liferayのベストプラクティスに従うよう指示しています。

  • エージェントはLiferayワークスペースの構造を学習します。
  • エージェントは、Liferay Model Context Protocol (MCP) サーバーへの接続方法とクエリの実行方法を学習します。 LiferayをMCPサーバーとして使用する方法については、「LiferayをMCPサーバーとして使用する」を参照してください。
  • エージェントは、汎用的で場合によっては古くなっているトレーニングデータではなく、 Liferay Learnをドキュメント作成に使用します。
  • エージェントは、オブジェクト、フラグメント、クライアント拡張機能を使用した構築など、最新のLiferayのベストプラクティスを提案します。
  • エージェントが、ワークスペースの設定方法、バンドルのダウンロード方法、Bladeを使ったバンドルの起動方法をご案内します。
  • エージェントは、定型コードを一切記述することなく、 client-extensionsフォルダ内に機能的な「Hello World」プロジェクトを作成できます。
  • エージェントは、プロジェクトの構築とデプロイに必要な正確なbladeコマンドを提供します。
  • エージェントは、実行中のLiferayインスタンスでフロントエンドクライアント拡張機能を表示および操作する方法を案内します。

スキルと参考カード

ベータ

開発者スキルはベータ版です。エージェントのパフォーマンスは、ハーネスの設定、モデルの選択、努力レベルなど、いくつかの変数に依存します。

Liferayのルールは、スキルカードとリファレンスカードという形式で整理されています。スキルは、クライアント拡張機能のスキャフォールディング、サイトの構築、Liferay Cloudプロジェクトのデプロイなど、1つのタスクをカバーし、 SKILL.mdファイルとして専用のフォルダに格納されます。リファレンスカードには、スキルが参照するデータ(Liferayが提供するクライアント拡張機能の種類やページの種類など)が格納されています。

スキルは一度にすべて読み込まれるのではなく、必要に応じて読み込まれるため、エージェントはあなたのタスクに一致するスキルのみを読み取ります。

Liferayがスキルを追加・改訂するにつれてスキルセットも変化するため、固定されたリストに基づいて作業するのではなく、エージェントに何ができるかを尋ねてください。

List the Liferay skills available in this workspace, and describe what each one does.

自分のスキルを書き出す

author-skill機能を使用して、ソースコード、仕様書、またはあなたへのインタビューから独自のスキルを作成します。これは、ワークスペースに既に存在するスキルの規則にあなたのスキルを照合し、 .agents/skills/[name]/SKILL.mdに書き込みます。 author-skill blade init updateWorkspace実行するとき、または自分でそのタスクを実行するときに、他のスキルとともにインストールされます。

  1. 習得したいスキルについて説明してください(または、プロンプトにauthor-skill名を記載してください)。

    Write a skill for [task].
    
  2. エージェントがソースを要求した場合は、リポジトリまたはモジュールへの絶対パス、あるいは仕様書のパスまたはURLを指定してください。どちらも持っていない場合は、担当者があなたにインタビューを行い、結果を未確認として記録します。

  3. エージェントからの、そのスキルのトリガーフレーズ、適用範囲、前提条件、成功シグナル、既知の失敗モード、および関連スキルに関する質問に回答してください。エージェントが、仕様とコードが一致しないなどの矛盾点を発見した場合、それぞれの不一致を解決します。

  4. 草稿を確認してください。エージェントは、スキル全体、そのパス、提案するスキルルーティングの行、および検証できなかったすべての情報を表示します。承認後にのみ、そのスキルが公開されます。

公開すると.agents/liferay-rules.mdの Skill Router テーブルにスキルの行が追加されます。 updateWorkspaceを実行すると、そのファイルがLiferayの公開バージョンに置き換えられ、該当の行が削除されます。エージェントは、プロンプトでスキル名を正確に指定しない限り、スキルルーティング行に該当しないスキルを見逃す可能性があります。 Liferayが同じ名前のスキルを公開しない限り、あなたのスキルのファイルはそのまま残ります。

クロード・コードを使用する

Liferayは、ワークスペースルールのコピーとClaude Code用のプラグインを提供します。

.claudeフォルダ

ワークスペースのルートにある.claudeフォルダには、Claude Code 用の.agentsツリーのコピーが含まれています。そのエントリーポイントはCLAUDE.mdであり、これはliferay-rules.mdをミラーリングしたものです。

author-skillスキルを公開すると、そのスキルを.claudeフォルダーにコピーし、 .claude/CLAUDE.mdにその行を追加します。ルールを更新する前に、既存の.claude/CLAUDE.mdファイルをバックアップしてください。更新するたびにCLAUDE.mdが上書きされます。アップデートのたびに、カスタムスキルルーターの行をこのファイルに再度追加してください。

Claude Codeがルールを見つけられない場合は、プロンプトで.claudeフォルダを指定してください。

Liferay Workspaceプラグイン

Claude Code 用の Liferay Workspace プラグインは、ワークスペースのローカル環境をセットアップ、チェック、構成、およびクリーンアップするためのコマンドを提供します。 Liferayは、これをliferay/liferay-workspace-skillsというGitHubリポジトリで公開しています。プラグインはワークスペースではなく、Claude Code内にインストールします。そして、そのコマンドは実行したワークスペースに対して作用します。

  1. Claude Codeで、リポジトリのプラグインマーケットプレイスを追加します。

    /plugin marketplace add liferay/liferay-workspace-skills
    
  2. プラグインをインストールしてください:

    /plugin install liferay-workspace@liferay-workspace-plugins
    

    すべてのワークスペースでプラグインを使用するには、Claude Codeがインストール範囲を尋ねてきたときに「ユーザー範囲」を選択してください。

プラグインのコマンドは、Claude Code の/liferay-workspace:というプレフィックスの下で利用できるようになりました。インストール範囲とプラグインの管理に関する情報については、Claude Code の記事「プラグインのインストールと管理」を参照してください。

このプラグインは、次のようなコマンドを提供します。

  • /liferay-workspace:clean: コンテナ、ビルド成果物、バンドルデータをクリーンアップします。
  • /liferay-workspace:doctor: 前提条件とサービスの状態を確認します。
  • /liferay-workspace:feature-flags:機能フラグを有効にします。
  • /liferay-workspace:mcp-server: Liferay MCPサーバーを有効にします。

ワークスペース独自のfeature-flagsとmcp-serverスキルは、プラグインなしで最後の2つのタスクを処理します。

ローカルのDocker環境をセットアップするには/liferay-workspace:setupを実行することもできます。セットアップ手順、コマンド一覧、前提条件、および構成に関する情報については、 Liferay Workspace プラグインの README を参照してください。

既存のワークスペースにAIルールを追加または更新する

ワークスペースに既にルールが設定されている場合は、更新する前に古いルールを削除してください。古いワークスペースでは、ルールは以下の場所に保存されます。

  • .claude/rules内の古いファイル( cx.mdやsetup.mdなど)
  • .cursor 、 .gemini 、 .github 、および.windsurfフォルダ
  • .workspace-rulesフォルダ

以前の場所に追加したカスタムルールをすべて.agentsフォルダに移行し、古いファイルが干渉しないようにLiferayの以前のルールを削除してください。 .githubフォルダでは、Liferay のルールファイル ( copilot-instructions.md 、 instructions/cx.instructions.md 、 instructions/setup.instructions.mdなど) のみを削除してください。このフォルダには、ご自身の GitHub 設定も含まれている可能性があるためです。

ワークスペースのupdateWorkspaceタスクは、最新の公開済み.agentsおよび.claudeフォルダーをワークスペースのルートにコピーします。

警告

このタスクを実行する前に、バンドルされているルールとスキル(カスタムスキルルーターの行を含む)への編集内容をバックアップしてください。このタスクは、公開済みのファイルと同じパスを持つすべてのファイルを上書きします。これには、 .agents/liferay-rules.mdおよび.claude/CLAUDE.mdが含まれます。古いファイルを復元するのではなく、更新されたファイルに編集内容を再度追加してください。

  1. ワークスペースで、ワークスペース用Gradleプラグインのバージョン17.1.4以降が使用されていることを確認してください。 settings.gradleファイルでcom.liferay.gradle.plugins.workspace依存関係を確認してください。変更するには、 「Liferay Workspace とバンドルされたプラグインの更新」を参照してください。

  2. ワークスペースのルートからタスクを実行します。

    blade gw updateWorkspace
    

    代わりに./gradlew updateWorkspace実行することもできます。タスクが完了すると、Gradle はBUILD SUCCESSFULと報告し、ワークスペース ルートには.agents/liferay-rules.mdと.claude/CLAUDE.mdが含まれます。

タスクを実行できない場合は、新しく生成されたワークスペースから.agentsフォルダと.claudeフォルダを、ワークスペースのルートディレクトリにコピーしてください。

Liferayは新しいルールを公開しても通知を送信しないため、今後のルール更新を取得するには、 updateWorkspace定期的に実行してください。

AIを使ってプロジェクトとコードを生成する

環境設定が完了したら、生成したワークスペースからAIエージェントを実行してください。プロンプトを送信すると、エージェントがルールを読み取り、それをLiferayプロジェクトに適用します。

エージェントがルールを見つけたことを確認するには、エージェントが報告する分析結果を確認してください。ルールについて言及されていない場合は、プロンプトで.agentsフォルダを指定してください。

クロード氏は、ルールを発見し適用したと報告している。

エージェントは、ワークスペースの設定を要求したとき、またはLiferayサーバーに接続できない場合にworkspace-initスキルを実行します。ワークスペースのbundlesフォルダに、一度も起動したことのないTomcatバンドルが含まれている場合、スキルは初回起動前にバンドルを準備します。

  • bundles/dataとbundles/osgi/stateを削除します。
  • 開発専用のプロパティをconfigs/local/portal-ext.propertiesに書き込みます。これらのプロパティは、Liferay のヘッドレス APIが提供される/o/*に基本認証を追加し、セットアップ ウィザード、利用規約画面、およびtest@liferay.com (パスワードtest) の強制パスワード変更を無効にします。
  • configs/local/portal-ext.propertiesをbundles/portal-ext.propertiesにコピーして、そのファイルを置き換えます。

この準備により、エージェントは手動でのサインインを必要とせずに、ヘッドレスAPIやMCPツールを呼び出すことができるようになります。バンドルが既に開始されている場合、エージェントは手動でサインインし、利用規約に同意し、パスワードを変更するように促します。エージェントが認証情報の更新を要求した際には、新しいパスワードを入力してください。Liferayは現在のパスワードの再利用を拒否します。これらの設定はローカル開発環境でのみ使用してください。

これらのスキルを使ってサイトを構築する完全な例については、 「ワークスペースの例におけるAIツール」を参照してください。

AIエージェントは新しいプロジェクトを立ち上げる手助けはできるが、開発者の代わりにはならない。生成されたコードを本番環境で使用する前に、必ず確認して修正してください。

楽しいプロンプトを!