realm-cli v2 [非推奨]
重要
Realm CLI は非推奨
realm-cli は非推奨であり、将来の機能やバグ修正は行われません。 代わりに、 App Services CLI を使用してください。
App Services CLI はnpmで利用できます。 システムに CLI をインストールするには、 Node.js があることを確認してくださいがインストールされたら、shell で次のコマンドを実行します。
npm install -g atlas-app-services-cli
Overview
MongoDB Realm コマンドラインインターフェイス（ realm-cli ）を使用すると、アプリをプログラムで管理できます。 realm-cliを使用すると、ローカル ディレクトリからアプリを作成またはアップデートしたり、既存のアプリケーションをローカル ディレクトリにエクスポートしたりできます。
重要
CLI のバージョンを確認する
このページは、 realm-cliのバージョン 2 のクイックスタートです。 realm-cliのバージョン 1 のドキュメントが必要な場合は、 Realm CLI v1を参照してください。 CLI バージョンを確認するには、 realm-cli --versionを使用します。 グローバル インストールを最新バージョンにアップグレードするには、次のコマンドを使用します: npm upgrade -g mongodb-realm-cli 。
インストール
realm-cli はnpmで利用可能です。 2realm-cliシステムに のバージョン をインストールするには、次の Node.js があることを確認してください がインストールされたら、shell で次のコマンドを実行します。
npm install -g mongodb-realm-cli
認証
realm-cliを使用するには、認証が必要です。 認証するには、API キーを生成する必要があります。
API キーの生成
MongoDB Cloud Access Manager への移動
MongoDB Cloud Access Managerを使用すると、ユーザー、チーム、API キーのプロジェクトへのアクセスを管理できます。 プロジェクト アクセス マネージャーを使用するには、画面左上にあるProject Access access manager dropdown [] タブをクリックします。
![[アクセス マネージャー] をクリックします](/ja-jp/docs/atlas/app-services/static/3c01475d2079c0984428585a5403f1c3/88496/click-access-manager.webp)
API キーの作成
プロジェクト ユーザーは、プロジェクト API キーを持つrealm-cliツールを使用してログインできます。 プロジェクト アクセス マネージャーの右側にある灰色の [ Create
API Keyボタンをクリックして、プロジェクト API キーを作成します。
![[アクセス マネージャー] をクリックします](/ja-jp/docs/atlas/app-services/static/999e3395c308ef5163bc36640aaa9674/16dce/access-manager-create-api-key-button.webp)
このボタンをクリックすると、「Create API Key」画面に移動します。 キーの説明を設定します。
書き込みアクセスするには、CLI に「プロジェクト オーナー」権限を持つ API キーが必要です。 読み取り専用アクセスの場合は、「プロジェクト読み取り専用」を使用できます。 [ Project Permissions ] ドロップダウンを使用して、ユースケースに適した権限を選択します。
後でログインするために使用する公開鍵をコピーします。 キーの詳細の設定を続行するには、 nextをクリックします。
![[アクセス マネージャー] をクリックします](/ja-jp/docs/atlas/app-services/static/7c0dcf03bc37dede97b73ff764923ecb/dc2c2/configure-api-key.webp)
APIアクセス リストを設定する
後で使用するために秘密キーを安全な場所にコピーします。 セキュリティのため、初期化後に秘密キーが再度表示されることはありません。 別のセキュリティ機能は、 API アクセス リスト です。 API アクセス リスト エントリを作成すると、API 呼び出しは許可された IP から確実に起動されます。
API キーを使用するには、 API キーを使用するユーザーの IP アドレスが必要です。 [ Add Access List Entry ] ボタンをクリックします。 IP アドレスを入力するか、 Use Current IP Addressボタンをクリックして保存をクリックします。 最後に、画面の右下にある [ Done ] ボタンをクリックして、API キーの設定を終了します。
![[アクセス マネージャー] をクリックします](/ja-jp/docs/atlas/app-services/static/c39366cf2efe7f14368ecd030746d030/b4e16/add-access-list-entry.webp)
API キーによる認証
オプション
特定のコマンドに関する情報については、「realm-cli [command] --help」を使用してください
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--profile | string | no | プロファイルを指定します（デフォルト値: "default"）（デフォルトは "default"） |
--telemetry | string | no | 現在のプロファイルの CLI 使用量の追跡を有効または無効にします（デフォルト値: "on"、許可値: "on"、"op"） |
-o, --output-target | string | no | 指定されたファイルパスへの CLI 出力の書込み (write) |
-f, --output-format | string | no | CLIの出力形式を設定する（デフォルト値:<blank> 、許可値:<blank> 、"JSON "） |
--disable-colors | no | すべての CLI 出力スタイル（例: 色、フォント スタイルなど） | |
-y, --yes | no | 必要なユーザー プロンプトに同意して、CLI コマンドを自動的に続行します | |
-h, --help | false | Realm-CLI 用のヘルプ |
コマンド
Realm- clientList - 許可された IP アドレスと CIDR ブロックの管理
Realm-CLI アプリ- 現在のユーザーに関連付けられている App Services アプリを管理します（エイリアス: アプリ）
Realm-cli 関数- アプリの関数を操作します（エイリアス: 関数）
Realm-CLI ログイン- MongoDB Cloud API キーを使用して CLI を App Services にログイン
Realm-CLI ログアウト- CLI を Atlas App Services からログアウトする
Realm-CLI ログ- アプリのログを操作します（エイリアス: log）
Realm-CLI プル- アプリの最新バージョンをローカル ディレクトリにエクスポートします（エイリアス: エクスポート）
Realm-CLI プッシュ- ローカル ディレクトリからアプリに変更をインポートして配置します（エイリアス: インポート）
Realm-CLI スキーマ- アプリのスキーマを管理します（エイリアス: スキーマ）
Realm-CLI secrets - アプリのシークレットを管理します（エイリアス: secret）
Realm-CLI ユーザー- アプリのユーザー数を管理します（エイリアス: user）
Realm-CLI一致- 現在のユーザーに関する情報の表示