> For the complete documentation index, see [llms.txt](https://docs.flosum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flosum.com/devops/devops-ja/kdo/devops-cli/flosum-cli-nodejs-pakkjinoinsutru.md).

# Flosum CLI Node.js パッケージのインストール

{% hint style="warning" %}

#### 既知の問題: 必須の更新

**更新が必要です。** Flosum DevOps の現在のリリースでは、Flosum CLI の最新バージョン（**@flosum/cli** パッケージ）および **Flosum DevOps-CLI 拡張機能**。以前の CLI リリースはトポロジーをサポートしておらず、それらを使用する DevOps テナントでは動作できないため、既存のインストールは更新する必要があります。

**Node.js 22 が必要です。** で **Node.js 24**、インストールおよび更新コマンドは成功したように見えますが、以前のリリースのままになります。インストールまたは更新を行う前に Node.js 22 に移行してください。
{% endhint %}

{% hint style="success" %}

#### OSの互換性

**Flosum CLI** および **Flosum DevOps-CLI Extension** は以下のオペレーティングシステムに対応しています：

* **macOS**
* **Linux**

これらのツールは現在、Windowsでの使用を想定していません。
{% endhint %}

## ![](https://225042527-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRpUu5iMlzMFAudyBvMOl%2Fuploads%2FG5ZbxX918xOHwbAwAJ4n%2FSummary2-Small-Icon.svg?alt=media\&token=da26a67f-ff7f-47b3-8669-06be960dc2d7) 概要

この記事では、Flosum DevOps 用のコマンドラインツールである Flosum CLI のインストール方法を説明します。Flosum CLI はターミナルから単独で使用でき、また次のものにも必要です。 **Flosum DevOps-CLI Extension** Visual Studio Code 用の。

Flosum CLI はインストール中にローカルマシン上でネイティブコンポーネントをコンパイルするため、Node.js に加えて、Python と C++ コンパイラを備えた正常に動作するビルドツールチェーンが必要です。インストールコマンドを実行する前に、以下の前提条件をすべて満たしてください。

## 前提条件

{% stepper %}
{% step %}

### Node.js と npm

Flosum CLI には **Node.js 22** と **npm 10**. より新しい Node.js リリースはサポートされていません。

1. 次へ移動 [nodejs.org](https://nodejs.org/en/download). ページは最新リリースが既定になっているため、バージョンドロップダウンを使用して **22.x**を選び、その後インストーラーをダウンロードして実行してください。Node.js 22 には **npm 10**.
2. 両方のバージョンをターミナルで確認してください:

```
node --version
npm --version
```

3. 確認してください `node --version` が **v22.x** であり、 `npm --version` が **10.x**.

{% hint style="warning" %}

#### Node.js 24 は警告なしに古いリリースをインストールします

Flosum CLI を **Node.js 24**でインストールすると、npm はエラーを報告せずに Flosum CLI の古いバージョンをインストールします。 `flosum --version` は古いバージョンを返します。古いリリースは現在の Flosum DevOps をサポートしておらず、動作しません。

にダウングレードしてください **Node.js 22** インストールする前に。すでに Node.js 24 で CLI をインストールしている場合は、トラブルシューティングの手順を使って削除し、Node.js 22 をインストールしてから、もう一度インストールコマンドを実行してください。
{% endhint %}

{% hint style="warning" %}

#### npm をアップグレードしないでください

各インストールの最後には、npm のより新しいメジャーバージョンが利用可能であるという通知と、それをインストールするコマンドが表示されます。そのコマンドは実行しないでください。Flosum CLI には **npm 10**npm 10 が必要であり、アップグレードするとマシンがサポート対象外の構成になります。

すでにアップグレードしている場合は、 **Node.js 22**を再インストールしてください **npm 10**.
{% endhint %}

{% hint style="info" %}
可能であれば、Node.js は共有システムの場所ではなく自分のユーザーアカウントに対してインストールしてください。これにより npm のグローバルフォルダパスが短く保たれ、トラブルシューティングで説明するパス長の問題を回避できます。
{% endhint %}
{% endstep %}

{% step %}

### ビルドツール

Flosum CLI は、インストール時に C ソースコードからコンパイルされるネイティブモジュールに依存しています。マシンには **Python 3** と **C++ コンパイラ** がインストール前に利用可能でなければ、インストールは失敗します。

**macOS**

1. コンパイラと Python を提供する Xcode コマンドラインツールをインストールします:

```
xcode-select --install
```

**Linux**

1. コンパイラツールチェーンと Python をインストールします。Debian と Ubuntu では:

```
sudo apt install build-essential python3
```

お使いのディストリビューションに対応する同等のパッケージグループを使用してください。
{% endstep %}
{% endstepper %}

## Flosum CLI のインストール

{% stepper %}
{% step %}

### インストールコマンドを実行する

1. ターミナルを開きます。
2. 次のコマンドを実行します:

```
npm i -g @flosum/cli
```

3. インストールが完了するまで待ちます。ネイティブコンポーネントはこのステップでコンパイルされるため、コマンドには数分かかることがあります。
   {% endstep %}

{% step %}

### インストールを確認する

1. 次のコマンドを実行します:

```
flosum --version
```

2. バージョン番号が返されることを確認してください。バージョン番号が返れば、インストールは成功です。
3. インストール済みのバージョンを、公開されている最新リリースと比較します:

```
npm view @flosum/cli version
```

4. 両方のコマンドが同じバージョンを報告することを確認してください。 `flosum --version` がより小さい番号を返す場合、古いリリースがインストールされています。トラブルシューティングを参照してください。

{% hint style="info" %}
その **Flosum DevOps-CLI Extension** Visual Studio Code 用のは別途インストールされ、独自のバージョン番号を持つため、ここで報告されるバージョンとは一致しません。2つを比較しないでください。

* [Flosum DevOps-CLI 拡張機能のインストール](/devops/devops-ja/kdo/devops-cli/flosum-devops-cli-noinsutru.md)
  {% endhint %}
  {% endstep %}
  {% endstepper %}

## Flosum CLI の使用

利用可能なコマンドと、それぞれが何をするかの説明については、以下の Flosum CLI パッケージのコマンドを確認してください。DevOps-CLI Extension はこれらのコマンドを呼び出すため、より詳細な手順については次の記事も参照できます。

* [VS Code での DevOps CLI の使用](/devops/devops-ja/kdo/devops-cli/vs-code-deno-devops-cli-no.md)

<details>

<summary>Flosum CLI コマンドリファレンス</summary>

このリファレンスは **@flosum/cli** バージョンを対象にしています **0.0.5**. 次を実行してください `flosum --help` または `flosum devops --help` 自分のマシンにインストールされているバージョンのリファレンスを表示します。

各コマンドは以下のオプションを受け付けます。以下では繰り返しません。

<table><thead><tr><th width="250">オプション</th><th>説明</th></tr></thead><tbody><tr><td><code>--json</code></td><td>結果を JSON 形式で返します。既定は false です。</td></tr><tr><td><code>-h, --help</code></td><td>コマンドのヘルプを表示します。</td></tr></tbody></table>

最上位コマンドは次も受け付けます `-V, --version`、インストールされているバージョン番号を返します。

**アカウントコマンド**

<table><thead><tr><th width="250">コマンド</th><th>説明</th></tr></thead><tbody><tr><td><code>flosum login</code></td><td>Global Settings にログインし、関連サービスのデータを取得します。</td></tr><tr><td><code>flosum logout</code></td><td>保存された認証情報を削除します。</td></tr><tr><td><code>flosum list-credentials</code></td><td>認証済みのすべての認証情報を表示します。</td></tr><tr><td><code>flosum list-topologies</code></td><td>利用可能なトポロジーを一覧表示します。</td></tr></tbody></table>

**DevOps コマンド**

<table><thead><tr><th width="250">コマンド</th><th>説明</th></tr></thead><tbody><tr><td><code>flosum devops init</code></td><td>Salesforce プロジェクトと CLI システムファイルを作成します。</td></tr><tr><td><code>flosum devops clone</code></td><td>Salesforce プロジェクトを作成し、 <strong>main</strong> ブランチを登録済みの DevOps テナントから取得します。</td></tr><tr><td><code>flosum devops checkout</code></td><td>別のブランチをチェックアウトし、ローカルに不足しているコンポーネントを取得します。</td></tr><tr><td><code>flosum devops pull</code></td><td>DevOps から最新のブランチコミットを取得します。</td></tr><tr><td><code>flosum devops commit</code></td><td>ローカルの変更を DevOps 上のリモートブランチにコミットします。</td></tr><tr><td><code>flosum devops rollback</code></td><td>ブランチを最後にコミットされた状態に戻します。</td></tr><tr><td><code>flosum devops status</code></td><td>コミットされていないすべてのローカル変更を返します。</td></tr><tr><td><code>flosum devops list-branches</code></td><td>すべてのリモートブランチを一覧表示します。</td></tr><tr><td><code>flosum devops config-set</code></td><td>プロジェクトの設定値を設定します。</td></tr><tr><td><code>flosum devops config-unset</code></td><td>プロジェクトの設定プロパティをクリアします。</td></tr></tbody></table>

**flosum login**

<table><thead><tr><th width="250">オプション</th><th>説明</th></tr></thead><tbody><tr><td><code>-a, --alias &#x3C;string></code></td><td>保存された認証情報へのアクセスに使用する別名。既定は <code>default</code>.</td></tr><tr><td><code>-t, --token &#x3C;string></code></td><td>Flosum サービスへのアクセスに使用するトークン。指定しない場合、コマンドの実行中に要求されます。</td></tr><tr><td><code>--global-settings-api-url &#x3C;string></code></td><td>到達可能な Global Settings API のベース URL。プライベートな Global Settings API が Docker ネットワーク外に公開されている場合に使用します。</td></tr></tbody></table>

**flosum logout**

<table><thead><tr><th width="250">オプション</th><th>説明</th></tr></thead><tbody><tr><td><code>-a, --alias &#x3C;string></code></td><td>削除する保存済み認証情報の別名。既定は <code>default</code>.</td></tr></tbody></table>

**flosum list-topologies**

<table><thead><tr><th width="250">オプション</th><th>説明</th></tr></thead><tbody><tr><td><code>-a, --alias &#x3C;string></code></td><td>トポロジーを一覧表示する際に使用する認証情報の別名。既定は <code>default</code>.</td></tr></tbody></table>

**flosum devops init**

<table><thead><tr><th width="250">オプション</th><th>説明</th></tr></thead><tbody><tr><td><code>-n, --name &#x3C;string></code></td><td>プロジェクトが保存されているフォルダーの名前。指定しない場合、コマンドの実行中に要求されます。</td></tr><tr><td><code>-a, --alias &#x3C;string></code></td><td>DevOps からコンポーネントを取得するために使用する認証情報の別名。既定は <code>default</code>.</td></tr><tr><td><code>-t, --topology &#x3C;string></code></td><td>プロジェクトに使用するトポロジー名。</td></tr><tr><td><code>--topology-id &#x3C;number></code></td><td>プロジェクトに使用するトポロジー ID。</td></tr></tbody></table>

**flosum devops clone**

<table><thead><tr><th width="250">オプション</th><th>説明</th></tr></thead><tbody><tr><td><code>-n, --name &#x3C;string></code></td><td>プロジェクトが保存されているフォルダーの名前。指定しない場合、コマンドの実行中に要求されます。</td></tr><tr><td><code>-a, --alias &#x3C;string></code></td><td>DevOps からコンポーネントを取得するために使用する認証情報の別名。既定は <code>default</code>.</td></tr><tr><td><code>-t, --topology &#x3C;string></code></td><td>クローン作成に使用するトポロジー名。</td></tr><tr><td><code>--topology-id &#x3C;number></code></td><td>クローン作成に使用するトポロジー ID。</td></tr></tbody></table>

**flosum devops checkout**

<table><thead><tr><th width="250">オプション</th><th>説明</th></tr></thead><tbody><tr><td><code>-b, --branch &#x3C;string></code></td><td>チェックアウトするブランチ名。指定しない場合、コマンドの実行中に要求されます。</td></tr></tbody></table>

**flosum devops commit**

<table><thead><tr><th width="250">オプション</th><th>説明</th></tr></thead><tbody><tr><td><code>-m, --message &#x3C;string></code></td><td>コミットメッセージ。指定しない場合、コマンドの実行中に要求されます。</td></tr></tbody></table>

**flosum devops config-set**

2 つの引数を取り、どちらも必須です。

<table><thead><tr><th width="250">引数</th><th>説明</th></tr></thead><tbody><tr><td><code>config-name</code></td><td>設定プロパティの名前。許可される値は <code>credentialsAlias</code> と <code>topologyId</code>.</td></tr><tr><td><code>value</code></td><td>設定する値。</td></tr></tbody></table>

**flosum devops config-unset**

1 つの引数を取り、必須です。

<table><thead><tr><th width="250">引数</th><th>説明</th></tr></thead><tbody><tr><td><code>config-name</code></td><td>クリアする設定プロパティの名前。許可される値は <code>credentialsAlias</code> と <code>topologyId</code>.</td></tr></tbody></table>

**追加オプションのないコマンド**

`flosum list-credentials`, `flosum devops pull`, `flosum devops rollback`, `flosum devops status`、および `flosum devops list-branches` は、このリファレンスの先頭に記載されている 2 つのオプションのみを受け付けます。

</details>

## トラブルシューティング

<details>

<summary>gyp ERR、node-gyp、または Python エラーでインストールが失敗する</summary>

ビルドツールチェーンが不足しているか不完全なため、ネイティブコンポーネントをコンパイルできませんでした。

1. 確認してください **Python 3** が **PATH** で利用可能であることを、 `python3 --version`.
2. C++ コンパイラがインストールされていることを確認してください。macOS では Xcode コマンドラインツール、Linux ではディストリビューションのコンパイラパッケージグループです。
3. 更新された **PATH**.
4. を拾うように、ターミナルを閉じて再度開いてください。
5. インストールコマンドを再度実行してください。

{% hint style="warning" %}

#### 再試行する前に部分的なインストールを削除する

失敗したインストールでは、CLI の不完全なコピーと `flosum` コマンドのショートカットが残ります。再試行する前に両方を削除してください。そうしないと、次の試行が元のエラーとは無関係な理由で失敗する可能性があります。

まず、パッケージ本体を削除する標準のアンインストールを実行します:

```
npm uninstall -g @flosum/cli
```

これは `flosum` ショートカットは削除しないため、それらも削除します。

```
sudo rm -f "$(npm prefix -g)/bin/flosum"
sudo rm -rf "$(npm root -g)/@flosum"
```

両方の手順が必要です。 `flosum` ショートカットはインストールが失敗した場合でも作成され、残しておくと `flosum` まだ実行されるものの、もはや存在しないファイルを指す

何も残っていないことを確認してください:

```
flosum --version
```

コマンドは `コマンドが見つかりません`と報告するはずです。欠落したモジュールが報告される場合は、ショートカットが残っています。
{% endhint %}

{% hint style="info" %}

#### 2 つ目の、別のエラーが表示されることがあります

ビルドでは C++ コンパイラより先に Python を確認するため、見つからないもののうち最初のものだけが報告されます。Python だけが不足していた場合は、それをインストールして再試行すると、代わりに C++ コンパイラを示す新しいエラーが出ることがあります。これは新しい問題ではなく、想定どおりの進展です。C++ ビルドツールをインストールし、部分的なインストールをもう一度削除してから再試行してください。
{% endhint %}

次を参照してください **ビルドツール** OS ごとの完全な手順については、上の

エラーメッセージには [node-gyp のインストール手順](https://github.com/nodejs/node-gyp#installation)へのリンクも含まれています。これはビルドツール自体が公開しているものです。一般的な開発者向けに同じ要件を扱っており、珍しいセットアップをトラブルシューティングする際の便利な第2の参照になります。

</details>

<details>

<summary>flosum --version が公開バージョンより古いリリースを報告する</summary>

`flosum --version` が `npm view @flosum/cli version`より小さい番号を返します

. インストールは成功したと報告されましたが、npm は古いリリースを選択しました。 **22**これは、マシン上の Node.js バージョンが

1. 実行してください `node --version`.
2. 報告されない場合は **v22.x**、 **Node.js 22** をインストールしてください **Node.js と npm** 前述の
3. 前提条件。
4. 既存のインストールを最初の項目の手順で削除してください。

</details>

<details>

<summary>flosum コマンドがバージョンの代わりに "Cannot find module" を報告する</summary>

以前のインストールが途中で失敗しました。 `flosum` ショートカットは作成されましたが、参照先のファイルは完了していなかったため、コマンドは実行されてから欠落した `cli.js` ファイルを報告します。

1. 最初の項目の手順で部分的なインストールを削除してください。
2. 完了してください **ビルドツール** 前提条件を。
3. インストールコマンドを再度実行してください。

</details>

<details>

<summary>インストールが EBADENGINE または "Unsupported engine" で失敗する</summary>

このメッセージは、マシン上の Node.js または npm のバージョンが Flosum CLI に必要なバージョンと一致していないことを意味します。

1. 実行してください `node --version` と `npm --version`.
2. 一致しない場合は **v22.x** と **10.x**、 **Node.js 22** をインストールしてください **Node.js と npm** 前提条件を満たしていないので、インストールコマンドをもう一度実行してください。

サポートされているバージョンでは、このメッセージは表示されるべきではありません。

Node.js 22 を実行しているときにこれが表示される場合は `engine-strict=true` が `.npmrc` ファイルに設定されているか確認してください。その設定は、バージョン互換性の警告をエラーに変えます。それを削除するか、このインストールに限って次のように上書きしてください:

```
npm i -g @flosum/cli --engine-strict=false
```

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flosum.com/devops/devops-ja/kdo/devops-cli/flosum-cli-nodejs-pakkjinoinsutru.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.