yamory の使い方

yamory へようこそ! yamory の基礎知識と使い方をご紹介します。

コマンドラインから npm プロジェクトをスキャンする

npm プロジェクトをスキャンする場合、コマンドライン上で該当プロジェクトのルートに移動し、下記を実行してください。

PROJECT_GROUP_KEY=<yamory 上のプロジェクトグループ識別キー> YAMORY_API_KEY=xxxxxxxxxxxxxxxxx YAMORY_OPEN_SYSTEM=true YAMORY_DISTRIBUTED=true bash -c "$(curl -sSf -L <https://yamory/script/...>)"

コマンドラインで実行する際、以下の箇所を設定してください。

<yamory 上のプロジェクトグループ識別キー>:サービス名称などを設定してください(例: yamory)(半角英数記号のみ、半角スペースは入力不可)。

<https://yamory/script/...>: サイドバーの「アプリライブラリ」>「スキャン」を開き、「新しいプロジェクトをスキャン+」ボタンを押して出てくる案内にしたがって入力を進め、最後に表示されるスキャンコマンドの URL に置き換えてください。

コマンドオプション

マルチプロジェクト構成でサブプロジェクトの package.json をスキャンしたい場合、 --manifest オプションでサブディレクトリにある package.json を指定できます。

PROJECT_GROUP_KEY=<yamory 上のプロジェクトグループ識別キー> YAMORY_API_KEY=xxxxxxxxxxxxxxxxx YAMORY_OPEN_SYSTEM=true YAMORY_DISTRIBUTED=true bash -c "$(curl -sSf -L <https://yamory/script/...>)" -- --manifest ./packages/サブディレクトリ/package.json

YAMORY_OPEN_SYSTEM について

yamory 上の「公開サービス(外部ネットワークからパブリックアクセスが可能なアプリケーション、またはサービスとして使用するか)」を指定できます。
公開サービスの場合は true、非公開サービスの場合は false を指定します。
YAMORY_OPEN_SYSTEM が未入力の場合、前回スキャン情報があればその状態を引き継ぎ、初回スキャン時は公開サービスとして登録されます。
本パラメータはトリアージレベルの計算に使用されます。

YAMORY_DISTRIBUTED について

yamory 上の「頒布プロジェクト」の状態を指定できます。
頒布プロジェクトの場合は true、非頒布プロジェクトの場合は false を指定します。
YAMORY_DISTRIBUTED が未入力の場合、前回スキャン情報があればその状態を引き継ぎ、初回スキャン時は頒布プロジェクトとして登録されます。
(npm, Yarnで管理されているプロジェクトでは、フロントエンドのプロジェクトが多いため、「頒布プロジェクト」がデフォルトとなります)