realm-cli v2 [已弃用]
重要
Realm 命令行界面（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 命令行界面（Realm CLI） v1 。要检查 CLI 版本，请使用： realm-cli --version 。 要将全局安装升级到最新版本，请使用： npm upgrade -g mongodb-realm-cli 。
安装
realm-cli 可在npm上使用。 要在系统上安装 2的 版本，请确保您有realm-cli Node.js 已安装，然后在 shell 中运行以下命令：
npm install -g mongodb-realm-cli
身份验证
要使用realm-cli ，您必须进行身份验证。 要进行身份验证，您必须生成 API 密钥。
生成 API 密钥
导航到 MongoDB Cloud Access Manager
MongoDB Cloud Access Manager允许您管理用户、团队和 API 密钥对项目的访问权限。 要使用项目访问管理器，请单击屏幕左上角access manager dropdown上的 Project Access标签页。
使用 API 密钥进行身份验证
选项
使用“域-cli [command] --help”获取有关特定命令的信息
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--profile | 字符串 | no | 指定您的配置文件（默认值："default"）（默认为 "default"） |
--telemetry | 字符串 | no | 启用/禁用当前配置文件的 CLI 使用情况跟踪（默认值：“on”；允许值：“on”、“off”） |
-o, --output-target | 字符串 | no | 将 CLI 输出写入指定文件路径 |
-f, --output-format | 字符串 | no | 设置 CLI 输出格式（默认值：<blank>；允许值：<blank>、“json”） |
--disable-colors | no | 禁用所有 CLI 输出样式（例如颜色、字体样式等） | |
-y, --yes | no | 通过同意任何所需的用户提示，自动继续执行 CLI 命令 | |
-h，--help | false | realm-cli 帮助 |
命令
域-cli accessList — 托管允许的 IP 地址和 CIDR 区块
域-cli apps - 托管与当前用户关联的 App Services 应用（别名：app）
域-cli function — 与应用的函数交互（别名：函数）
域-cli login — 使用 MongoDB Cloud API 密钥将 CLI 登录到 App Services
域-cli logout — 将 CLI 从 App Services 中注销
域-cli logs — 与应用的日志交互（别名：log）
域-cli pull — 将最新版本的应用导出到本地目录（别名：export）
realm-cli push — 将更改从本地目录导入并部署到您的应用程序（别名：导入）
域-cli schema — 托管应用程序的模式（别名：模式）
域-cli secrets — 托管应用程序的密钥（别名：密钥）
域-cli users — 托管应用程序的用户（别名：user）
realm-cli whoami — 显示有关当前用户的信息