本リファレンスでは、AIGNE WebSmith CLI で利用可能なすべてのコマンドを、エイリアス、パラメーター、使用例と共に掲載しています。
CLI 操作の標準的な構文は次のとおりです：
コマンドの実行
aigne web <command> [subcommand] [parameters]コマンドなしで aigne web を実行すると、インタラクティブモードが開始されます。
メインコマンド
以下の表は、主要なコマンドをまとめたものです。各コマンドの詳細は、以下のセクションで説明します。
| コマンド | エイリアス | 説明 |
|---|---|---|
| generate | gen, g | 設定ファイルに基づいて完全なウェブサイトを生成します。 |
| publish | pub, p | 生成されたウェブサイトを Pages Kit インスタンスに公開します。 |
| update | up | ユーザーのフィードバックに基づいて既存のウェブサイトコンテンツを修正します。 |
| translate | ウェブサイトのページを異なる言語に翻訳します。 | |
| theme | ウェブサイトのビジュアルテーマ（生成と適用を含む）を管理します。 | |
| component | comp | ウェブサイトの構築に使用されるコンポーネントライブラリを管理します。 |
| chat | ウェブサイト管理のためのインタラクティブモードを開始します（デフォルト）。 | |
| prefs | フィードバックから学習した保存済みのユーザー設定を管理します。 | |
| history | ウェブサイトに加えられた過去の更新ログを表示します。 | |
| clear | 生成されたファイル、ワークスペースデータ、または設定を削除します。 |
generate
generate コマンドは、指定された設定ファイルに基づいて、サイト構造の計画からページコンテンツやテンプレートの生成まで、完全なウェブサイトの作成を統括します。
エイリアス: gen, g
使用法:
生成
aigne web generateパラメータ:
- config
string— ウェブサイト設定のファイルパスを指定します。通常は自動的に提供されます。 - glossary
string— 一貫した用語を保証するための用語集ファイルへのパス。@ の形式を使用します。 - forceRegenerate
boolean— 既存の生成済みコンテンツを上書きして、すべてのページを強制的に再生成します。
publish
publish コマンドは、生成されたウェブサイトファイルを Pages Kit インスタンスにアップロードします。バッチアップロードプロセスを管理し、ステータスの監視を提供します。
エイリアス: pub, p
使用法:
公開
aigne web publish --appUrl "https://example.com"パラメータ:
- appUrl
string— ページを公開する Pages Kit ウェブサイトのターゲットベース URL。 - with-navigations
string(default:menu) — ナビゲーションデータを公開します。受け入れられる値は 'flat' または 'menu' です。 - with-locales
boolean— true に設定すると、ウェブサイトのロケールと言語設定を公開します。
update
update コマンドは、ユーザーから提供されたフィードバックに基づいて、既存のウェブサイトのコンテンツを修正します。テキストの修正、セクションの追加や削除、ページ構造の変更に使用できます。
エイリアス: up
使用法:
更新
aigne web update --pages "/about" --feedback "Add a mission statement."パラメータ:
- pages
array— 更新するページパスの配列（例：[\ - feedback
string— 指定されたページに必要な変更や改善点の説明。 - glossary
string— 一貫した用語のための用語集ファイルへのパス。@ の形式を使用します。
translate
translate コマンドは、既存のウェブサイトページのコンテンツを1つ以上の指定された言語に翻訳します。
使用法:
翻訳
aigne web translate --pages "/home" --langs "fr,de,es"パラメータ:
- pages
array— 翻訳するページパスの配列。 - langs
array— 言語コードの配列。利用可能な言語：en, zh, zh-TW, ja, fr, de, es, it, ru, ko, pt, ar。 - feedback
string— 翻訳の品質をガイドし、向上させるための具体的な指示。 - glossary
string— 一貫した翻訳のための用語集ファイルへのパス。@ の形式を使用します。
theme
theme コマンドは、ウェブサイトのビジュアルテーマ（生成と適用を含む）を管理します。
サブコマンド
generate ウェブサイトのデザインとユーザーの提案に基づいて新しいテーマを生成します。
エイリアス: gen
使用法:
テーマ生成
aigne web theme generate --name "CustomTheme"- name
string— 新しいテーマの名前。 - config
string— テーマの基として使用するウェブサイト設定のファイルパス。
apply 以前に生成されたテーマをウェブサイトに適用します。
エイリアス: a
使用法:
テーマの適用
aigne web theme applyこのサブコマンドには特定のパラメータはありません。現在設定されているテーマを適用します。
component
component コマンドは、ウェブサイトのコンポーネントライブラリを管理します。
エイリアス: comp
サブコマンド
pull 指定された URL からコンポーネントをプルして、ローカルのコンポーネントライブラリを更新します。
使用法:
コンポーネントプル
aigne web component pull --url "https://your-pages-kit/api/..."- url
string(required) — コンポーネントライブラリをプルする完全な URL。
list 現在のライブラリで利用可能なコンポーネントをリスト表示します。
エイリアス: ls, l
使用法:
コンポーネントのリスト表示
aigne web component listこのサブコマンドはパラメータを取りません。
chat
chat コマンドは、対話形式でウェブサイトを生成、更新、管理するためのインタラクティブセッションを開始します。これは、aigne web が他のコマンドを指定せずに実行された場合に実行されるデフォルトのコマンドです。
使用法:
コマンド
aigne webこのコマンドはパラメータを取りません。
prefs
prefs コマンドは、WebSmith がフィードバックから学習して AI の振る舞いをカスタマイズするためのユーザー設定を管理します。
サブコマンド
list 保存されているすべてのユーザー設定をリスト表示します。
エイリアス: ls
使用法:
設定のリスト表示
aigne web prefs listこのサブコマンドはパラメータを取りません。
remove 指定された1つ以上の設定を削除します。
エイリアス: rm
使用法:
設定削除
aigne web prefs remove --id "pref_abc123"- id
array(required) — 削除する設定 ID の配列。
toggle 1つ以上の設定のアクティブ状態を切り替えます。
エイリアス: t
使用法:
設定切替
aigne web prefs toggle --id "pref_abc123"- id
array(required) — 状態を切り替える設定 ID の配列。
history
history コマンドは、ウェブサイトのコンテンツと構造の更新履歴を表示するために使用されます。
サブコマンド
view 更新履歴をコンパクトなログ形式で表示します。各エントリにはハッシュ、日付、操作、および関連するフィードバックが含まれます。
エイリアス: log, list
使用法:
履歴表示
aigne web history viewこのサブコマンドはパラメータを取りません。
clear
clear コマンドは、プロジェクトディレクトリから生成されたファイル、ワークスペースデータ、または設定を削除します。
使用法:
クリア
aigne web clear --targets "generatedPages" "websiteConfig"パラメータ:
- targets
array— プロンプトなしでクリアする項目の配列。有効な項目：websiteStructure, generatedPages, websiteConfig, deploymentConfig, authTokens, mediaDescription, translationCaches。 - pagesDir
string— ソースページのデフォルトディレクトリパスを上書きします。 - tmpDir
string— 一時ワークスペースのデフォルトディレクトリパスを上書きします。 - outputDir
string— 生成されたページのデフォルトディレクトリパスを上書きします。 - configPath
string— 設定ファイルのデフォルトパスを上書きします。
まとめ
このリファレンスガイドでは、AIGNE WebSmith CLI の主要なコマンドとパラメータについて詳しく説明しました。タスク指向の手順については、ドキュメントのガイドセクションのガイドを参照してください。