---
schema_version: "1"
id: 340e88026d69237aafb9a1eb317b6bd2a17ef72caf27154dfb99b4632d20ece8
title: コマンドおよびフラグの一般的な使用
collection: mulesoft
version: current
locale: ja-jp
portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/exchange/apicat-use-api-catalog-cli.md
canonical_url: https://docs.mulesoft.com/jp/exchange/apicat-use-api-catalog-cli
source_site: docs.mulesoft.com
content_type: documentation
content_hash: af04cd2565d2c7aea122b40f997e7a3f3bcb1a6d9edd96cecb2c3ddd3d24f6c8
description: MuleSoft Documentation Site
latest: true
---
# コマンドおよびフラグの一般的な使用

API カタログ CLI をインストールして権限を設定したら、API カタログ CLI コマンドを使用して API を自動カタログ化できます。コマンドを実行するときに Anypoint Platform に対して​[認証](#authentication)​するためのいくつかのオプションを使用できます。

## [](#api-catalog-commands)API カタログコマンドのリスト

API カタログ CLI には次のコマンドが含まれます。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 35%;">
<col style="width: 65%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">コマンド</th>
<th class="tableblock halign-left valign-top">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="https://docs.mulesoft.com/jp/exchange/apicat-configure-cli-autocomplete#autocomplete-command" class="xref page">api-catalog autocomplete</a>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API カタログコマンドのオートコンプリートを設定します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#conf-command">api-catalog conf</a>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>ログイン情報設定ファイルを作成または削除します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="https://docs.mulesoft.com/jp/exchange/apicat-create-descriptor-file-cli#create-descriptor-command" class="xref page">api-catalog create-descriptor</a>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>記述子ファイルを作成します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="https://docs.mulesoft.com/jp/exchange/apicat-create-descriptor-file-cli#update-descriptor-command" class="xref page">api-catalog update-descriptor</a>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>記述子ファイルを更新します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="https://docs.mulesoft.com/jp/exchange/apicat-publish-using-api-catalog-cli#publish-asset-command" class="xref page">api-catalog publish-asset</a>​</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Exchange にアセットをパブリッシュします。</p>
</div></div></td>
</tr>
</tbody>
</table>

## [](#コマンドヘルプを表示する)コマンドヘルプを表示する

help オプションを使用して、コマンドまたはコマンドフラグとそれらの説明をリストします。次の例は、help オプションの使用方法を示しています。

api-catalog help
api-catalog create-descriptor --help

## [](#common-options)一般フラグと認証フラグ

Anypoint Platform に対して認証するコマンドの一般フラグと認証フラグを次に示します。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 80%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">フラグ</th>
<th class="tableblock halign-left valign-top">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>--client_id=client_id</p>
</div>
<div class="paragraph">
<p>または</p>
</div>
<div class="paragraph">
<p>ANYPOINT_CLIENT_ID​ 環境変数</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>接続アプリケーションクライアント ID。</p>
</div>
<div class="paragraph">
<p><a href="#authentication">「認証」</a>​を参照してください。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>--client_secret</p>
</div>
<div class="paragraph">
<p>または</p>
</div>
<div class="paragraph">
<p>ANYPOINT_CLIENT_SECRET​ 環境変数</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>クライアント ID の接続アプリケーションシークレットのプロンプト。</p>
</div>
<div class="paragraph">
<p>​<a href="#authentication">「認証」</a>​を参照してください。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>--collectMetrics</p>
</div>
<div class="paragraph">
<p>または</p>
</div>
<div class="paragraph">
<p>COLLECT_METRICS​ 環境変数</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>現在使用されていません。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>--environment=environment</p>
</div>
<div class="paragraph">
<p>または</p>
</div>
<div class="paragraph">
<p>ANYPOINT_ENV​ 環境変数</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API がカタログ化されている Anypoint Platform 環境の名前。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>--host=host</p>
</div>
<div class="paragraph">
<p>または</p>
</div>
<div class="paragraph">
<p>ANYPOINT_HOST​ 環境変数</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>デフォルト:</p>
</div>
<div class="listingblock">
<div class="content">
<pre>anypoint.mulesoft.com</pre>
</div>
</div>
<div class="paragraph">
<p>プロトコルなしの Anypoint Platform ベース URL。</p>
</div>
<div class="paragraph">
<p>US Anypoint Platform の場合、次を使用します。</p>
</div>
<div class="listingblock">
<div class="content">
<pre>anypoint.mulesoft.com</pre>
</div>
</div>
<div class="paragraph">
<p>ヨーロッパの Anypoint Platform の場合、次を使用します。</p>
</div>
<div class="listingblock">
<div class="content">
<pre>eu1.anypoint.mulesoft.com</pre>
</div>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>--organization=organization</p>
</div>
<div class="paragraph">
<p>または</p>
</div>
<div class="paragraph">
<p>ANYPOINT_ORG​ 環境変数</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API がカタログ化されている Anypoint Platform 組織の ID。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>-o, --output=output</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>現在使用されていません。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>-p, --password</p>
</div>
<div class="paragraph">
<p>または</p>
</div>
<div class="paragraph">
<p>ANYPOINT_PASSWORD​ 環境変数</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Anypoint ユーザーパスワード。</p>
</div>
<div class="paragraph">
<p>​<a href="#authentication">「認証」</a>​を参照してください。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>-u, --username=username</p>
</div>
<div class="paragraph">
<p>または</p>
</div>
<div class="paragraph">
<p>ANYPOINT_USERNAME​ 環境変数</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Anypoint ユーザー名。</p>
</div>
<div class="paragraph">
<p><a href="#authentication">「認証」</a>​を参照してください。</p>
</div></div></td>
</tr>
</tbody>
</table>

## [](#authentication)認証

API カタログ CLI の実行中に Anypoint Platform に対して認証するには、次の認証の組み合わせのいずれかを使用する必要があります。

- ユーザー名とパスワード
- クライアント ID とクライアントシークレット
- ベアラートークン (コマンドラインのみ)

デフォルト設定にログインする場合を除き、ホスト、環境、および組織も指定する必要があります。

次の方法を使用して、Anypoint Platform ログイン情報を渡すことができます。

- [シングルサインオン (SSO) の使用](#single-signon)​
- [ログイン情報設定ファイルの使用](#credentials-file)​
- [コマンドラインフラグの使用](#command-line-options)​
- [環境変数の使用](#env-variables)

設定は次のように上書きされます。

- コマンドラインフラグはその他すべての方法を上書きする。
- コマンドラインフラグが指定されていない場合は環境変数が使用され、ログイン情報設定ファイルの設定を上書きする。
- コマンドラインフラグまたは環境変数が設定されていない場合、ログイン情報設定ファイルのオプションが使用される。

### [](#single-signon)SSO

API カタログ CLI を実行しているシステムで SSO を使用するように Anypoint Platform を設定した場合、認証フラグなしで API カタログ CLI コマンドを実行すると、コマンドは SSO を介して Anypoint Platform にログインします。SSO を介したログインの設定についての詳細は、​[「ID 管理について」](https://docs.mulesoft.com/jp/access-management/external-identity)​を参照してください。

### [](#credentials-file)ログイン情報設定ファイル

SSO を使用していない場合、ログイン情報を Anypoint Platform CLI インストールに渡す最も安全な方法は、ログイン情報設定ファイルを使用することです。

`api-catalog conf`​ コマンドを実行してログイン情報を設定ファイルに追加することで、Anypoint Platform に対して認証できます。有効なログイン情報を使用して設定ファイルを作成したら、ログイン情報フラグを指定することなく ​`api-catalog`​ コマンドを実行でき、設定ファイルの値を使用して認証が行われます。

次の認証キーの組み合わせを使用して、設定ファイルに認証値を設定できます。

username
password
client\_id
client\_secret
host
environment
organization

設定ファイルを作成するには、次の操作を実行します。

- 使用するキーと値のペアを指定して ​`api-catalog conf`​ コマンドを実行する。たとえば、次のコマンドはユーザー名とパスワードを設定します。
    
    $ api-catalog conf username myuser
    $ api-catalog conf password mypwd

このコマンドは、次の場所にある ​`config.json`​ ファイルにログイン情報を保存します。

- MacOS: `~/Library/Preferences/@mulesoft/api-catalog-cli-nodejs/config.json`
- Windows: `%LOCALAPPDATA%\mycli`
- Unix: `~/.config/mycli`

**例:**​

- ベアラートークンの値を設定する
    
    $ api-catalog conf bearer b71cab22-e5cc-43c4-90ed-5a1124b6ae1f
- ユーザー名とパスワードの値を設定する
    
    $ api-catalog conf username myuser
    $ api-catalog conf password mypwd
- 特定のホスト、組織、および環境の値を設定する
    
    $ api-catalog conf host myco.anypoint.mulesoft.com
    $ api-catalog conf environment ec7d16cb-43fd-4796-8b4f-5cff7294fcf9
    $ api-catalog conf organization 8a840abc-e63a-4f8d-87ad-24052eda3018
- クライアント ID とクライアントシークレットの値を設定する
    
    $ api-catalog conf client\_id myClientID
    $ api-catalog conf client\_secret myCLientSecret

上記のコマンドを実行した後の ​`config.json`​ コンテンツの例:

 {
     "bearer": "b71cab22-e5cc-43c4-90ed-5a1124b6ae1f",
     "username": "myuser",
     "password": "mypwd",
     "host": "myco.anypoint.mulesoft.com",
     "environment": "ec7d16cb-43fd-4796-8b4f-5cff7294fcf9",
     "organization": "8a840abc-e63a-4f8d-87ad-24052eda3018",
     "client\_id": "1787c36ab544466698e380131040faad",
     "client\_secret": "2dA616efca1E4181A2A77BBF046868BE"
 }

#### [](#conf-command)api-catalog conf

キーと値のペアを追加および削除して、設定ファイル (config.json) で認証ログイン情報を管理します。コマンドの実行ごとに 1 つのキーと値のペアを設定します。

\> api-catalog conf <authkey> <authkeyvalue> \[flags\]

`<authkey>`  
認証キー名。使用可能なキー名: username password client\_id client\_secret host environment organization

`<authkeyvalue>`  
指定された認証キーの値。

このコマンドは、次のフラグを受け入れます。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 80%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">フラグ</th>
<th class="tableblock halign-left valign-top">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>-d, --delete</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>指定されたキーの設定ファイルエントリを削除します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>-h, --help</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>コマンドのヘルプを表示します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>-k, --key=key</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>指定されたキーに対応する値を表示します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>-v, --value=value</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>指定された値に対応するキーを表示します。</p>
</div></div></td>
</tr>
</tbody>
</table>

### [](#command-line-options)コマンドラインフラグ

次のフラグの組み合わせを使用して ​`api-catalog`​ コマンドを実行することで、コマンドラインから Anypoint Platform に対して認証できます。

\--username
--password
--client\_id
--client\_secret
--bearer
--organization
--environment

**例:**​

- ユーザー名とパスワードを使用してコマンドラインで認証する
    
    $ api-catalog --username myUserName --password myPassword --organization=myOrgId publish-asset
- クライアント ID とクライアントシークレットを使用してコマンドラインで認証する
    
    $ api-catalog --client\_id myClientID myClientSecret --organization=myOrgId publish-asset
- ベアラートークンを使用してコマンドラインで認証する
    
    Anypoint Platform でベアラートークンを生成し、API カタログ CLI に直接渡すことができます。ベアラートークンを提供した場合、API カタログ CLI は他に提供されているすべてのユーザーログイン情報やクライアントログイン情報を無視します。
    
    $ api-catalog --bearer myBearerToken --organization=myOrgId publish-asset
    
    ベアラートークンの有効期限が切れると、Anypoint Platform セッションの有効期限が切れます。
    
    ベアラートークンの生成については、 [「How to Generate Your Authorization Bearer Token for Anypoint Platform (Anypoint Platform 用の認証ベアラートークンの生成方法)」](https://help.mulesoft.com/s/article/How-to-generate-your-Authorization-Bearer-token-for-Anypoint-Platform)​を参照してください。

### [](#env-variables)環境変数

`api-catalog`​ コマンドを実行する前に、次の環境変数の組み合わせを設定することで、Anypoint Platform に対して認証できます。

ANYPOINT\_USERNAME
ANYPOINT\_PASSWORD
ANYPOINT\_CLIENT\_ID
ANYPOINT\_CLIENT\_SECRET
ANYPOINT\_ORG
ANYPOINT\_ENV
ANYPOINT\_HOST

**例:**​

- ユーザー名とパスワードの環境変数を設定して認証する
    
    $ export ANYPOINT\_USERNAME=myUserName
    $ export ANYPOINT\_PASSWORD=myPassword
    $ export ANYPOINT\_ORG=myOrgId
- クライアント ID とクライアントシークレットの環境変数を設定して認証する
    
    $ export ANYPOINT\_CLIENT\_ID=myClientID
    $ export ANYPOINT\_CLIENT\_SECRET=myCLientSecret
    $ export ANYPOINT\_ORG=myOrgId