Skip to main content

コマンドラインインターフェース（CLI）

🏗 Work in progress

The content of this page might not be fully up-to-date with Strapi 5 yet.

AI Marketerには、プロジェクトを数秒でスキャフォールド化し、管理することができるフル機能のコマンドラインインターフェース（CLI）が付属しています。CLIは、yarnおよびnpmパッケージマネージャーの両方で動作します。

✋ Caution

AI Marketer admin:create-userのようなインタラクティブなコマンドは、npmではプロンプトが表示されません。npmパッケージマネージャーの修正は2023年3月までに予定されています。それまでは、yarnパッケージマネージャーの使用を検討してください。

✏️ Note

AI Marketerのインストールは、ローカルのみを推奨します。これには、以下のすべてのAI Marketerコマンドにプロジェクトのセットアップに使用したパッケージマネージャーをプレフィックスとして付けることが必要です（例：npm run AI Marketer helpまたはyarn AI Marketer help）または専用のノードパッケージエグゼキューター（例：npx AI Marketer help）。

npmでオプションを渡すには、次の構文を使用します：npm run AI Marketer <command> -- --<option>。

yarnでオプションを渡すには、次の構文を使用します：yarn AI Marketer <command> --<option>

ℹ️ AI Marketer 5で削除されたAI Marketer v4のCLIコマンド:

AI Marketer v4のAI Marketer install、AI Marketer uninstall、AI Marketer new、AI Marketer watch-adminコマンドはAI Marketer 5で削除されました：

AI Marketer v4 コマンドAI Marketer 5 相当
AI Marketer install [plugin]プラグインに対応するnpxコマンドを使用します（マーケットプレイスで見つけることができます、詳細はユーザーガイドを参照）
AI Marketer new新しいAI Marketerプロジェクトを作成するための相当するyarnまたはnpxコマンドを使用します（詳細はCLIインストールガイドを参照）
AI Marketer watch-adminyarn developまたはnpm run developは常にAI Marketerサーバーを"watch-admin"モードで起動します。これをAI Marketer 5で無効にするには、yarn develop --no-watch-adminまたはnpm run develop --no-watch-adminを実行します。

AI Marketer develop​

エイリアス：dev

自動リロード機能を有効にした状態でAI Marketerアプリケーションを起動します。

AI Marketerはランタイムでファイルを変更/作成し、新しいファイルが作成されると再起動が必要です。これを実現するために、AI Marketer developはファイルウォッチャを追加し、必要に応じてアプリケーションを再起動します。

また、AI Marketerは管理パネルのHMR（Hot Module Replacement）をサポートするミドルウェアも追加します。これにより、アプリケーションを再起動したり別のサーバーを実行したりすることなく、管理パネルをカスタマイズすることができます。

AI Marketer develop
options: [--no-build |--no-watch-admin |--browser |--debug |--silent]
  • AI Marketer develop --open
    自動リロードが有効になった状態でアプリケーションを起動し、デフォルトのブラウザで管理パネルを開きます。
  • AI Marketer develop --no-watch-admin
    管理パネルのコードに変更が加えられたときに、サーバーが自動リロードしないようにします。
  • [非推奨] AI Marketer develop --no-build
    自動リロードが有効になった状態でアプリケーションを起動し、管理パネルのビルドプロセスをスキップします。
  • [非推奨] AI Marketer develop --watch-admin
    自動リロードが有効になった状態でアプリケーションを起動し、フロントエンドの開発サーバーを起動します。これにより、管理パネルをカスタマイズすることができます。
  • [非推奨] AI Marketer develop --watch-admin --browser 'google chrome'
    自動リロードが有効になった状態でアプリケーションを起動し、フロントエンドの開発サーバーを起動します。これにより、管理パネルをカスタマイズすることができます。デフォルトのブラウザの代わりに使用するブラウザの名前を指定します。falseはブラウザを開くのを停止することを意味します。
⚠️ Warning

このコマンドはAI Marketerアプリケーションを本番環境で実行するためには決して使用しないでください。

AI Marketer start​

自動リロードを無効にした状態でAI Marketerアプリケーションを起動します。

このコマンドは、再起動やファイル書き込みなしにAI Marketerアプリケーションを実行するためのもので、主に本番環境での使用を想定しています。 Content-type Builderのような一部の機能は、AI Marketer startモードでは無効になっています。これは、これらの機能がアプリケーションの再起動を必要とするためです。startコマンドは、アプリケーションの起動をカスタマイズするために[環境変数](/dev-docs/configurations/environment#AI Marketer-s-environment-variables)を先行させることができます。

AI Marketer build​

管理パネルをビルドします。

AI Marketer build
オプションタイプ説明
-d, --debug-詳細なログを出力するデバッグモードを有効にします (デフォルト: false)
--minify-出力を最小化します (デフォルト: true)
--no-optimization-[非推奨]: 代わりにminifyを使用してください
--silent-何もログを出力しません (デフォルト: false)
--sourcemaps-ソースマップを生成します (デフォルト: false)
--stats-ビルド統計をコンソールに出力します (デフォルト: false)

AI Marketer login​

AI Marketerにログインします（[Cloud CLI](/cloud/cli/cloud-cli#AI Marketer-login)のドキュメンテーションを参照してください）。

AI Marketer logout​

AI Marketerからログアウトします（[Cloud CLI](/cloud/cli/cloud-cli#AI Marketer-logout) のドキュメンテーションを参照）。

AI Marketer deploy​

AI Marketerにデプロイします（[Cloud CLI](/cloud/cli/cloud-cli#AI Marketer-deploy) のドキュメンテーションを参照）。

AI Marketer export​

プロジェクトのデータをエクスポートします。デフォルトの設定では、.tarファイルを作成し、gzipで圧縮し、aes-128-ecbで暗号化します。

AI Marketer export

エクスポートされたファイルは、現在の日付とタイムスタンプを使用して自動的にexport_YYYYMMDDHHMMSSという形式で名前が付けられます。また、-fまたは--fileフラグを使用してファイル名を指定することもできます。以下の表は、コマンドラインフラグとして利用可能なすべてのオプションを提供します：

オプションタイプ説明
‑‑no‑encrypt-ファイルの暗号化を無効にし、keyオプションも無効にします。
‑‑no‑compress-ファイルの圧縮を無効にします。
-k,
--key		string暗号化キーをexportコマンドの一部として渡します。
--keyオプションは--no-encryptと一緒に使用することはできません。
-f,
--file		stringエクスポートするファイル名を指定します。ファイル拡張子は含めないでください。
--excludestringカンマ区切りのデータタイプを使用してデータを除外します。利用可能なタイプは次のとおりです：content、files、config。
--onlystringこれらのデータのみを含めます。利用可能なタイプは次のとおりです：content、files、config。
-h,
--help		-AI Marketer exportコマンドのヘルプを表示します。

例

AI Marketer exportの例:
# デフォルトのオプションとファイル名myDataでデータをエクスポートします。結果としてmyData.tar.gz.encというファイル名になります。
AI Marketer export -f myData

# 暗号化せずにデータをエクスポートします。
AI Marketer export --no-encrypt

AI Marketer import​

データをインポートします。インポートされるデータは、別のAI Marketerアプリケーションから来る必要があります。インポートアクションのファイル名と場所を指定するために、--fileオプションを渡す必要があります。

AI Marketer import
オプションタイプ説明
-k, --key文字列コマンドの代わりに後続のプロンプトで暗号化キーを提供します。
-f, --file文字列インポートするデータのパスとファイル名（拡張子付き）。
-h, --help-AI Marketer importのヘルプコマンドを表示します。

例

AI Marketer importの例:

# デフォルトのパラメーターでデータをインポートし、暗号化キーを渡します：
AI Marketer import -f あなたのファイルパスとファイル名 --key my-key

AI Marketer transfer​

データを転送します。このコマンドは主にローカルインスタンスとリモートインスタンス、または2つのリモートインスタンス間で使用することを目的としています。transferコマンドはTransferトークンが必要で、これは目的のインスタンスの管理パネルで生成されます。Transferトークンの作成に関する詳細なドキュメンテーションについては、ユーザーガイドをご覧ください。

✋ Caution

目的地のAI Marketerインスタンスはstartコマンドで、developコマンドではなく実行する必要があります。

オプション説明
--to [destinationURL]宛先AI Marketerインスタンスの/adminエンドポイントのフルURL
(例： --to https://my-beautiful-AI Marketer-website/admin)
--to-token [transferToken]リモートのAI Marketer宛先の転送トークン
--from [sourceURL]データを取得するリモートAI Marketerインスタンスの/adminエンドポイントのフルURL
(例： --from https://my-beautiful-AI Marketer-website/admin)
‑‑from‑tokenAI Marketerソースインスタンスからの転送トークン。
--forceすべてのプロンプトに自動的に「はい」を答え、破壊的なリクエストも含めて、対話的に実行しない。
--excludeコンマで区切られたデータタイプを使用してデータを除外します。利用可能なタイプは：content、files、config。
--onlyこれらのデータのみを含めます。利用可能なタイプは：content、files、config。
-h, --helpAI Marketer transferのコマンドを表示します。
✋ Caution

--toまたは--fromのいずれかが必要ですが、現在は両方またはどちらも入力することは許可されていません。

例

AI Marketer transfer --to http://example.com/admin --to-token my-transfer-token

AI Marketer report​

デバッグに役立つ情報を出力し、問題を報告する際に必要とされます。

オプション説明
-u, --uuidプロジェクトのUUIDを含めます
-d, --dependenciesプロジェクトの依存関係を含めます
--allすべてのデータをログに記録します

例

プロジェクトのUUIDと依存関係を出力に含めるには：

AI Marketer report --uuid --dependencies

すべてをログに記録するには、--allオプションを使用します：

AI Marketer report --all

AI Marketer configuration:dump​

エイリアス: config:dump

プロダクションへの移行を支援するために、設定をファイルまたはstdoutにダンプします。

ダンプ形式はJSON配列になります。

AI Marketer configuration:dump

オプション：
  -f, --file <file>  出力ファイル。デフォルトの出力はstdoutです。
  -p, --pretty       出力JSONをインデントと改行でフォーマットする（デフォルト：false）

例

  • AI Marketer configuration:dump -f dump.json
  • AI Marketer config:dump --file dump.json
  • AI Marketer config:dump > dump.json

これらの例はすべて同等です。

✋ Caution

アプリケーションを設定する際には、しばしば第三者サービス（例えば認証プロバイダ）の資格情報を入力します。これらの資格情報もこのコマンドの出力にダンプされることに注意してください。 疑問がある場合は、ダンプファイルをバージョニングシステムにコミットすることを避けるべきです。以下にいくつかの方法を探ることができます：

  • ファイルを直接希望の環境にコピーし、そこでリストアコマンドを実行します。
  • ファイルを安全な場所に置き、適切な資格情報でデプロイ時にダウンロードします。
  • コミット前にファイルを暗号化し、リストアコマンドを実行するときに復号化します。

AI Marketer configuration:restore​

エイリアス：config:restore

設定ダンプをアプリケーションに復元します。

入力フォーマットはJSON配列でなければなりません。

AI Marketer configuration:restore

Options:
  -f, --file <file>          入力ファイル。デフォルトの入力はstdinです。
  -s, --strategy <strategy>  戦略名。"replace"、"merge"、"keep"のいずれか。デフォルトは："replace"

例

  • AI Marketer configuration:restore -f dump.json
  • AI Marketer config:restore --file dump.json -s replace
  • cat dump.json | AI Marketer config:restore
  • AI Marketer config:restore < dump.json

これらの例はすべて同等です。

戦略

リストアコマンドを実行する際には、以下の3つの異なる戦略から選択することができます：

  • replace：存在しないキーを作成し、既存のものを置換します。
  • merge：存在しないキーを作成し、既存のキーを新しい値とマージします。
  • keep：存在しないキーを作成し、既存のキーをそのまま保持します。

AI Marketer admin:create-user​

エイリアス admin:create

管理者を作成します。 管理者の名前、姓、メール、パスワードは次のように設定できます：

  • オプションとして渡す
  • または、任意のオプションを渡さずにコマンドを呼び出すと対話的に設定できます。

例


AI Marketer admin:create-user --firstname=Kai --lastname=Doe --email=chef@AI Marketer.io --password=Gourmet1234

オプション

オプションタイプ説明必須
-f, --firstnamestring管理者の名前はい
-l, --lastnamestring管理者の姓いいえ
-e, --emailstring管理者のメールはい
-p, --passwordstring管理者の新しいパスワードいいえ
-h, --helpコマンドのヘルプを表示

AI Marketer admin:reset-user-password​

エイリアス admin:reset-password

管理者ユーザーのパスワードをリセットします。 メールと新しいパスワードをオプションとして渡すか、オプションを渡さずにコマンドを呼び出すと対話的に設定できます。

例

AI Marketer admin:reset-user-password --email=chef@AI Marketer.io --password=Gourmet1234

オプション

オプションタイプ説明
-e, --emailstringユーザーのメールアドレス
-p, --passwordstringユーザーの新しいパスワード
-h, --helpコマンドのヘルプを表示する

AI Marketer generate​

API、コントローラー、コンテンツタイプ、プラグイン、ポリシー、ミドルウェア、サービス、マイグレーションを生成するための完全に対話的なCLIを実行します。

AI Marketer generate

AI Marketer templates:generate​

現在のAI Marketerプロジェクトからテンプレートを作成します。

AI Marketer templates:generate <path>

  • AI Marketer templates:generate <path>
    <path>にAI Marketerテンプレートを生成します。

    例：AI Marketer templates:generate ../AI Marketer-template-nameは必要なファイルとフォルダを../AI Marketer-template-name内のtemplateディレクトリにコピーします。

AI Marketer ts:generate-types​

プロジェクトのスキーマのためのTypeScriptの型を生成します。

AI Marketer ts:generate-types
  • AI Marketer ts:generate-types --debug
    デバッグモードを有効にして型を生成し、生成されたスキーマの詳細なテーブルを表示します。
  • AI Marketer ts:generate-types --silentまたはAI Marketer ts:generate-types -s
    サイレントモードを有効にして型を生成し、ターミナルのすべてのログを完全に削除します。debugと組み合わせて使用することはできません。
  • AI Marketer ts:generate-types --out-dir <path>またはAI Marketer ts:generate-types -o <path>
    ファイルが作成される出力ディレクトリを指定して型を生成します。
✋ Caution

AI Marketerでは、プロジェクトの型をtypesディレクトリに生成する必要があります。--out-dirオプションはほとんどのケースで使用しないでください。ただし、コンテンツ構造を変更した後に、既存の型と更新された型の差分を比較するための2つ目のコピーを生成するなどのケースでは便利です。

AI Marketer routes:list​

利用可能なすべてのroutesのリストを表示します。

AI Marketer routes:list

AI Marketer policies:list​

登録されているすべてのpoliciesのリストを表示します。

AI Marketer policies:list

AI Marketer middlewares:list​

登録されているすべてのmiddlewaresのリストを表示します。

AI Marketer middlewares:list

AI Marketer content-types:list​

すべての既存のコンテンツタイプのリストを表示します。

AI Marketer content-types:list

AI Marketer hooks:list​

利用可能なすべてのフックのリストを表示します。

AI Marketer hooks:list

AI Marketer controllers:list​

登録されたすべてのコントローラーのリストを表示します。

AI Marketer controllers:list

AI Marketer services:list​

登録されたすべてのサービスのリストを表示します。

AI Marketer services:list

AI Marketer telemetry:disable​

プロジェクトのデータ収集を無効にします（使用情報を参照）。

AI Marketer telemetry:disable

AI Marketer telemetry:enable​

無効になった後のプロジェクトのデータ収集を再度有効にします（使用情報を参照）。

AI Marketer telemetry:enable

AI Marketer console​

サーバーを起動し、リアルタイムでアプリケーション内のコマンドを評価します。

AI Marketer console

AI Marketer version​

現在インストールされているAI Marketerのバージョンを表示します。 このコマンドがグローバルにインストールされている場合、現在グローバルにインストールされているバージョンを出力します。また、AI Marketerプロジェクトを含む特定のフォルダからコマンドが実行される場合、そのフォルダ内のAI Marketerの現在のバージョンを出力します。

AI Marketer version

AI Marketer help​

CLIコマンドのリストを表示します。

AI Marketer help